NUTCH-2931 Create OpenAPI specification for Nutch 1.x REST API#896
Draft
lewismc wants to merge 2 commits intoapache:masterfrom
Draft
NUTCH-2931 Create OpenAPI specification for Nutch 1.x REST API#896lewismc wants to merge 2 commits intoapache:masterfrom
lewismc wants to merge 2 commits intoapache:masterfrom
Conversation
Member
Author
|
I pushed a commit to add a new step to lint and validate In an API-first development model, these items would be addressed before we do anything further. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is a WIP I had on an old laptop and never pushed to my public Nutch mirror. My notes are that the OpenAPI spec didn't comply with the IBM/openapi-validator which is what I use(d) to lint and validate the OpenAPI specifications I work(ed) on over the years. I didn't have enough time/was side tracked by something or lots of other somethings and ultimately forgot about this branch altogether. I was surprised to find it.
I remember using the existing Java annotations and the Wiki documentation as resources for the OpenAPI. A few ex-colleagues also assisted in developing this branch.
It needs peer reviewed for completeness and updated to OpenAPI 3.1.X however this is a good foundation.
You can view the OpenAPI documentation if you copy and paste the content into https://editor.swagger.io/.
The goal would be to use the OpenAPI Generator project to generate a server implementation we could package either with Nutch or separately altogether.
I'm open to suggestions.