Skip to content

NUTCH-2931 Create OpenAPI specification for Nutch 1.x REST API#896

Draft
lewismc wants to merge 2 commits intoapache:masterfrom
lewismc:NUTCH-2932
Draft

NUTCH-2931 Create OpenAPI specification for Nutch 1.x REST API#896
lewismc wants to merge 2 commits intoapache:masterfrom
lewismc:NUTCH-2932

Conversation

@lewismc
Copy link
Member

@lewismc lewismc commented Feb 14, 2026

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.

@lewismc lewismc self-assigned this Feb 14, 2026
@lewismc lewismc marked this pull request as draft February 14, 2026 01:29
@lewismc
Copy link
Member Author

lewismc commented Feb 14, 2026

I pushed a commit to add a new step to lint and validate openapi.yaml. I knew this would fail but it demonstrates where I got to last time around! Addressing the issues is non-trivial work.

  Total number of errors   : 89
  Total number of warnings : 315

In an API-first development model, these items would be addressed before we do anything further.

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.

1 participant