Add /all endpoint documentation #45
Conversation
| tags: | ||
| - All | ||
| summary: /all | ||
| description: Returns a paginated list of our non-catalogue content, i.e. (articles, books, events, exhibitions, exhibition texts, exhibition highlight tours (BSL), exhibition highlight tours (audio), pages, projects, seasons, and visual stories) |
There was a problem hiding this comment.
Could we/should we reference Addressables? I guess people using the API don't really care about that as it's pipeline side...
| required: | ||
| - type | ||
| - uid | ||
| - title | ||
| - description |
There was a problem hiding this comment.
Looking at the type here, uid and description are optional, id should be required (I think?), same for all content types
There was a problem hiding this comment.
Shouldn't uid be required though? It's a required field in Prismic and we will rely on it for constructing links
There was a problem hiding this comment.
I can't remember 100% why we made it optional, but we did see instances of it missing it, although it shouldn't really happen anymore. Should we change the type then?
| - uid | ||
| - title | ||
| - description | ||
| - times |
There was a problem hiding this comment.
Times is optional in the content api types
| properties: | ||
| type: | ||
| type: string | ||
| description: |
There was a problem hiding this comment.
Is description required if empty?
There was a problem hiding this comment.
Also I know we haven't done that in the other bits of docs, but should we say the type is "Season" (as it's hard coded?)
What does this change?
For #43
N.B. The content.yaml is getting a bit unwieldy. I did attempt to break the file up and make bits reusable, but I ran into a bug with swagger where it only seems to recognise the first external file used in a $ref. Rather than waste any more time on it I ended up just editing the content.yaml file, but we may want to revisit this again in the future.
How to test
You can run this locally with
yarn start, and look at the new docsHow can we measure success?
It's up to date and useful for anyone we might onboard.
Have we considered potential risks?
N/A