Skip to content

refactor: OAS specification extension support using json-crawl prefix rules #21

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

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

refactor: OAS specification extension support using json-crawl prefix rules #21

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
546569a
refactor: oas specification extension support using json-crawl prefix…
b41ex Jul 3, 2025
66eca4a
chore: set feature branch version for json-crawl
b41ex Jul 3, 2025
0ad73e6
refactor: rename OAS extension rules to align with name in specification
b41ex Jul 4, 2025
4b6e096
fix: validation of complex values for specification extensions in Pat…
b41ex Jul 14, 2025
7ddf217
fix: set local rules for XML object explicitly
b41ex Jul 24, 2025
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
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"simplify"
],
"dependencies": {
"@netcracker/qubership-apihub-json-crawl": "1.0.4",
"@netcracker/qubership-apihub-json-crawl": "feature-support-oas-extension-changes-classification",
"object-hash": "3.0.0",
"fast-equals": "4.0.3"
},
Expand Down
55 changes: 27 additions & 28 deletions src/rules/openapi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,21 +244,16 @@ const OPEN_API_COMPONENTS_REPLACES: Record<string, ReplaceMapping> = {
[OPEN_API_PROPERTY_EXAMPLES]: TO_EMPTY_OBJECT_MAPPING,
}

const openApiExtensionRulesFunction: (elseRules: NormalizationRules | (() => NormalizationRules)) => NormalizationRules = (elseRules) => ({
'/*': (ctx) => {
const { key } = ctx
return typeof key === 'string' && key.startsWith('x-')
? {
isExtension: true,
validate: checkType(...TYPE_JSON_ANY),
merge: resolvers.last,
'/**': { validate: checkType(...TYPE_JSON_ANY) },
}
: typeof elseRules === 'function' ? elseRules() : elseRules
},
})

const openApiExtensionRules: NormalizationRules = openApiExtensionRulesFunction({ validate: () => false })
const openApiExtensionRules = {
'/^': {
'x-': {
isExtension: true,
validate: checkType(...TYPE_JSON_ANY),
merge: resolvers.last,
'/**': { validate: checkType(...TYPE_JSON_ANY) },
},
},
} as NormalizationRules

const openApiExternalDocsRules: NormalizationRules = {
'/externalDocs': {
Expand All @@ -282,9 +277,8 @@ const openApiExamplesRules: NormalizationRules = {
validate: checkType(TYPE_OBJECT),
merge: resolvers.last,
'/*': {
...openApiExtensionRulesFunction({
validate: checkType(...TYPE_JSON_ANY),
}),
'/*': { validate: checkType(...TYPE_JSON_ANY) },
...openApiExtensionRules,
},
'/**': { validate: checkType(...TYPE_JSON_ANY) },
},
Expand Down Expand Up @@ -362,9 +356,9 @@ const openApiJsonSchemaExtensionRules = (): NormalizationRules => ({
merge: resolvers.mergeObjects,
unify: [
valueDefaults(OPEN_API_XML_DEFAULTS),
],
...openApiExtensionRulesFunction({ validate: checkType(...TYPE_JSON_ANY) }),
],
'/**': { validate: checkType(...TYPE_JSON_ANY) },
...openApiExtensionRules,
},
'/discriminator': {
validate: checkType(TYPE_OBJECT),
Expand Down Expand Up @@ -607,7 +601,7 @@ const openApiRequestRules = (version: OpenApiSpecVersion): NormalizationRules =>
})

const openApiResponsesRules = (version: OpenApiSpecVersion): NormalizationRules => ({
...openApiExtensionRulesFunction({
'/*': {
'/description': { validate: checkType(TYPE_STRING) },
'/headers': openApiHeadersRules(version),
'/content': openApiMediaTypesRules(version),
Expand All @@ -621,7 +615,8 @@ const openApiResponsesRules = (version: OpenApiSpecVersion): NormalizationRules
deprecation: {
inlineDescriptionSuffixCalculator: ctx => `${ctx.suffix} '${ctx.key.toString()}'`,
},
}),
},
...openApiExtensionRules,
deprecation: { inlineDescriptionSuffixCalculator: () => 'in response' },
validate: checkType(TYPE_OBJECT),
})
Expand All @@ -634,7 +629,7 @@ const openApiPathItemRules = (version: OpenApiSpecVersion): NormalizationRules =
'/*': openApiServerRules,
validate: checkType(TYPE_ARRAY),
},
...openApiExtensionRulesFunction({
'/*': {
deprecation: {
deprecationResolver: (ctx) => OPEN_API_DEPRECATION_RESOLVER(ctx),
descriptionCalculator: ctx => `[Deprecated] operation ${ctx.key.toString().toUpperCase()} ${ctx.suffix}`,
Expand All @@ -648,8 +643,9 @@ const openApiPathItemRules = (version: OpenApiSpecVersion): NormalizationRules =
...openApiExternalDocsRules,
'/operationId': { validate: checkType(TYPE_STRING) },
'/callbacks': {
'/*': {
...openApiExtensionRulesFunction(() => openApiPathItemRules(version)),
'/*': {
'/*': () => openApiPathItemRules(version),
...openApiExtensionRules,
},
},
'/deprecated': { validate: checkType(TYPE_BOOLEAN) },
Expand All @@ -664,7 +660,8 @@ const openApiPathItemRules = (version: OpenApiSpecVersion): NormalizationRules =
valueReplaces(OPEN_API_OPERATION_REPLACES),
],
validate: checkType(TYPE_OBJECT),
}),
},
...openApiExtensionRules,
'/parameters': openApiParametersRules(version),
validate: checkType(TYPE_OBJECT),
unify: pathItemsUnification,
Expand Down Expand Up @@ -708,7 +705,8 @@ export const openApiRules = (version: OpenApiSpecVersion): NormalizationRules =>
validate: checkType(TYPE_ARRAY),
},
'/paths': {
...openApiExtensionRulesFunction(openApiPathItemRules(version)),
'/*': openApiPathItemRules(version),
...openApiExtensionRules,
validate: checkType(TYPE_OBJECT),
},
'/components': {
Expand Down Expand Up @@ -776,7 +774,8 @@ export const openApiRules = (version: OpenApiSpecVersion): NormalizationRules =>
'/headers': openApiHeadersRules(version),
'/callbacks': {
'/*': {
...openApiExtensionRulesFunction(() => openApiPathItemRules(version)),
'/*': () => openApiPathItemRules(version),
...openApiExtensionRules,
},
},
...openApiExamplesRules,
Expand Down