III-4595 Shared models for common property schemas #102

bertramakers · 2022-02-21T15:27:34Z

Added

Added multiple schemas for common properties like name, address, description, priceInfo, bookingInfo, contactPoint, ...

Changed

Schemas from event, place, organizer now mostly use $refs to common schemas unless for very specific properties that are only available on one resource or deviate from other resources (for example terms.domain enum values is different on events vs places)
Marked read-only properties as readOnly
Marked internal schemas as x-internal: true

Fixed

name on priceInfo is now required for the tariff category
copyrightHolder on event.videos and place.videos now has the correct min/max length (2-250 vs 3-...)
copyrightHolder on organizer.images now has the correct min/max length (2-250 vs 3-...)
Added missing geo property to organizer
Fixed event.location, event.organizer, and place.organizer references
Occurrences of f.e. with e.g.

Note: We cannot mark readOnly properties as required at the moment (to indicate that they will always be included in responses), because if we do the opis/json-schema validator will throw an error that the properties are missing if they are not included in request bodies. I've opened an issue for that here: opis/json-schema#104

Ticket: https://jira.uitdatabank.be/browse/III-4595

Since a $ref can only be overwritten with a new description

This makes the validation of incoming requests fail if they are missing these, which should not be required when writing

…rmat, but the data is not

bertramakers added 30 commits February 21, 2022 15:46

Extract address property schema to shared files

a05caac

Extract name property schema to shared files

18c8a88

Use shared name schema in organizer-name-put.json

f234fcb

Use shared name and address schemas in organizer-post-deprecated.json

c6d8db7

Add required fields to common-address-localized

6cbb556

Extract description property schema to shared files

190469b

Extract mainLanguage property schema to shared file

d1b21d4

Fix incorrect $ref

af16268

Extract uri format property schemas to shared files

3bd861d

Make touched schemas for request bodies internal

4e2cf43

Move newsArticle.post examples from properties to object

9376427

Fix organizer-reference.json example and format

1b6910b

Add example to newsArticle.json

2b16386

Fix syntax errors

90d3a4b

Fix readOnly / required on uri properties

e0472be

Make sure readOnly: true works for read-only URIs

9bbe909

Since a $ref can only be overwritten with a new description

Don't make read-only mediaObject/images properties required

8de2c3a

This makes the validation of incoming requests fail if they are missing these, which should not be required when writing

Extract completedLanguages and languages property schemas to shared file

d855491

Reword description to make it clearer that this schema is a legacy fo…

0d83dc7

…rmat, but the data is not

Extract contactPoint property schemas to shared files

6e08209

Extracted created/modified property schemas to shared files

81cd7ce

Extract creator property schema to shared file

fb1e5bf

Extract label properties schemas to shared files

f57e86b

Use common-uri.json in organizer-mainImage.json

3e0b18f

Extract workflowStatus property schema for offers to shared file

1cae9f9

Remove singular "example" from @id properties

32a3ca9

Extract availableFrom/To property schemas to shared files

cf0e0eb

Extract bookingAvailability property schema to shared file

11af605

Extract bookingInfo property schema to shared file

2c6848b

Extract startDate/endDate property schema to shared file

544f18c

bertramakers added 24 commits March 1, 2022 10:36

Fix broken link in $ref

f82d979

Extract priceInfo property schema to shared file

8a93d60

Also make $.priceInfo[*].name required

478b495

Use shared priceInfo schema

02af61c

Fix other broken $ref

3cf5a41

Only make name required for tariff category

069b952

Fix priceInfo name property schema

fc7c6dc

Remove trailing comma

87c82d1

Extract sameAs property schema to shared file

93b885f

Extract status property schema to shared file

74c2413

Extract typicalAgeRange property schema to shared file

3384025

Extracted video schemas to shared files

0a589ba

Re-use common schemas

fada3eb

Replace usages of format: uuid

c54113b

Small optimizations

95d1fc4

Fix broken $ref

0a669e3

Improve place.organizer documentation

76c9af9

Improve event.organizer documentation

0fd361d

Improve event location to use a reference

90fe6e6

Merge branch 'unreleased' into III-4595-models-for-properties

92f70e1

Use existing $refs in place-post-deprecated

208fbcb

Remove type.label and type.domain in place-post-deprecated.json

424553c

Remove test link to other endpoint from older PR

7e3a3db

Replace f.e. with e.g.

6579c45

bertramakers mentioned this pull request Mar 2, 2022

III-4595 Schema updates and small fixes cultuurnet/udb3-backend#941

Merged

bertramakers marked this pull request as ready for review March 2, 2022 12:58

bertramakers requested a review from LucWollants as a code owner March 2, 2022 12:58

LucWollants approved these changes Mar 3, 2022

View reviewed changes

bertramakers merged commit b04aff6 into unreleased Mar 3, 2022

bertramakers deleted the III-4595-models-for-properties branch March 3, 2022 14:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

III-4595 Shared models for common property schemas #102

III-4595 Shared models for common property schemas #102

bertramakers commented Feb 21, 2022 •

edited

Loading

III-4595 Shared models for common property schemas #102

III-4595 Shared models for common property schemas #102

Conversation

bertramakers commented Feb 21, 2022 • edited Loading

Added

Changed

Fixed

bertramakers commented Feb 21, 2022 •

edited

Loading