search

CycloneDX / transparency-exchange-api

A standard API specification for exchanging supply chain artifacts and intelligence
https://tc54.org/
Apache License 2.0
61 stars 9 forks source link

Tweak OpenAPI specs and workflows #77

Closed vpetersson closed 5 days ago

vpetersson commented 6 days ago
vpetersson commented 6 days ago

@oej / @stevespringett Please review. I realize this is a fairly sizeable PR with a lot of changes in here but my goal was to contribute a more complete API spec and bring it in line with the workflow documentation.

madpah commented 5 days ago

@vpetersson - the OpenApi Spec JSON file is throwing errors for me (that don't make sense). Will take some time to confirm if they are indeed errors and if so what they are caused by!

vpetersson commented 5 days ago

Interesting. Did you preview it with the swagger-ui in Docker as per the readme?

madpah commented 5 days ago

That's all I have done thus far @vpetersson - will get some more time nearer lunch and will dig in properly. I've had issues with Swagger UI before...

vpetersson commented 5 days ago

Yeah I can't say I'm a big fan of swagger-ui myself, but it was the path of least resistance. There are more modern alternatives out there that we can adopt later on.

oej commented 5 days ago

I did generate docs and check validity with openapi-generator and got no errors. Generated docs in various formats. Maybe we can add my scripts/makefile later as an example. Beautiful HTML and various other formats.

madpah commented 5 days ago

All comments addressed in the PR or GH Issues opened to track resolution beyond this PR.