Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-16880

Make OpenAPI spec a release artifact

Attach filesAttach ScreenshotVotersWatch issueWatchersCreate sub-taskLinkCloneUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Major
    • Resolution: Fixed
    • None
    • 9.5
    • v2 API
    • None

    Description

      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.

      Attachments

        Activity

          This comment will be Viewable by All Users Viewable by All Users
          Cancel

          People

            gerlowskija Jason Gerlowski
            gerlowskija Jason Gerlowski
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0h
                0h
                Logged:
                Time Spent - 1h 20m
                1h 20m

                Slack

                  Issue deployment