Last updated Jul 17, 2024

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.

When you connect a Bitbucket or a GitHub repository, Compass automatically scans the SCM app for API documentation. If the scan finds API specificiations in your repository, you can view endpoints on relevant component pages.

If Compass finds any code errors in the API specificications, an alert appears in the Endpoints section for your team to review. These errors need to be fixed before we can sync your updated API documentation with your components in Compass.

View an endpoint's request and responses

  1. Go to your component’s Overview page.
  2. Select API 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.

You must have full user permissions to access the API changelog. Understand user roles in Compass

View a component's API details

  1. Go to your component’s Overview page.
  2. Select API from the sidebar.
  3. The Endpoints tab displays endpoints 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 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.

Rate this page: