Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Provide support for OpenAPI 3.1.0 #2785

Closed
wants to merge 37 commits into from
Closed

Provide support for OpenAPI 3.1.0 #2785

wants to merge 37 commits into from

Conversation

char0n
Copy link
Member

@char0n char0n commented Jan 23, 2023 •
edited
Loading

The goal of this issue to introduce OpenAPI 3.1.0 support to the swagger-client. This support will come via ApiDOM integration.

stateDiagram-v2
    state "Swagger Client" as SwaggerClient
    state "HTTP Client" as SwaggerClientHTTPClient
    state "JSON Parser" as SwaggerClientJSONParser
    state "YALM 1.2 Parser" as SwaggerClientYALMParser
    
    state ApiDOM
    state "ApiDOM resolver plugin" as ApiDOMSwaggerClientResolverPlugin
    state "ApiDOM JSON parser plugin" as ApiDOMSwaggerClientJSONParserPlugin
    state "ApiDOM OpenAPI 3.1 JSON parser plugin" as ApiDOMSwaggerClientJSONOpenAPI31ParserPlugin
    state "ApiDOM YAML Parser plugin" as ApiDOMSwaggerClientYAMLParserlugin
    state "ApiDOM OpenAPI 3.1 YAML Parser plugin" as ApiDOMSwaggerClientYAMLOpenAPI31Parserlugin
    state "ApiDOM OpenAPI 3.1 normalization" as ApiDOMOpenAPI31Normalization
    state "ApiDOM OpenAPI 3.1 dereference strategy" as ApiDOMOpenAPI31DereferenceStrategy

    state "Meta patches" as ApiDOMOpenAPI31DereferenceStrategyMetaPatches
    state "Circular structures" as ApiDOMOpenAPI31DereferenceStrategyCircularStructures
    state "Parameter Macro" as ApiDOMOpenAPI31DereferenceStrategyParameterMacro
    state "Model Property Macro" as ApiDOMOpenAPI31DereferenceStrategyModelPropertyMacro
    state "Strict/Non-Strict mode (allOf)" as ApiDOMOpenAPI31DereferenceStrategyMode

    SwaggerClient --> SwaggerClientHTTPClient
    SwaggerClient --> SwaggerClientJSONParser
    SwaggerClient --> SwaggerClientYALMParser

    SwaggerClientHTTPClient --> ApiDOMSwaggerClientResolverPlugin
    SwaggerClientJSONParser --> ApiDOMSwaggerClientJSONParserPlugin
    SwaggerClientJSONParser --> ApiDOMSwaggerClientJSONOpenAPI31ParserPlugin
    SwaggerClientYALMParser --> ApiDOMSwaggerClientYAMLParserlugin
    SwaggerClientYALMParser --> ApiDOMSwaggerClientYAMLOpenAPI31Parserlugin

    ApiDOMOpenAPI31DereferenceStrategyMetaPatches --> ApiDOMOpenAPI31DereferenceStrategy
    ApiDOMOpenAPI31DereferenceStrategyCircularStructures --> ApiDOMOpenAPI31DereferenceStrategy
    ApiDOMOpenAPI31DereferenceStrategyParameterMacro --> ApiDOMOpenAPI31DereferenceStrategy
    ApiDOMOpenAPI31DereferenceStrategyModelPropertyMacro --> ApiDOMOpenAPI31DereferenceStrategy
    ApiDOMOpenAPI31DereferenceStrategyMode --> ApiDOMOpenAPI31DereferenceStrategy

    ApiDOM --> SwaggerClient
    ApiDOMOpenAPI31Normalization --> ApiDOM
    ApiDOMSwaggerClientResolverPlugin --> ApiDOM
    ApiDOMSwaggerClientJSONParserPlugin --> ApiDOM
    ApiDOMSwaggerClientJSONOpenAPI31ParserPlugin --> ApiDOM
    ApiDOMSwaggerClientYAMLParserlugin --> ApiDOM
    ApiDOMSwaggerClientYAMLOpenAPI31Parserlugin --> ApiDOM
    ApiDOMOpenAPI31DereferenceStrategy --> ApiDOM
Loading

TODO:

Refs #2718
Refs #2717

Warning

Superseded by #2786

char0n added 30 commits January 23, 2023 12:36
@char0n
chore: integrate ApiDOM into codebase
94f47a9 
Refs #2718
@char0n
feat(resolve): add ApiDOM JSON parser (#2739)
a4e6e52 
Refs #2717
Refs #2718
@char0n
chore(deps): fix missing dependencies
c3de393 
Refs #2718
Refs https://github.com/swagger-api/swagger-js/actions/runs/3788003312/jobs/6440344162
@char0n
feat(resolve): add ApiDOM YAML 1.2 parser
db4737f 
Refs #2717
@char0n
feat(resolve): add ApiDOM OpenAPI 3.1.0 JSON parser
dc5b833 
Refs #2717
@char0n
feat(resolve): add ApiDOM OpenAPI 3.1.0 YAML 1.2 parser
77504ec 
Refs #2717
@char0n
refactor(apidom): remove redundant composition arguments
c75e386 
Refs #2717
@char0n
chore(eslint): set ecmaVersion to 2020 in .eslintrc
a3be4e4 
This will allow to use optional chaining and other
JavaScript advanced features.

Refs #2717
@char0n
test(resolve): add tests for ApiDOM JSON parser
1ba8568 
Refs #2717
@char0n
test(resolve): add tests for ApiDOM YAML 1.2 parser
a0fd00b 
Refs #2717
@char0n
test(resolve): add tests for ApiDOM OpenAPI 3.1.0 JSON parser
3a33ab0 
Refs #2717
@char0n
test(resolve): add tests for ApiDOM OpenAPI 3.1.0 YAML 1.2 parser
30031f7 
Refs #2717
@char0n
test(helpers): re-organize tests to reflect code structure
da9c12f 
Refs #2717
@char0n
feat(resolve): add ApiDOM resolver based on SwaggerClient HTTP client
485bb01 
Refs #2717
@char0n
feat: add OpenAPI 3.1.0 dereference strategy (#2740)
945bf92 
Refs #2717
@char0n
refactor(helpers): reorganize OpenAPI predicates into separate module
b146526 
Refs #2717
@char0n
refactor(helpers): reorganize helpers in backward compatible way
c0ee0a6 
Refs #2717
@char0n
test(helpers): re-organize tests to reflect code structure
8c38540 
Refs #2717
@char0n
feat(normalization): introduce normalization for OpenAPI 3.1.0
58981e4 
Refs #2743
@char0n
refactor(resolver): refactor code to allow using strategy pattern
085fc57 
Refs #2744
@char0n
feat(resolver): add support for OpenAPI 3.1.0 resolution
e04ead9 
Refs #2744
@char0n
build: set minimum runtime Node.js version to 12.20.0
0cb9b6b 
Node.js =12.20.0 added support for exports field.
Node.js =12.19.0 added support for imports field.

Both of these fields are used by integrated ApiDOM.

[email protected] doesn't yet support package.json imports
field. Next version will, more info in:
jestjs/jest#12270.

Refs #2744
@char0n
fix(resolver): fix useCircularStructure option support in OpenAPI 3.1
d3a73fd 
Refs #2755
@char0n
test(resolver): add tests for OpenAPI 3.1.0 allowMetaPatches option
2402a19 
Closes #2760
@char0n
test(resolver): add tests for OpenAPI 3.1 useCircularStructures opt
bb2953d 
Closes #2761
@char0n
test(resolver): add tests for OpenAPI 3.1 spec obj resolution
835a240 
Spec object can be provided instead of URL.
If baseDoc or url options are not provided,
default retrival URL is set to http://smartbear.com

Refs #2754
@char0n
test(resolver): add tests for OpenAPI 3.1 skipNormalization option
1a4f565 
Refs #2764
@char0n
refactor(resolver): use constant HTTPS baseURI in non-browser env
181f5e6 
This change is specific to OpenAPI 3.1.0 resolution
strategy.

Refs #2754
@char0n
feat(resolver): add support for pathDiscriminator option
e71c989 
This change is specific to OpenAPI 3.1.0 strategy.

Refs #2753
@char0n
feat(resolver): add support for parameterMacro option
34f8a4b 
This change is specific to OpenAPI 3.1.0 strategy.

Refs #2748
@char0n char0n mentioned this pull request Jan 23, 2023
Closed
1 task
@char0n char0n force-pushed the openapi-3-1-support branch from ab719a0 to 697ffe5 Compare January 23, 2023 12:27
@char0n char0n closed this Jan 23, 2023
@char0n char0n deleted the openapi-3-1-support branch January 23, 2023 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@char0n