Skip to content

Update API Docs and test to show that "optional" takes precedence over "partial" #3370

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

Merged
nabdelgadir merged 2 commits into from
Jul 16, 2019
Merged

Update API Docs and test to show that "optional" takes precedence over "partial" #3370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a47629
test(repository-json-schema): make optional option override partial w…
nabdelgadir Jul 16, 2019
87cac42
docs(repository-json-schema): update API docs to show optional option…
nabdelgadir Jul 16, 2019
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
13 changes: 10 additions & 3 deletions packages/repository-json-schema/src/__tests__/integration/build-schema.integration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1049,20 +1049,27 @@ describe('build-schema', () => {
expect(optionalNothingSchema.title).to.equal('Product');
});

it('overrides "partial" option when "optional" options is set', () => {
it('overrides "partial" option when "optional" option is set', () => {
const originalSchema = getJsonSchema(Product);
expect(originalSchema.required).to.deepEqual(['id', 'name']);
expect(originalSchema.title).to.equal('Product');

const optionalNameSchema = getJsonSchema(Product, {
let optionalNameSchema = getJsonSchema(Product, {
partial: true,
optional: ['name'],
});
expect(optionalNameSchema.required).to.deepEqual(['id']);
expect(optionalNameSchema.title).to.equal('ProductOptional[name]');

optionalNameSchema = getJsonSchema(Product, {
partial: false,
optional: ['name'],
});
expect(optionalNameSchema.required).to.deepEqual(['id']);
expect(optionalNameSchema.title).to.equal('ProductOptional[name]');
});

it('uses "partial" option, if provided, when "optional" options is set but empty', () => {
it('uses "partial" option, if provided, when "optional" option is set but empty', () => {
const originalSchema = getJsonSchema(Product);
expect(originalSchema.required).to.deepEqual(['id', 'name']);
expect(originalSchema.title).to.equal('Product');
Expand Down
6 changes: 4 additions & 2 deletions packages/repository-json-schema/src/build-schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ export interface JsonSchemaOptions<T extends object> {

/**
* Set this flag to mark all model properties as optional. This is typically
* used to describe request body of PATCH endpoints.
* used to describe request body of PATCH endpoints. This option will be
* overridden by the "optional" option if it is set and non-empty.
*/
partial?: boolean;

Expand All @@ -36,7 +37,8 @@ export interface JsonSchemaOptions<T extends object> {
exclude?: (keyof T)[];

/**
* List of model properties to mark as optional.
* List of model properties to mark as optional. Overrides the "partial"
* option if it is not empty.
*/
optional?: (keyof T)[];

Expand Down