Use AsciiDoc AST to create open v3 support #381
Conversation
austek
force-pushed
the
refactor/Asciidoctor_ast_implementation
branch
from
0d6618b to
ad19687
Compare
There was a problem hiding this comment.
The current implementation has an extension mechanism where users can inject AsciiDoc/Markdown at certain positions.
Do you plan to add such an extension mechanism as well?
The current implementation allows configure the order of the parameters, operations and definitions.
It also allows to group paths by tags.
Do you plan to add this configuration option as well?
|
|
||
| public class OpenApiHelpers { | ||
|
|
||
| public static final String LABEL_DEFAULT = "Default"; |
There was a problem hiding this comment.
Internationalization: I think labels should be localized like in the current implementation.
There was a problem hiding this comment.
Internationalization will be supported, that's the reason, all strings are collected in one place to make it easier to do that. Just wanted to do an initial pass for v3 support
| pathItem.readOperationsMap().forEach(((httpMethod, operation) -> { | ||
| SectionImpl operationSection = new SectionImpl(allPathsSection); | ||
| String summary = Optional.ofNullable(operation.getSummary()).orElse(""); | ||
| operationSection.setTitle((italicUnconstrained(httpMethod.name().toUpperCase()) + " " + monospaced(name) + " " + summary).trim()); |
There was a problem hiding this comment.
Can we change this to how it looks today?
There was a problem hiding this comment.
Certainly can be done, I opted for the current implementation as summary is an optional value can be missing. what could be used for such scenarios?
austek
force-pushed
the
refactor/Asciidoctor_ast_implementation
branch
from
b9aaf43 to
e6706d7
Compare
* Use Asciidoc AST to create OpenApi v3 support * Add `Overview` information * Add `Servers` information * Fix document authors * Fix document authors * Add `Servers` information * Add `Servers` information * Add `Servers` information * Add `Servers` information * Add `Path Parameters` information * Add `Path Parameters` information * Add `Path Responses Links` information * Add `Tags` information * Add `Comonents.Schemas` information * Add `Comonents.Parameters` information * Add `External Docs` information * Add `Components Responses` information * Add `Components Headers` information * Add `Components Links` information * Delete unused test fixtures * Change asciidoctorJ dependency to asciidoctorj-api, to remove the the need for JRuby
|
Not 100% sure about the plans, but this ticket is probably ready to be closed. Correct? |
|
Hi @RobWin !! I could see that this feature is merged to master, but none new version of this artifact has been released from two years ago. Do you have any plan about doing a new release with these changes? Will be this feature available to be used with maven plugin? Thank you! |
OpenApi v3 support #340 schema document support implemented as follows;