gerlowskija opened a new pull request, #1024:
URL: https://github.com/apache/solr/pull/1024
# Description
Projects can derive a lot of value from an OpenAPI spec description of their
APIs. OpenAPI specs can be used to generate documentation UIs, clients in a
variety of languages, etc. But while Solr defines some of its APIs in a way
that OpenAPI tooling understands (see SOLR-16347), we don't currently produce
an OpenAPI spec for this tooling to use.
# Solution
This PR adds the 'swagger-gradle-plugin' to our gradle build, allowing
developers (or CI) to generate a spec with a new 'resolve' task (`./gradlew
solr:core:resolve`). The spec is created in the 'core' module's
`build/generated/openapi` directory and can be used as-is with most OpenAPI
tooling.
# Tests
No automated tests as this is a build-system change, though some manual
testing of the 'resolve' task and the produced OpenAPI spec.
# Checklist
Please review the following and check all that apply:
- [x] I have reviewed the guidelines for [How to
Contribute](https://wiki.apache.org/solr/HowToContribute) and my code conforms
to the standards described there to the best of my ability.
- [x] I have created a Jira issue and added the issue ID to my pull request
title.
- [x] I have given Solr maintainers
[access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork)
to contribute to my PR branch. (optional but recommended)
- [x] I have developed this patch against the `main` branch.
- [ ] I have run `./gradlew check`.
--
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]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
