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

feat: merge refs oas3.1 #1640

Merged
merged 3 commits into from
Jun 9, 2021
Merged

feat: merge refs oas3.1 #1640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0a4d172
chore: remove extra webpack resolver
RomanHotsiy Jun 9, 2021
fa6957f
feat: oas3.1 merge $refs
RomanHotsiy Jun 9, 2021
5332e33
chore: fix deref for non-schemas
RomanHotsiy Jun 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 11 additions & 18 deletions demo/openapi-3-1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -964,8 +964,7 @@ components:
properties:
id:
description: Category ID
allOf:
- $ref: '#/components/schemas/Id'
$ref: '#/components/schemas/Id'
name:
description: Category name
type: string
Expand Down Expand Up @@ -1015,12 +1014,10 @@ components:
properties:
id:
description: Order ID
allOf:
- $ref: '#/components/schemas/Id'
$ref: '#/components/schemas/Id'
petId:
description: Pet ID
allOf:
- $ref: '#/components/schemas/Id'
$ref: '#/components/schemas/Id'
quantity:
type: integer
format: int32
Expand Down Expand Up @@ -1065,12 +1062,10 @@ components:
description: "Find more info here"
url: "https://example.com"
description: Pet ID
allOf:
- $ref: '#/components/schemas/Id'
$ref: '#/components/schemas/Id'
category:
description: Categories this pet belongs to
allOf:
- $ref: '#/components/schemas/Category'
$ref: '#/components/schemas/Category'
name:
description: The name given to a pet
type: string
Expand All @@ -1087,8 +1082,7 @@ components:
type: string
format: url
friend:
allOf:
- $ref: '#/components/schemas/Pet'
$ref: '#/components/schemas/Pet'
tags:
description: Tags attached to the pet
type: array
Expand Down Expand Up @@ -1117,8 +1111,7 @@ components:
properties:
id:
description: Tag ID
allOf:
- $ref: '#/components/schemas/Id'
$ref: '#/components/schemas/Id'
name:
description: Tag name
type: string
Expand All @@ -1133,6 +1126,7 @@ components:
pet:
oneOf:
- $ref: '#/components/schemas/Pet'
title: Pettie
- $ref: '#/components/schemas/Tag'
username:
description: User supplied username
Expand Down Expand Up @@ -1179,10 +1173,9 @@ components:
content:
application/json:
schema:
allOf:
- description: My Pet
title: Pettie
- $ref: '#/components/schemas/Pet'
description: My Pet
title: Pettie
$ref: '#/components/schemas/Pet'
application/xml:
schema:
type: 'object'
Expand Down
1 change: 0 additions & 1 deletion demo/webpack.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@ export default (env: { playground?: boolean; bench?: boolean } = {}, { mode }) =

