As a metadata user, I'd like a JSON output schema for the REST API
As part of our internal snapshots validation meeting on 2020 August 25, we discussed implementing upstream checks based on a JSON output schema post elasticsearch cutover. This issue will focus on the schema portion of that work.
We also have previous user requests for a JSON output schema:
From the Ask me Anything webinar on 27 Feb 2020 and Zendesk ticket 162436:
I was wondering if you could perhaps provide json-schema files for the items returned by the public/polite API?
This is not the first time this has been requested, so creating a formal request here. Patricia also mentioned it at our recent Outreach meeting and said we could and should improve the documentation and/or provide the json-schema file, as requested here.
Definition of done
Available via a staging URL
Unit tests identified, implemented, and passing
Public documentation reviewed and updated
Knowledge base reviewed and updated
Acceptance criteria met
- [ ]
Prior to and during Backlog Refinement, consider the potential impacts this user story may have on the following areas:
- Internal documentation
- External documentation
- Support & Membership experience
- Outreach & Communications
- Metrics, analytics, reporting
Additional details about the above items can be found here.