[
https://issues.apache.org/jira/browse/SOLR-16880?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17794109#comment-17794109
]
Jan Høydahl edited comment on SOLR-16880 at 12/7/23 10:03 AM:
--------------------------------------------------------------
Have you considered adding a SwaggerUI servlet to Solr (e.g. one that serves
the apiDoc on [http://localhost:8983/api])? It can be unprotected, as it is
just a web page generated from the OAS.
[https://app.swaggerhub.com/apis-docs/JanHydahl/v-2_api/10.0.0]
!Skjermbilde 2023-12-07 kl. 11.01.57.png|width=800!
was (Author: janhoy):
Have you considered adding a SwaggerUI servlet to Solr (e.g. one that serves
the apiDoc on [http://localhost:8983/api])? It can be unprotected, as it is
just a web page generated from the OAS.
!Skjermbilde 2023-12-07 kl. 11.01.57.png|width=800!
> 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
>
>
> 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]