module: {
rules: [
{ enforce: 'pre', test: /\.js$/, loader: 'source-map-loader' },
{ test: [/\.eot$/, /\.gif$/, /\.woff$/, /\.svg$/, /\.ttf$/], use: 'null-loader' },
{
test: /\.tsx?$/,
Expand Down
43 changes: 31 additions & 12 deletions src/services/OpenAPIParser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ class RefCounter {
export class OpenAPIParser {
specUrl?: string;
spec: OpenAPISpec;
mergeRefs: Set<string>;

private _refCounter: RefCounter = new RefCounter();
private allowMergeRefs: boolean = false;

constructor(
spec: OpenAPISpec,
Expand All @@ -58,8 +58,7 @@ export class OpenAPIParser {
this.preprocess(spec);

this.spec = spec;

this.mergeRefs = new Set();
this.allowMergeRefs = spec.openapi.startsWith('3.1');
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Won't this break when 3.2 comes out? Should it be >=?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don' think so. OpenAPI doesn't follow semver so technically they can change the behaviour in 3.2. We'll update this when 3.2 is out.


const href = IS_BROWSER ? window.location.href : '';
if (typeof specUrl === 'string') {
Expand Down Expand Up @@ -149,7 +148,7 @@ export class OpenAPIParser {
* @param obj object to dereference
* @param forceCircular whether to dereference even if it is circular ref
*/
deref<T extends object>(obj: OpenAPIRef | T, forceCircular = false): T {
deref<T extends object>(obj: OpenAPIRef | T, forceCircular = false, mergeAsAllOf = false): T {
if (this.isRef(obj)) {
const schemaName = getDefinitionName(obj.$ref);
if (schemaName && this.options.ignoreNamedSchemas.has(schemaName)) {
Expand All @@ -165,16 +164,36 @@ export class OpenAPIParser {
return Object.assign({}, resolved, { 'x-circular-ref': true });
}
// deref again in case one more $ref is here
let result = resolved;
if (this.isRef(resolved)) {
const res = this.deref(resolved);
result = this.deref(resolved, false, mergeAsAllOf);
this.exitRef(resolved);
return res;
}
return resolved;
return this.allowMergeRefs ? this.mergeRefs(obj, resolved, mergeAsAllOf) : result;
}
return obj;
}

mergeRefs(ref, resolved, mergeAsAllOf: boolean) {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
const { $ref, ...rest } = ref;
const keys = Object.keys(rest);
if (keys.length === 0) {
return resolved;
}
if (mergeAsAllOf && keys.some((k) => k !== 'description' && k !== 'title' && k !== 'externalDocs')) {
return {
allOf: [resolved, rest],
};
} else {
// small optimization
return {
...resolved,
...rest,
};
}
}

shalowDeref<T extends object>(obj: OpenAPIRef | T): T {
if (this.isRef(obj)) {
return this.byRef<T>(obj.$ref)!;
Expand Down Expand Up @@ -225,7 +244,7 @@ export class OpenAPIParser {
return undefined;
}

const resolved = this.deref(subSchema, forceCircular);
const resolved = this.deref(subSchema, forceCircular, true);
const subRef = subSchema.$ref || undefined;
const subMerged = this.mergeAllOf(resolved, subRef, forceCircular, used$Refs);
receiver.parentRefs!.push(...(subMerged.parentRefs || []));
Expand All @@ -234,7 +253,7 @@ export class OpenAPIParser {
schema: subMerged,
};
})
.filter(child => child !== undefined) as Array<{
.filter((child) => child !== undefined) as Array<{
$ref: string | undefined;
schema: MergedOpenAPISchema;
}>;
Expand Down Expand Up @@ -265,7 +284,7 @@ export class OpenAPIParser {
{ allOf: [receiver.properties[prop], subSchema.properties[prop]] },
$ref + '/properties/' + prop,
);
receiver.properties[prop] = mergedProp
receiver.properties[prop] = mergedProp;
this.exitParents(mergedProp); // every prop resolution should have separate recursive stack
}
}
Expand Down Expand Up @@ -313,7 +332,7 @@ export class OpenAPIParser {
const def = this.deref(schemas[defName]);
if (
def.allOf !== undefined &&
def.allOf.find(obj => obj.$ref !== undefined && $refs.indexOf(obj.$ref) > -1)
def.allOf.find((obj) => obj.$ref !== undefined && $refs.indexOf(obj.$ref) > -1)
) {
res['#/components/schemas/' + defName] = [def['x-discriminator-value'] || defName];
}
Expand All @@ -339,7 +358,7 @@ export class OpenAPIParser {
const beforeAllOf = allOf.slice(0, i);
const afterAllOf = allOf.slice(i + 1);
return {
oneOf: sub.oneOf.map(part => {
oneOf: sub.oneOf.map((part) => {
const merged = this.mergeAllOf({
allOf: [...beforeAllOf, part, ...afterAllOf],
});
Expand Down
4 changes: 2 additions & 2 deletions src/services/models/Schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ export class SchemaModel {
makeObservable(this);

this.pointer = schemaOrRef.$ref || pointer || '';
this.rawSchema = parser.deref(schemaOrRef);
this.rawSchema = parser.deref(schemaOrRef, false, true);
this.schema = parser.mergeAllOf(this.rawSchema, this.pointer, isChild);

this.init(parser, isChild);
Expand Down Expand Up @@ -193,7 +193,7 @@ export class SchemaModel {

private initOneOf(oneOf: OpenAPISchema[], parser: OpenAPIParser) {
this.oneOf = oneOf!.map((variant, idx) => {
const derefVariant = parser.deref(variant);
const derefVariant = parser.deref(variant, false, true);

const merged = parser.mergeAllOf(derefVariant, this.pointer + '/oneOf/' + idx);

Expand Down
55 changes: 11 additions & 44 deletions src/utils/__tests__/__snapshots__/loadAndBundleSpec.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1864,15 +1864,9 @@ Object {
"content": Object {
"application/json": Object {
"schema": Object {
"allOf": Array [
Object {
"description": "My Pet",
"title": "Pettie",
},
Object {
"$ref": "#/components/schemas/Pet",
},
],
"$ref": "#/components/schemas/Pet",
"description": "My Pet",
"title": "Pettie",
},
},
"application/xml": Object {
Expand Down Expand Up @@ -1952,11 +1946,7 @@ Object {
"Category": Object {
"properties": Object {
"id": Object {
"allOf": Array [
Object {
"$ref": "#/components/schemas/Id",
},
],
"$ref": "#/components/schemas/Id",
"description": "Category ID",
},
"name": Object {
Expand Down Expand Up @@ -2039,19 +2029,11 @@ Object {
"type": "boolean",
},
"id": Object {
"allOf": Array [
Object {
"$ref": "#/components/schemas/Id",
},
],
"$ref": "#/components/schemas/Id",
"description": "Order ID",
},
"petId": Object {
"allOf": Array [
Object {
"$ref": "#/components/schemas/Id",
},
],
"$ref": "#/components/schemas/Id",
"description": "Pet ID",
},
"quantity": Object {
Expand Down Expand Up @@ -2096,26 +2078,14 @@ Object {
},
"properties": Object {
"category": Object {
"allOf": Array [
Object {
"$ref": "#/components/schemas/Category",
},
],
"$ref": "#/components/schemas/Category",
"description": "Categories this pet belongs to",
},
"friend": Object {
"allOf": Array [
Object {
"$ref": "#/components/schemas/Pet",
},
],
"$ref": "#/components/schemas/Pet",
},
"id": Object {
"allOf": Array [
Object {
"$ref": "#/components/schemas/Id",
},
],
"$ref": "#/components/schemas/Id",
"description": "Pet ID",
"externalDocs": Object {
"description": "Find more info here",
Expand Down Expand Up @@ -2186,11 +2156,7 @@ Object {
"Tag": Object {
"properties": Object {
"id": Object {
"allOf": Array [
Object {
"$ref": "#/components/schemas/Id",
},
],
"$ref": "#/components/schemas/Id",
"description": "Tag ID",
},
"name": Object {
Expand Down Expand Up @@ -2239,6 +2205,7 @@ Object {
"oneOf": Array [
Object {
"$ref": "#/components/schemas/Pet",
"title": "Pettie",
},
Object {
"$ref": "#/components/schemas/Tag",
Expand Down