Skip to content

sonatype-nexus-community/ossindex-api-client

OSS Index API Client(s)

CI GitHub license GitHub issues GitHub forks GitHub stars


This repository produces generated API Clients in various languages and frameworks for use by Customers, other projects and interested parties.

Supported Languages & Frameworks

Language / Framework Since Public Package Link
Python 2025-11-15 PyPI - Version
Typescript (fetch) 2023-05-22 npm

Known Issues

APIs Excluded from Generation

None

Getting the latest OpenAPI Schema

Create a Python Virtual Environment with Poetry and then run:

poetry install
python update-spec.py

This will download the current Swagger 2.0 specification, convert to OpenAPI 3, add a few tweaks and put it into the spec folder.

Generation of API Clients

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

docker run --rm -v "$(PWD):/local" openapitools/openapi-generator-cli generate -i /local/spec/openapi.yaml -g typescript-fetch -o /local/out/test -c /local/openapi-config.yaml -v > out.log

Releasing

We use semantic-release to generate releases from commits to the main branch.

For example, to perform a "patch" release, add a commit to main with a comment like below. The fix: prefix matters.

fix: the problem resolved goes here

The Fine Print

Remember:

It is worth noting that this is NOT SUPPORTED by Sonatype, and is a contribution of ours to the open source community (read: you!)

  • Use this contribution at the risk tolerance that you have
  • Do NOT file Sonatype support tickets related to ossindex-api-client
  • DO file issues here on GitHub, so that the community can pitch in

Phew, that was easier than I thought. Last but not least of all - have fun!

About

Generated API clients for ossindex.sonatype.org

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Languages