[
https://issues.apache.org/jira/browse/SOLR-16880?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17794374#comment-17794374
]
Jason Gerlowski commented on SOLR-16880:
----------------------------------------
I'd definitely like to see Solr get a SwaggerUI (or something similar - some
alternatives like redocly are pretty cool), but IMO it's not a sufficient
replacement for exposing the OAS as a proper artifact.
SwaggerUI wouldn't offer any of the checksum/signing niceties we would get with
a proper release artifact. It also doesn't provide any easy way to lookup the
spec for past releases - making it a pain to diff across multiple Solr
versions, or detect breaking changes prior to a release. It requires that
users stand up a Solr server to get the JSON file, etc.
> Make OpenAPI spec a release artifact
> ------------------------------------
>
> Key: SOLR-16880
> URL: https://issues.apache.org/jira/browse/SOLR-16880
> Project: Solr
> Issue Type: Improvement
> Components: v2 API
> Reporter: Jason Gerlowski
> Priority: Major
> Attachments: Skjermbilde 2023-12-07 kl. 11.01.57.png
>
> Time Spent: 20m
> Remaining Estimate: 0h
>
> 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.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
