[SOLR-16346] Generate OpenAPI spec for v2 APIs

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: main (10.0)
• Fix Version/s: main (10.0), 9.2
• Component/s: v2 API
• Assignee: Jason Gerlowski
• Reporter: Jason Gerlowski
• Created: 19/Aug/22 14:48
• Updated: 12/Jul/23 11:05
• Resolved: 25/Oct/22 02:26

Description

An integration with OpenAPI and its tooling has a lot to offer Solr. Once generated, an OpenAPI specification can be used to:

• generate clients for multiple programming languages
• power a web UI to document and help users craft API calls (e.g. redoc
• detect breaking API changes across releases.

Of course, these benefits are only useful if we take pains to document our API inputs and outputs (probably with annotations that live directly in our Java code). But I think there's enough upside to be worth that trouble.

This ticket aims to cover integrating OpenAPI into our gradle build, so that a single task can be used to generate an OpenAPI spec. - (It might also make sense to use this ticket to cover generating client bindings for one or more languages.)-

Issue Links

• is related to: SOLR-16825 Generate Java bindings from OpenAPI spec
• links to: GitHub Pull Request #1024
• links to: GitHub Pull Request #1043