Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Further conformance language tweaks and clarifications #25

Open
wants to merge 13 commits into
base: v1.0-dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions APIs/ConfigurationAPI.raml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ documentation:
/rolePaths:
displayName: 'Role Paths'
get:
description: 'Returns the Role Paths of the Device Model. Each rolePath MUST be created by appending NcObject roles starting with the root block and using "." as the delimiter'
description: 'Returns the Role Paths of the Device Model. Each rolePath is created by appending NcObject roles starting with the root block and using "." as the delimiter'
responses:
200:
body:
Expand Down Expand Up @@ -89,7 +89,7 @@ documentation:
/descriptor:
displayName: 'Class Descriptor'
get:
description: 'Get MS-05 Class Descriptor of this object. This descriptor MUST include all inherited elements'
description: 'Get MS-05 Class Descriptor of this object. This descriptor includes all inherited elements'
responses:
200:
body:
Expand All @@ -102,7 +102,7 @@ documentation:
/methods:
displayName: 'Methods'
get:
description: 'Get Methods of this object. This response MUST include all object methods including all the inherited methods'
description: 'Get Methods of this object. This response includes all object methods including all the inherited methods'
responses:
200:
body:
Expand Down Expand Up @@ -143,7 +143,7 @@ documentation:
/properties:
displayName: 'Properties'
get:
description: 'Get Properties of the object. This response MUST include all object properties including all the inherited properties'
description: 'Get Properties of the object. This response includes all object properties including all the inherited properties'
responses:
200:
body:
Expand Down
2 changes: 1 addition & 1 deletion APIs/schemas/method-patch-request.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"properties": {
"arguments": {
"type": "object",
"description": "Method arguments. Arguments are specified as nested properties inside this object and their types are dictated by the specific MS-05-02 model for the method targeted. For methods which do not have arguments defined the object MUST be an empty object."
"description": "Method arguments. Arguments are specified as nested properties inside this object and their types are dictated by the specific MS-05-02 model for the method targeted. For methods which do not have arguments defined the object is an empty object."
}
}
}
4 changes: 2 additions & 2 deletions APIs/schemas/ms05-error.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"description": "NcMethodResultError",
"title": "NcMethodResultError"
"description": "Object of type NcMethodResultError or a type derived from NcMethodResultError",
"title": "Request error"
}
6 changes: 3 additions & 3 deletions docs/APIs.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ Human-readable information can be provided, for example, via the IS-04 Device `l
All public APIs are versioned as follows:

* Requesting the API base resource (such as http(s)://<ip address or hostname>:<port>/x-nmos/configuration/) will provide a list containing the versions of the API present on the Node.
* A versioned API response must include only resources which match the schema for that API version.
* Data which is held for mismatched minor API versions may be returned if it can be conformed to the correct schema (see example below). Data must never be conformed between major API versions.
* A versioned API response MUST include only resources which match the schema for that API version.
* Data which is held for mismatched minor API versions may be returned if it can be conformed to the correct schema (see example below). Data MUST never be conformed between major API versions.

#### Versioning Example

Expand Down Expand Up @@ -107,4 +107,4 @@ In order to overcome shortcomings in some common libraries, the following requir

The NMOS APIs use HTTP status codes to indicate success, failure and other cases to clients as per [RFC 7231](https://tools.ietf.org/html/rfc7231) and related standards.
Where the RAML specification of an API specifies explicit response codes it is expected that a client will handle these cases in a particular way.
As explicit handling of every possible HTTP response code is not expected, clients must instead implement more generic handling for ranges of response codes (1xx, 2xx, 3xx, 4xx and 5xx).
As explicit handling of every possible HTTP response code is not expected, clients MUST instead implement more generic handling for ranges of response codes (1xx, 2xx, 3xx, 4xx and 5xx).
135 changes: 65 additions & 70 deletions docs/Backup & restore.md

Large diffs are not rendered by default.

Binary file added docs/images/modify-restore.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/rebuild-restore.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/restoring_on_dynamic_spare.png
Binary file not shown.
Binary file removed docs/images/restoring_on_fixed_spare.png
Binary file not shown.
Binary file removed docs/images/validating-full-backup.png
Binary file not shown.