OSS Index API Client(s)

---

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

Supported Languages & Frameworks

Language / Framework	OSS Index REST API Version (Date)	Public Package Link
Typescript (fetch)	2023.05	NPM

Known Issues

APIs Excluded from Generation

None

Additional Changes to OpenAPI Schema prior to Generation

• Removal of references to basicAuth security scheme which is not defined and unused given apiToken security scheme
• Added schema for response to /api/v3/component-report and /api/v3/authorized/component-report APIs
• Added schema for response to /api/v3/version

Getting the latest OpenAPI Schema

Get it from your OSS Index directly..

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

Changelog

See our Change 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!