This repository produces generated API Clients for Sonatype Guide in various languages and frameworks for use by Customers and other projects.
- Supported Languages & Frameworks
- Customisations
- Getting the latest OpenAPI Schema
- Generation of API Clients
- Releasing
- The Fine Print
Request a new lanaguage / framework via GitHub Issue.
There are a small number of customisations to the published OpenAPI specification. These are captured in the update-spec.py script.
Use your Guide API Token to access the latest OpenAPI schema:
curl -H 'Authorization: Bearer <YOUR-GUIDE-API-TOKEN>' https://api.guide.sonatype.com/.well-known/api-catalog > spec/openapi.yaml
Example:
docker run --rm -v "$(PWD):/local" openapitools/openapi-generator-cli batch --clean /local/typescript.yaml
As Sonatype Guide is a Cloud service, we version API clients based on year, month and fix (patch) version.
For example - an OpenAPI spec fetched on 5th March 2026 might be version 1.202603.0.
Adding git tags triggers the release process.
Remember:
This project is part of the Sonatype Nexus Community organization, which is not officially supported by Sonatype. Please review the latest pull requests, issues, and commits to understand this project's readiness for contribution and use.
- File suggestions and requests on this repo through GitHub Issues, so that the community can pitch in
- Use or contribute to this project according to your organization's policies and your own risk tolerance
- Don't file Sonatype support tickets related to this project— it won't reach the right people that way
Last but not least of all - have fun!