[ 
https://issues.apache.org/jira/browse/SOLR-16880?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17741279#comment-17741279
 ] 

Jason Gerlowski commented on SOLR-16880:
----------------------------------------

Sure - overall I'm envisioning this as the same "type" of release artifact as 
[CHANGES.html|https://archive.apache.org/dist/solr/solr/9.2.1/changes/Changes.html],
 or the old pdf version of the ref-guide.  Things that get produced by gradle, 
signed (I think), and then stored in SVN and downloaded by users via the Apache 
download mirrors (as opposed to via Maven Central or Dockerhub or some other 
repository).

Some other clarifications inline:

bq. Is there a community repository for spec files somewhere?

Not that I know of.

bq. Are they deterministically reproducible for each source build?

Yes

bq. Is there a way to verify that a given spec file actually corresponds to a 
given specific artifact?

Well, the spec file contains metadata, including the Solr server version that 
the spec corresponds to.  So it should be clear from any spec what version of 
Solr it corresponds to.  Or did you mean something else?

> Make OpenAPI spec a release artifact
> ------------------------------------
>
>                 Key: SOLR-16880
>                 URL: https://issues.apache.org/jira/browse/SOLR-16880
>             Project: Solr
>          Issue Type: Improvement
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: v2 API
>            Reporter: Jason Gerlowski
>            Priority: Major
>
> 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]

Reply via email to