OpenAPI specs #490
OpenAPI specs #490
Conversation
This is a very basic file to document the package-registry API with the OpenAPI spec. Many things like example events or schemas were left out. The goal is to have a simple foundation in and iterate on top of it.
💚 Build Succeeded
Expand to view the summary
Build stats
Test stats 🧪
|
|
@ruflin can we commit this partial implementation and keep improving it or is there some other criteria for merging this? |
|
@jfsiii Yes, I will try to review / update again and get it in. |
|
@jfsiii I just made this ready for review. Some specs are missing but the ones we have should be correct. Lets have a first version in and iterate on it. |
There was a problem hiding this comment.
Approving to get this in and iterate but this only defines the request side. The response types aren't useful yet.
I'd like to get those in as soon as we can as they're the most valuable to Kibana. I'm happy to submit a PR but the values https://github.com/jfsiii/package-registry/blob/openapi-and-types/openapi/epr.spec.yaml should also be a good starting point
|
@jfsiii Would be great if you could open a PR. The part I worried about adding this now was that we are still changing some bits (hopefully stopping end of this week) and wanted 1 less movable part. |
|
@ruflin sure thing, I'll send one soon |
This PR is to kick of an OpenAPI spec for the package-registry to document the API endpoints. For now it is kept simple.
This comes out of #487 (comment)