Manage API documentation in Compass

The API feature helps your team view endpoint details including recent changes, organized by date. When you connect a repository, we detect and add any associated API documentation to the relevant components in Compass.

You can import API specifications from the following source code management (SCM) apps:

• Bitbucket
• GitHub

Before you begin

Before you can view API documentation in Compass:

• Install your SCM app in Compass. Select Apps from the top navigation and select Install on the app’s tile.
• Select Configure on the app tile and connect Compass to the account containing your component’s repositories.

View an endpoint's request and responses

1. Go to your component’s Overview page.
2. Select API specification from the sidebar.
3. In the endpoints table, find the endpoint you want to view.
4. Select the hyperlinked path to view endpoint details, such as the request, responses, and code snippets.
5. In addition, you can select hyperlinked paths in the Changelog tab.

View a component's API details

1. Go to your component’s Overview page.
2. Select API specification from the sidebar.
3. The Endpoints tab displays endpoint details, including method, path, summary, and the date the specification was last edited.
4. Select the Changelog tab to view endpoint changes based on date and over a six-month period of time.

Change a source repository

1. Go to your component’s Overview page.
2. Select API specification from the sidebar.
3. Select Change source, then add a different repository, the path, and a default tag. Note: The tag is usually your default git branch.
4. Select Save.