Forums

Articles
Create
cancel
Showing results for 
Search instead for 
Did you mean: 

Does the API Specifications page support components with multiple APIs ?

Keith Furnell
Contributor
April 9, 2025

The API Specifications (plural) page associates OpenAPI specification file(s) within a repository either:

  1. automatically, where the files are located in expected locations, or
  2. manually, where an explicit repository path is provided

We know that #2 only allows display of a single API specification per component, but does #1 display more than one specification if multiple files are found?

The documentation is ambiguous in this regard, and the location of our specification files is such that they aren't automatically detected.

Related: https://community.atlassian.com/forums/Compass-questions/API-Specifications-observations/qaq-p/2973546https://community.atlassian.com/forums/Compass-questions/Documentation-for-API-Endpoints/qaq-p/2797228

1 answer

1 accepted

1 vote
Answer accepted
Satya Dusanapudi
Contributor
August 13, 2025

Hello @Keith Furnell ,

No, Even when compass automatically detects API specs from a repository, it only displays one specification per component. 

  • If you are rely on Manual Linking, you can only point to a single spec file, so you only get one spec shown per component. 
  • The documentation doesn't explicitly confirm whether automatic detection supports multiple spec files. 

So in both scenerios, compass currently supports only a single API spec per component. 

Thanks,

Satya

Keith Furnell
Contributor
August 13, 2025

Thanks for the confirmation @Satya Dusanapudi. The combination of use of "API Specifications", rather than just "API Specification", and ambiguous documentation creates space for this confusion.

I wonder if there is any intention to support those of us that have more than one API per component (e.g. an internal and external API)...

Like # people like this

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events