The Atlassian Community Forums are currently in read-only mode. We will be relaunching on a new platform on September 22 (read more here). We apologize for the extended downtime. For concerns or questions, please email communitymanagers@atlassian.com. See you on the other side, on the new Atlassian Community Forums! :)

×

Forums

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

Announcement: Upload OpenAPI to the API tab using Curl

Hey all! You've probably seen the new API Tab in Compass. It discovers OpenAPI specifications in your repos, syncs that documentation to Compass, and tracks changes to each endpoint over time. 

This works great when your Swagger/OpenAPI is checked into the repository, but for teams that don't check them into the repo there was not a good way to use the feature.

Well...now you can use this API to upload an OpenAPI JSON or YAML file:

curl --request PUT \ 
--url 'https://<customer-domain>.atlassian.com/gateway/api/compass/v1/component/<component-id>/api_specs' \
--user '<email-address>:<api-token>' \
--header 'Content-Type: multipart/form-data' \
--form file=@/path/to/spec-file.yaml

API Docs: Upload OpenAPI and link to Component 

 

Screenshot 2025-02-03 at 4.40.26 PM.png

2 comments

Comments for this post are closed

Community moderators have prevented the ability to post new comments.

David Harper
Contributor
February 4, 2025

Are there any plans to make a Bitbucket Pipe for this?

Like # people like this
Andrei
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
February 10, 2025

That is a great idea @David Harper ! We'll add that to the backlog and see how we can make spec uploads more straightforward.

Like # people like this
TAGS
AUG Leaders

Atlassian Community Events