Forums

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

Versioned API in Api Specifications

Andrei Reilean
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
December 3, 2024

We have versioned APIs for our services and we want each version to be documented in Compass Api Specifications section of a component (which is web service)

I do not see possibility to do that, as currently Compass can display only one version.
Am I missing something?

1 answer

0 votes
Brant Schroeder
Community Champion
August 5, 2025

@Andrei Reilean welcome to the Atlassian community

You are correct.  You can learn more on a similar question answered by Atlassian here: https://community.atlassian.com/forums/Compass-questions/Releases-Versions-in-Compass/qaq-p/2922327 

Jeff Madison
Contributor
August 5, 2025

That other question was more about how to track release versioning between Jira and Compass, while this question is about a Service component in Compass needing the ability to have multiple versions of its API.

This one-to-many relationship between a Service and an API version is ubiquitous in API management platforms (Apigee, Azure APIM, everybody else), source code systems (Git, etc.) and even other component catalogs competing with Compass (Backstage, etc.). But for some reason API versioning isn't part of Compass's model.

But is there a workaround? Like, are folks creating a separate copy of the service component in Compass for each version, which is non-ideal (implies there are multiple services when they are the same service, just with multiple API versions; loses the link between them).

My team decided to have Compass only reflect the latest API version for a service, but that won't work for teams with services that support multiple API versions in parallel at the same time.

Like # people like this

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events