Skip to main content
Skip table of contents

Overview

The Overview section, which contains the basic information of a project, is the landing page in the API Projects screen. Expand the Overview section under the Project Details heading to display details of the project.

Basic

General information about the project for clients in the Developer portal. Most of the documentation is automatically generated based on policy definitions and any conversions across the proxy pipeline. Information may be edited here.

This section displays the project summary represented by the properties described below.

PropertyDescription
Proxy Context Path

The Project Context Path provided while creating the project.

  • Different versions can have the same Proxy Base Path name.
  • Proxy Base Path name can be changed to a different one by editing the text field.
Status

Present status of the project.

Status can be changed by choosing the options in the drop-down list below:

  • Active - A normal API Project that can be launched and used in API products for clients.
  • Deprecated - API Projects can be deprecated to restrict them from being added to new API Products for clients when a better alternative is available. A Deprecated API project continues working in existing API Products but cannot be added to new Ones.
  • Retired -  A Retired API Project indicates that the project is obsolete and cannot be used. Projects cannot be launched if they are marked Retired.

Custom Status elements can be added to the API Projects tab in the Admin preferences option present in the upper-right part of the dashboard.

Tags

Provide a keyword for the project. This tag can be used to find this particular project while filtering projects.

Short DescriptionProvide a short description of the resource.
Long Description

Provide a detailed description of the project.

ConsumesProvide the incoming request type. This generally corresponds to the Content-Type header of the incoming request from the client.
ProducesProvide the output response type after calling the target API. This generally corresponds to the Accept header of the incoming request from the client.

While editing values of properties, Reset icon may be used to revert to default values before saving it.


After editing, ensure clicking the Save icon to apply changes made to the project.

Advanced

Masked parameters, project properties, security schemas, and open API tags can be added.

Resources

Users can add further information about the business applications of the resources and their applicability.

Expand the resource to see the details of the resource such as Server Group, Type, and URL. added to the project. 

Default Resource will be present in a project even if no resource is added manually.

Documents

Any documentation related to the project can be attached. Click the Add Document button to add a document and click Upload to save it to the project.

Use the Download icon to download the document and the Delete icon to remove it from the project.


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.