generated from AMWA-TV/is-template
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from AMWA-TV/publish-CR
Initial content
- Loading branch information
Showing
18 changed files
with
365 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
{ | ||
"$schema": "http://json-schema.org/draft-04/schema#", | ||
"type": "object", | ||
"description": "PATCH request body for invoking a method", | ||
"title": "Invoke method body", | ||
"required": [ | ||
"methodId" | ||
], | ||
"properties": { | ||
"methodId": { | ||
"type": "object", | ||
"description": "ID structure for the target method", | ||
"required": [ | ||
"level", | ||
"index" | ||
], | ||
"properties": { | ||
"level": { | ||
"type": "integer", | ||
"description": "Level component of the method ID", | ||
"minimum": 1 | ||
}, | ||
"index": { | ||
"type": "integer", | ||
"description": "Index component of the method ID", | ||
"minimum": 1 | ||
} | ||
} | ||
}, | ||
"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. Arguments only need to be included for methods which have arguments and MUST be omitted if the method does not require any arguments." | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
{ | ||
"$schema": "http://json-schema.org/draft-04/schema#", | ||
"type": "object", | ||
"description": "PUT request body for modyfing a property", | ||
"title": "Modify property body", | ||
"required": [ | ||
"value" | ||
], | ||
"properties": { | ||
"value": { | ||
"description": "New property value. The actual type is determined by the property's MS-05-02 datatype.", | ||
"anyOf": [ | ||
{ | ||
"type": "string" | ||
}, | ||
{ | ||
"type": "number" | ||
}, | ||
{ | ||
"type": "integer" | ||
}, | ||
{ | ||
"type": "object" | ||
}, | ||
{ | ||
"type": "array" | ||
}, | ||
{ | ||
"type": "boolean" | ||
}, | ||
{ | ||
"type": "null" | ||
} | ||
] | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Data type marshalling | ||
|
||
| Type | JSON representation | | ||
| ---------------------------- | ---------------------------------------- | | ||
| enums | Integer associated enum value | | ||
| NcString | string | | ||
| NcBoolean | boolean | | ||
| NcInt16 | number | | ||
| NcInt32 | number | | ||
| NcInt64 | number | | ||
| NcUint16 | number (must be unsigned) | | ||
| NcUint32 | number (must be unsigned) | | ||
| NcUint64 | number (must be unsigned) | | ||
| NcFloat32 | number (must be floating point) | | ||
| NcFloat64 | number (must be floating point) | | ||
| struct types | object | | ||
| sequences of primitive types | array of primitive types | | ||
| sequences of struct types | array of objects | | ||
|
||
For specific datatype definitions consult the [NMOS Control Framework](https://specs.amwa.tv/ms-05-02/latest/docs/Framework.html#datatypes). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Getting block members | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# IS-04 interactions | ||
|
||
The API availability MUST be advertised through existing IS-04 practices inside the controls array of an NMOS Device. Devices MUST include the `urn:x-nmos:control:configuration` control type. | ||
|
||
```json | ||
{ | ||
... | ||
"senders": [ | ||
"a65c15a4-a52e-4960-8cd2-e05c31196e5f", | ||
"68f519a3-5523-4b2c-b72d-ec23cc80207d" | ||
], | ||
"receivers": [ | ||
"8a7bb1c1-4a82-4fd9-a4fb-96f68f560831", | ||
"ab450c07-ce54-44da-9ea9-c3e62e7b06d0" | ||
], | ||
"controls": [ | ||
{ | ||
"type": "urn:x-nmos:control:configuration/v1.0", | ||
"href": "http://192.168.10.3/x-nmos/configuration/v1.0/" | ||
} | ||
], | ||
"tags": {}, | ||
"type": "urn:x-nmos:device:generic", | ||
"label": "NMOS Device", | ||
"version": "1529676926:000000000", | ||
"node_id": "d1713110-7343-4d9e-b3f4-456c8f6ce765", | ||
"id": "58f6b536-ca4c-43fd-880a-9df2501fc125", | ||
"description": "NMOS Device" | ||
... | ||
} | ||
``` | ||
|
||
A given instance of the Configuration API MAY offer control of multiple Devices in a Node from a single URI. Alternatively there MAY be multiple instances of the API on one Node, for example, each corresponding to one Device. | ||
In either case, the ‘control’ endpoint for each Device’s Configuration API instance MUST be advertised, even if the URI is the same. | ||
|
||
This flexibility is to accommodate different relationships between Devices and Nodes. For example, some Devices may be loosely coupled to the Node, for example cards in a card frame. | ||
These Devices are more likely to have an instance of the API for each card. | ||
Others may be tightly coupled, for example a media processing pipeline on a server, where it is likely to be preferable to have one instance of the API that is advertised for each pipeline. | ||
|
||
`TODO`: decide on `href` format and trailing slashes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,15 @@ | ||
### Introduction | ||
|
||
- [Overview](Overview.md) | ||
|
||
### Specification | ||
|
||
- [Transport and message encoding](Transport%20and%20message%20encoding.md) | ||
- [Security and authorization](Security%20and%20authorization.md) | ||
- [API requests](API%20requests.md) | ||
- [Data type marshalling](Data%20type%20marshalling.md) | ||
- [IS-04 interactions](IS-04%20interactions.md) | ||
|
||
### Examples | ||
|
||
- [Getting block members](Getting%20block%20members.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Security and authorization | ||
|
||
Authorization and transport security features described in the BCP-03-XX suite and in IS-10 are used to secure and authorize this protocol. | ||
|
||
The relevant documents can be found here: | ||
|
||
- [AMWA BCP-003-01 Secure Communication in NMOS Systems](https://specs.amwa.tv/bcp-003-01) | ||
- [AMWA BCP-003-02 Authorization in NMOS Systems](https://specs.amwa.tv/bcp-003-02) | ||
- [AMWA BCP-003-03 Certificate Provisioning in NMOS Systems](https://specs.amwa.tv/bcp-003-03) | ||
- [AMWA IS-10 NMOS Authorization Specification](https://specs.amwa.tv/is-10) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Transport and message encoding | ||
|
||
Implementations MUST use `HTTP` as the communication transport. | ||
|
||
Implementations MUST use `JSON` as the message encoding data format. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters