You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@solr.apache.org by "David Smiley (Jira)" <ji...@apache.org> on 2023/07/11 18:51:00 UTC
[jira] [Comment Edited] (SOLR-16880) Make OpenAPI spec a release artifact
[ https://issues.apache.org/jira/browse/SOLR-16880?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17742136#comment-17742136 ]
David Smiley edited comment on SOLR-16880 at 7/11/23 6:50 PM:
--------------------------------------------------------------
+1
Maybe a separate issue, but I think it would do us well to keep the generated API (openapi.json) in source control and checked in, only to be updated automatically. Conceptually we do similarly for dependencies via versions.lock, so there is some precedent. Why?:
* clarifies historical changes to our API (touched by what commit/PR/JIRA) via using familiar version control
** enhances code reviews to clarify the impact (intended or unintended)
** could review this at release boundaries to QA that we mention worthwhile things in release notes
* published openapi.json via GitHub files and per-branch; generally no need to generate it (or remember how)
was (Author: dsmiley):
+1
Maybe a separate issue, but I think it would do us well to keep the generated API (openapi.json) in source control and checked in, only to be updated automatically. Conceptually we do similarly for dependencies via versions.lock, so there is some precedent. Why?:
* clarifies historical changes to our API (touched by what commit/PR/JIRA) via using familiar version control
** enhances code reviews to clarify the impact (intended or unintended)
* published openapi.json via GitHub files and per-branch
> 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: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org