[
https://issues.apache.org/jira/browse/NUTCH-2931?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18058555#comment-18058555
]
ASF GitHub Bot commented on NUTCH-2931:
---------------------------------------
lewismc opened a new pull request, #896:
URL: https://github.com/apache/nutch/pull/896
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](https://github.com/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 surprise
to find it.
I remember using the existing Java annotations and the [Wiki
documentation](https://cwiki.apache.org/confluence/display/nutch/NutchRESTAPI)
to pull together the documentation.
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](https://openapi-generator.tech/docs/generators#server-generators)
project to generate a server implementation we could package either with Nutch
or separately altogether.
I'm open to suggestions.
> Improvements to 1.x REST API
> ----------------------------
>
> Key: NUTCH-2931
> URL: https://issues.apache.org/jira/browse/NUTCH-2931
> Project: Nutch
> Issue Type: Improvement
> Components: REST_api
> Affects Versions: 1.18
> Reporter: Lewis John McGibbney
> Priority: Major
> Fix For: 1.23
>
>
> [Shi Wei's thread on
> user@|https://lists.apache.org/thread/qp23l1613r3lfjdnnnolg0njsky3py0r] has
> motivated me to finally start flushing out some improvements I would like to
> make to the 1.x REST API. This issue is going to act as the parent.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
