[jira] [Commented] (SOLR-16346) Generate (and use) OpenAPI spec for v2 APIs

["Kevin Risden (Jira)" <ji...@apache.org>]

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

Kevin Risden commented on SOLR-16346:
-------------------------------------

{quote}One lingering question that I never got to the bottom of is why our {{analyzeClassesDependencies}} task behaves nondeterministically.  I tried a variety of JVMs and even machines, but was never able to reproduce "locally".  Flakiness in our test suite is at least understandable, but flakiness in our static linting tools is just odd.  Something to keep an eye on going forward I guess.{quote}

I have no idea what is happening here either. I'm 90% sure its deterministic - but who knows :(

> Generate (and use) OpenAPI spec for v2 APIs
> -------------------------------------------
>
>                 Key: SOLR-16346
>                 URL: https://issues.apache.org/jira/browse/SOLR-16346
>             Project: Solr
>          Issue Type: Improvement
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: v2 API
>    Affects Versions: main (10.0)
>            Reporter: Jason Gerlowski
>            Assignee: Jason Gerlowski
>            Priority: Major
>          Time Spent: 2h 50m
>  Remaining Estimate: 0h
>
> An integration with [OpenAPI|https://www.openapis.org/] and its tooling has a lot to offer Solr.  Once generated, an OpenAPI specification can be used to:
> * [generate clients|https://github.com/OpenAPITools/openapi-generator] for multiple programming languages
> * power a web UI to document and help users craft API calls (e.g. [redoc|https://github.com/Redocly/redoc]
> * [detect breaking API changes|https://github.com/Azure/openapi-diff] across releases.
> Of course, these benefits are only useful if we take pains to document our API inputs and outputs (probably with annotations that live directly in our Java code).  But I think there's enough upside to be worth that trouble.
> This ticket aims to cover integrating OpenAPI into our gradle build, so that a single task can be used to generate an OpenAPI spec.  (It might also make sense to use this ticket to cover generating client bindings for one or more languages.)



--
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