Skip to content

sonatype-nexus-community/sonatype-guide-api-client

Sonatype Guide API Client(s)

shield_gh-workflow-test shield_license


This repository produces generated API Clients for Sonatype Guide in various languages and frameworks for use by Customers and other projects.

Supported Languages & Frameworks

Request a new lanaguage / framework via GitHub Issue.

Language / Framework Sonatype Guide Version Added Public Package Link
Golang / Go 14-Jan-2026 (1.202601.0) go.dev reference
Java (Webclient) 14-Jan-2026 (1.202601.0) Maven Central Version
Python 14-Jan-2026 (1.202601.0) PyPi
Typescript (fetch) 14-Jan-2026 (1.202601.0) npm

Customisations

There are a small number of customisations to the published OpenAPI specification. These are captured in the update-spec.py script.

Getting the latest OpenAPI Schema

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

Generation of API Clients

Example:

docker run --rm -v "$(PWD):/local" openapitools/openapi-generator-cli batch --clean /local/typescript.yaml

Releasing

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.

The Fine Print

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!