Skip to content

OpenAPI specs#490

Merged
ruflin merged 3 commits intoelastic:masterfrom
ruflin:openapi
Jun 29, 2020
Merged

OpenAPI specs#490
ruflin merged 3 commits intoelastic:masterfrom
ruflin:openapi

Conversation

@ruflin
Copy link
Collaborator

@ruflin ruflin commented Jun 3, 2020

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)

ruflin added 2 commits June 3, 2020 11:16
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.
@elasticmachine
Copy link

elasticmachine commented Jun 3, 2020

💚 Build Succeeded

Pipeline View Test View Changes Artifacts preview

Expand to view the summary

Build stats

  • Build Cause: [Branch indexing]

  • Start Time: 2020-06-29T12:18:31.561+0000

  • Duration: 8 min 19 sec

Test stats 🧪

Test Results
Failed 0
Passed 143
Skipped 0
Total 143

@jfsiii
Copy link

jfsiii commented Jun 23, 2020

@ruflin can we commit this partial implementation and keep improving it or is there some other criteria for merging this?

@ruflin
Copy link
Collaborator Author

ruflin commented Jun 24, 2020

@jfsiii Yes, I will try to review / update again and get it in.

@ruflin ruflin marked this pull request as ready for review June 29, 2020 07:17
@ruflin
Copy link
Collaborator Author

ruflin commented Jun 29, 2020

@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.

Copy link

@jfsiii jfsiii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@ruflin ruflin merged commit d1c9fd2 into elastic:master Jun 29, 2020
@ruflin ruflin deleted the openapi branch June 29, 2020 12:58
@ruflin
Copy link
Collaborator Author

ruflin commented Jun 29, 2020

@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.

@jfsiii
Copy link

jfsiii commented Jun 29, 2020

@ruflin sure thing, I'll send one soon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants