-
Notifications
You must be signed in to change notification settings - Fork 762
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(resolver): add support for OpenAPI 3.1.0 resolution
Refs #2744
- Loading branch information
Showing
8 changed files
with
549 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| /* eslint-disable camelcase */ | ||
| import { toValue } from '@swagger-api/apidom-core'; | ||
| import { OpenApi3_1Element } from '@swagger-api/apidom-ns-openapi-3-1'; | ||
| import { dereferenceApiDOM } from '@swagger-api/apidom-reference/configuration/empty'; | ||
| import BinaryParser from '@swagger-api/apidom-reference/parse/parsers/binary'; | ||
| import OpenApi3_1ResolveStrategy from '@swagger-api/apidom-reference/resolve/strategies/openapi-3-1'; | ||
|
|
||
| import * as optionsUtil from '../utils/options.js'; | ||
| import normalizeOpenAPI31 from '../../helpers/normalize/openapi-3-1.js'; | ||
| import HttpResolverSwaggerClient from '../../helpers/apidom/reference/resolve/resolvers/http-swagger-client/index.js'; | ||
| import JsonParser from '../../helpers/apidom/reference/parse/parsers/json/index.js'; | ||
| import YamlParser from '../../helpers/apidom/reference/parse/parsers/yaml-1-2/index.js'; | ||
| import OpenApiJson3_1Parser from '../../helpers/apidom/reference/parse/parsers/openapi-json-3-1/index.js'; | ||
| import OpenApiYaml3_1Parser from '../../helpers/apidom/reference/parse/parsers/openapi-yaml-3-1/index.js'; | ||
| import OpenApi3_1SwaggerClientDereferenceStrategy from '../../helpers/apidom/reference/dereference/strategies/openapi-3-1-swagger-client/index.js'; | ||
|
|
||
| const resolveOpenAPI31Strategy = async (options) => { | ||
| const { | ||
| spec, | ||
| timeout, | ||
| redirects, | ||
| requestInterceptor, | ||
| responseInterceptor, | ||
| allowMetaPatches = false, | ||
| useCircularStructures = false, | ||
| skipNormalization = false, | ||
| } = options; | ||
| const openApiElement = OpenApi3_1Element.refract(spec); | ||
| const dereferenced = await dereferenceApiDOM(openApiElement, { | ||
| resolve: { | ||
| baseURI: optionsUtil.retrievalURI(options), | ||
| resolvers: [ | ||
| HttpResolverSwaggerClient({ | ||
| timeout: timeout || 10000, | ||
| redirects: redirects || 10, | ||
| }), | ||
| ], | ||
| resolverOpts: { | ||
| swaggerHTTPClientConfig: { | ||
| requestInterceptor, | ||
| responseInterceptor, | ||
| }, | ||
| }, | ||
| strategies: [OpenApi3_1ResolveStrategy()], | ||
| }, | ||
| parse: { | ||
| parsers: [ | ||
| OpenApiJson3_1Parser({ allowEmpty: false, sourceMap: false }), | ||
| OpenApiYaml3_1Parser({ allowEmpty: false, sourceMap: false }), | ||
| JsonParser({ allowEmpty: false, sourceMap: false }), | ||
| YamlParser({ allowEmpty: false, sourceMap: false }), | ||
| BinaryParser({ allowEmpty: false, sourceMap: false }), | ||
| ], | ||
| }, | ||
| dereference: { | ||
| strategies: [ | ||
| OpenApi3_1SwaggerClientDereferenceStrategy({ allowMetaPatches, useCircularStructures }), | ||
| ], | ||
| }, | ||
| }); | ||
| const normalized = skipNormalization ? dereferenced : normalizeOpenAPI31(dereferenced); | ||
|
|
||
| return { spec: toValue(normalized), errors: [] }; | ||
| }; | ||
|
|
||
| export default resolveOpenAPI31Strategy; | ||
| /* eslint-enable camelcase */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
179 changes: 179 additions & 0 deletions
179
test/resolver/strategies/openapi-3-1/__fixtures__/petstore.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| { | ||
| "openapi": "3.1.0", | ||
| "info": { | ||
| "version": "1.0.0", | ||
| "title": "Swagger Petstore", | ||
| "license": { | ||
| "name": "MIT" | ||
| } | ||
| }, | ||
| "servers": [ | ||
| { | ||
| "url": "http://petstore.swagger.io/v1" | ||
| } | ||
| ], | ||
| "paths": { | ||
| "/pets": { | ||
| "get": { | ||
| "summary": "List all pets", | ||
| "operationId": "listPets", | ||
| "tags": [ | ||
| "pets" | ||
| ], | ||
| "parameters": [ | ||
| { | ||
| "name": "limit", | ||
| "in": "query", | ||
| "description": "How many items to return at one time (max 100)", | ||
| "required": false, | ||
| "schema": { | ||
| "type": "integer", | ||
| "maximum": 100, | ||
| "format": "int32" | ||
| } | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "A paged array of pets", | ||
| "headers": { | ||
| "x-next": { | ||
| "description": "A link to the next page of responses", | ||
| "schema": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Pets" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "unexpected error", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Error" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "post": { | ||
| "summary": "Create a pet", | ||
| "operationId": "createPets", | ||
| "tags": [ | ||
| "pets" | ||
| ], | ||
| "responses": { | ||
| "201": { | ||
| "description": "Null response" | ||
| }, | ||
| "default": { | ||
| "description": "unexpected error", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Error" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/pets/{petId}": { | ||
| "get": { | ||
| "summary": "Info for a specific pet", | ||
| "operationId": "showPetById", | ||
| "tags": [ | ||
| "pets" | ||
| ], | ||
| "parameters": [ | ||
| { | ||
| "name": "petId", | ||
| "in": "path", | ||
| "required": true, | ||
| "description": "The id of the pet to retrieve", | ||
| "schema": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Expected response to a valid request", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Pet" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "unexpected error", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Error" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "components": { | ||
| "schemas": { | ||
| "Pet": { | ||
| "type": "object", | ||
| "required": [ | ||
| "id", | ||
| "name" | ||
| ], | ||
| "properties": { | ||
| "id": { | ||
| "type": "integer", | ||
| "format": "int64" | ||
| }, | ||
| "name": { | ||
| "type": "string" | ||
| }, | ||
| "tag": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "Pets": { | ||
| "type": "array", | ||
| "maxItems": 100, | ||
| "items": { | ||
| "$ref": "#/components/schemas/Pet" | ||
| } | ||
| }, | ||
| "Error": { | ||
| "type": "object", | ||
| "required": [ | ||
| "code", | ||
| "message" | ||
| ], | ||
| "properties": { | ||
| "code": { | ||
| "type": "integer", | ||
| "format": "int32" | ||
| }, | ||
| "message": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.