Contents

Popular

The landing page of a project shows the four tabs on the left navigation panel and displays the first option from the 4 sections under API Project tab, that is, the Summary section.


Figure 1: API Project Summary section

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

PropertyDescription
Proxy Base Path

The Project Context Path provided while creating the project.

Icon
  • Different versions can have the same Proxy Base Path name.
  • Proxy Base Path name can be changed to a different one by editing from this text field.
    • After changing the name, make sure that you click the Save API Project  button to apply the changes to the project.
VersionVersion number of the project provided while creating the project. This drop down shows different versions of the project available. On selecting any version, that particular project will be opened.
Date CreatedDate and time of the creation of the project.
Last ModifiedDate and time of last modification of the project.
Status

Present status of the project.

Status can be changed by choosing from the options in the drop-down list as 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 to work in existing API Products but cannot be added to new Products.
  • Retired -  A Retired API Project indicates that the project is obsolete and cannot be used. Projects cannot be launched if they are marked Retired.


Figure 2: Status options in the List box

Icon

After changing the Status, make sure that you click the Save API Project  button to apply the changes to the project

Tags

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

Icon

After Editing the Tag name, make sure that you click the Save API Project  button to apply the changes to the project

Icon

While editing values of properties Proxy Base Path or Status (before saving it), if you want to revert to the older values itself, use Reset button to revert to default values.

Adaptavist ThemeBuilder EngineAtlassian Confluence