janhoy commented on PR #4291: URL: https://github.com/apache/solr/pull/4291#issuecomment-4799696405
> My original intention for this JIRA was more to generate a bunch of small snippets using openapi-generator that would then be referenced on individual sections of our ref-guide (via the include:: syntax that lets you bring in content from other files). That makes sense. Would those snippets be individual files checked into git, with explicit re-generation (like we have for picocli docs in a pr branch)? I imagine an on-demand build of openapi-spec is too heavy. Where do we currenlty hand-code REST-API paths, actions and parameters? I know we have some cURL examples here and there, those would be hard to replace as is. Guess an example would help here to grok what it would look like. To limit scope, this PR should probably only do the rendering of these static snippets and wire it in one place in the ref-guide. Then follow-up PRs can replace more hand-written docs. And yet another PR could add swagger-UI style live docs. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
