[
https://issues.apache.org/jira/browse/NUTCH-2931?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18064235#comment-18064235
]
ASF GitHub Bot commented on NUTCH-2931:
---------------------------------------
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
> 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)
