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.

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

feat: add x-explicitMappingOnly extension #1215

Merged
merged 1 commit into from
Mar 27, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
34 changes: 34 additions & 0 deletions docs/redoc-vendor-extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,3 +306,37 @@ Player:
x-additionalPropertiesName: attribute-name
type: string
```

#### x-explicitMappingOnly
**ATTENTION**: This is ReDoc-specific vendor extension. It won't be supported by other tools.

Extends the `discriminator` property of the schema object.

| Field Name | Type | Description |
| :------------- | :------: | :---------- |
| x-explicitMappingOnly | boolean | limit the discriminator selectpicker to the explicit mappings only |

###### Usage in ReDoc
ReDoc uses this extension to filter the `discriminator` mappings shown in the selectpicker.
When set to `true`, the selectpicker will only list the the explicitly defined mappings. When `false`,
the default behavior is kept, i.e. explicit and implicit mappings will be shown.

###### x-explicitMappingOnly example


```yaml
Pet:
type: object
required:
- name
- photoUrls
discriminator:
propertyName: petType
x-explicitMappingOnly: true
mapping:
cat: "#/components/schemas/Cat"
bee: "#/components/schemas/HoneyBee"
```

Will show in the selectpicker only the items `cat` and `bee`, even though the `Dog` class inherits from
the `Pet` class.
11 changes: 10 additions & 1 deletion src/services/models/Schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,15 @@ export class SchemaModel {
}

const mapping = discriminator.mapping || {};

// Defines if the mapping is exhaustive. This avoids having references
// that overlap with the mapping entries
let isLimitedToMapping = discriminator['x-explicitMappingOnly'] || false;
// if there are no mappings, assume non-exhaustive
if (Object.keys(mapping).length === 0) {
isLimitedToMapping = false;
}

const explicitInversedMapping = {};
for (const name in mapping) {
const $ref = mapping[name];
Expand All @@ -252,7 +261,7 @@ export class SchemaModel {
}
}

const inversedMapping = { ...implicitInversedMapping, ...explicitInversedMapping };
const inversedMapping = isLimitedToMapping ? { ...explicitInversedMapping } : { ...implicitInversedMapping, ...explicitInversedMapping };

const refs: Array<{ $ref; name }> = [];

Expand Down
1 change: 1 addition & 0 deletions src/types/open-api.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ export interface OpenAPISchema {
export interface OpenAPIDiscriminator {
propertyName: string;
mapping?: { [name: string]: string };
'x-explicitMappingOnly'?: boolean;
}

export interface OpenAPIMediaType {
Expand Down
1 change: 1 addition & 0 deletions src/utils/openapi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -579,6 +579,7 @@ export function isRedocExtension(key: string): boolean {
'x-tagGroups': true,
'x-traitTag': true,
'x-additionalPropertiesName': true,
'x-explicitMappingOnly': true,
};

return key in redocExtensions;
Expand Down