How do I edit the advanced attributes of an API?
Advanced attributes of APIs include the API logo or icon, supporting documents, categories, and summary and description of the API resources.
Developer Portal supports providing of Markdown text and text in the supported languages for the following API attributes:
API summary and description
API categories such as tags, business terms, API grouping, and maturity status
API documents
Resource summary and description
Method summary and description
Note:
For security reasons, it is recommended that you add authentic and valid Markdown content.
Sample Markdown text:
This use case starts when you want to edit the advanced attributes of an API and ends when you saved your changes.
In this example, consider adding API tags under API categories of the API, Petstore.
To edit the advanced details of an API1. Click the menu options icon
from the title bar and click
Manage APIs.
The list of APIs appears.
2. Click the enrich icon
next to the API that you want to edit.
3. Select API categories from the left pane and provide the new tag, Swagger and press Enter.
4. Click Save.
The tag is added to the API. Users can filter APIs based on tags in the API gallery page.
Alternative flow
You can provide or modify the following details of the API:
API info
API summary and description
Resource summary and description
Method summary and description
Sample Markdown text:
In this example, information is given under two different levels of headings.
Then, the output looks like this.
