-
Bug
-
Resolution: Fixed
-
Low
-
None
-
1
-
Minor
-
Issue Summary
- Unable to upload Open API Specifications programmatically into Compass via REST API.
- The REST Endpoint suggests upload is successful with 200 OK.
- However, the UI shows the error:
- API endpoint used:
https://your-domain.atlassian.net/gateway/api/compass/v1/component/{componentId}/api_specs'
Steps to Reproduce
- Use the REST endpoint below:
curl --request PUT \ --url 'https://your-domain.atlassian.net/gateway/api/compass/v1/component/{componentId}/api_specs' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: multipart/form-data' \ --form file=@/path/to/file/swagger.yaml
- Use any Swagger.YAML (API spec) file with and without $ref in the content
Expected Results
- We observe a 200 OK suggesting the file has been successfully uploaded via REST api.
- And the API Specifications tab on Compass showing the relevant data.
Actual Results
- We observe a 200 OK suggesting the file has been successfully uploaded via REST api.
- However, the API Specifications tab on Compass shows the Error :
Unable to load spec - error from file spec: Unable to resolve $ref pointer "/spec.json?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=ASIAXEKVYEQ7OEQE5275%2F20250730%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250730T102915Z&X-Amz-Expires=900&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F
Workaround
Currently there is no known workaround for this behavior. A workaround will be added here when available
- is resolved by
-
COMPASS-27713 Loading...