[SOLR-16880] Make OpenAPI spec a release artifact

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 9.5
• Component/s: v2 API
• Assignee: Jason Gerlowski
• Reporter: Jason Gerlowski
• Created: 07/Jul/23 16:02
• Updated: 12/Feb/24 19:48
• Resolved: 14/Dec/23 17:45

Description

SOLR-16346 added OpenAPI spec generation to Solr - allowing us to produce a detailed description of our v2 APIs (or at least - those APIs implemented using JAX-RS).

These spec files have a lot of potential uses - from generating documentation, to API clients, to web UIs. These have a lot of promise, but it will take the community time to implement and adopt some of them.

We should make the OpenAPI spec available as a release artifact, so that users can more easily take advantage of it. Having it published on each release will also allow us to compare specs across versions, as a way to detect backcompat breaks before changes go out the door.

Issue Links

• links to: GitHub Pull Request #2125