Skip to content

Commit

Permalink
Fix schema description
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathan-r-thorpe committed Nov 26, 2024
1 parent c4f6f2a commit b59e2be
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/APIs.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Examples of JSON format output are provided in the [examples](../examples/) fold
## API Validation

JSON schemas are included with the RAML API definitions.
These include validation for values used within the APIs.
These schemas validate the communication with the API.
It is strongly recommended that implementers of a Configuration API use these JSON schemas as part of a validation stage when receiving interactions from clients.
Invalid payloads should cause a 400 HTTP error (Bad Request) to be returned to the client.
MS-05 datatypes referenced in the schemas are defined in the [MS-05-02 specification](https://specs.amwa.tv/ms-05-02/branches/v1.0.x/models/datatypes/) and in the [NMOS Feature Sets Register](https://specs.amwa.tv/nmos-control-feature-sets/branches/publish-device-configuration/device-configuration/).

### Content Types

Expand Down

0 comments on commit b59e2be

Please sign in to comment.