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 schema support for "example" annotations #3031

Merged
merged 1 commit into from
Sep 17, 2024

Conversation

danielsharvey
Copy link
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Other... Please describe:

What is the current behavior?

Currently, the example annotation is not correctly copied into the schema object.

See https://swagger.io/docs/specification/adding-examples/.

Refer to:

private getSchemaOptions(param: Record<string, any>): Partial<SchemaObject> {
const schemaKeys = this.getSchemaOptionsKeys();
const optionsObject: Partial<SchemaObject> = schemaKeys.reduce(
(acc, key) => ({
...acc,
[key]: param[key]
}),
{}
);
return omitBy(optionsObject, isUndefined);
}

and
private getSchemaOptionsKeys(): Array<keyof SchemaObject> {
return [
'properties',
'patternProperties',
'additionalProperties',
'minimum',
'maximum',
'maxProperties',
'minItems',
'minProperties',
'maxItems',
'minLength',
'maxLength',
'exclusiveMaximum',
'exclusiveMinimum',
'uniqueItems',
'title',
'format',
'pattern',
'nullable',
'default'
];

Issue Number: N/A

What is the new behavior?

Example annotations/properties are now correctly copied.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@kamilmysliwiec kamilmysliwiec merged commit 391abb3 into nestjs:master Sep 17, 2024
1 check passed
@kamilmysliwiec
Copy link
Member

lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants