Update API schema to correct which are required - Githubissues

Police-Data-Accessibility-Project / data-sources-app

An API and UI for using and maintaining the Data Sources database

MIT License

4 stars 5 forks source link

Update API schema to correct which are required #495

Closed maxachis closed 2 weeks ago

maxachis commented 3 weeks ago

Context

Currently, some of the API schemas are incorrect in terms of which parameters are specified as required

For example, /data-sources PUT lists agency_originated as a required attribute, when it is not.

Requirements

Correct the API schemas to properly indicate which keys are required and which are not.

Tests

Tests should continue to pass as they currently do.

Docs

API docs will need updated.

Open questions

In some cases, there may be ambiguity as to whether something is required; if such cases occur, clarification will be needed.