lewismc commented on PR #896: URL: https://github.com/apache/nutch/pull/896#issuecomment-4026421578
I put some more work into this PR and feel it is now ready for review. Here's a summary of the changes: * The OpenAPI 3.1.2 specification (openapi.yaml) describing all 24 REST endpoints of the Nutch service, with HTTP/HTTPS server URL variables, HTTP Basic Authentication, and fully typed request/response schemas * Integrate the IBM OpenAPI Validator into the master CI build (.github/workflows/master-build.yml) with a dorny/paths-filter gate so it runs only when openapi.yaml or .spectral.yaml change * Add a .spectral.yaml ruleset override to disable IBM-specific convention rules that conflict with the existing Nutch wire format (camelCase properties, UPPER_CASE enums, bare-array responses). This means minimal code changes to the Deprecated Nutch service code. I saw this as unproductive effort if we are just going to remove it in a future version. Should we wish to create a new service based on the openapi specification we could likely reuse some of this code but that is an entirely separate effort * Deprecate all Java classes in org.apache.nutch.service and its sub-packages with `@Deprecated` annotations and `@deprecated` Javadoc tags indicating the service will be removed in a future version of Nutch * Add a deprecation warning to the `startserver` command in `src/bin/nutch` and mark it as deprecated in the usage text * Mark Docker `BUILD_MODE=1` (server) and `BUILD_MODE=2` (server + webapp) as deprecated in `docker/Dockerfile` with build-time warnings * Annotate the 6 service-only dependencies in `ivy/ivy.xml` (5 Apache CXF artifacts and jackson-jaxrs-json-provider) with XML comments noting they will be removed with the service -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
