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.
* Add bulkProperties endpoints * Suggested alternative bulkProperties endpoint * Added schemas for bulkProperties endpoints * Removed examples from bulkProperties * formatting * ...formatting * ......formatting * typos * Updated bulkProperties endpoint * Fixed example paths * Updated rolePath schema. Ordered RAML endpoints alphabetically. * Updated method patch example * Tweaked property endpoint schema and example
- Loading branch information
1 parent
e80ae6f
commit 8be227e
Showing
16 changed files
with
321 additions
and
73 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
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,6 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-04/schema#", | ||
| "type": "object", | ||
| "description": "Returns a NcMethodResultBulkValuesHolder from a bulkProperties GET", | ||
| "title": "NcMethodResultBulkValuesHolder" | ||
| } |
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,15 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-04/schema#", | ||
| "type": "object", | ||
| "description": "PUT request body for invoking SetPropertiesByPaths method on NcBulkPropertiesManager", | ||
| "title": "SetPropertiesByPaths", | ||
| "required": [ | ||
| "arguments" | ||
| ], | ||
| "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. 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,6 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-04/schema#", | ||
| "type": "object", | ||
| "description": "Returns a NcMethodResultObjectPropertiesSetValidation from a bulkProperties PUT", | ||
| "title": "NcMethodResultObjectPropertiesSetValidation" | ||
| } |
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,15 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-04/schema#", | ||
| "type": "object", | ||
| "description": "PATCH request body for validating NcBulkValuesHolder object.", | ||
| "title": "ValidateSetPropertiesByPaths", | ||
| "required": [ | ||
| "arguments" | ||
| ], | ||
| "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. 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,6 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-04/schema#", | ||
| "type": "object", | ||
| "description": "Returns a NcMethodResultObjectPropertiesSetValidation from a bulkProperties OPTIONS", | ||
| "title": "NcMethodResultObjectPropertiesSetValidation" | ||
| } |
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
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,29 @@ | ||
| { | ||
| "status": 200, | ||
| "validationFingerprint": null, | ||
| "values": [ | ||
| { | ||
| "rolePath": [ "root", "stereo-gain" ], | ||
| "values": [ | ||
| { | ||
| "id": { | ||
| "level": 1, | ||
| "index": 6 | ||
| }, | ||
| "name": "userLabel", | ||
| "isReadOnly": false, | ||
| "value": "this is the property value" | ||
| }, | ||
| { | ||
| "id": { | ||
| "level": 2, | ||
| "index": 1 | ||
| }, | ||
| "name": "enabled", | ||
| "isReadOnly": false, | ||
| "value": true | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } |
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,14 @@ | ||
| { | ||
| "value": [ | ||
| { | ||
| "rolePath": [ "root", "stereo-gain" ], | ||
| "status": 200, | ||
| "statusMessage": "OK" | ||
| }, | ||
| { | ||
| "rolePath": [ "root", "channel-gain" ], | ||
| "status": 200, | ||
| "statusMessage": "OK" | ||
| } | ||
| ] | ||
| } |
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,56 @@ | ||
| { | ||
| "arguments": { | ||
| "dataSet": { | ||
| "validationFingerprint": null, | ||
| "values": [ | ||
| { | ||
| "rolePath": [ "root", "stereo-gain" ], | ||
| "values": [ | ||
| { | ||
| "id": { | ||
| "level": 1, | ||
| "index": 6 | ||
| }, | ||
| "name": "userLabel", | ||
| "isReadOnly": false, | ||
| "value": "Stereo Gain Block" | ||
| }, | ||
| { | ||
| "id": { | ||
| "level": 2, | ||
| "index": 1 | ||
| }, | ||
| "name": "enabled", | ||
| "isReadOnly": false, | ||
| "value": true | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "rolePath": [ "root", "channel-gain" ], | ||
| "values": [ | ||
| { | ||
| "id": { | ||
| "level": 1, | ||
| "index": 6 | ||
| }, | ||
| "name": "userLabel", | ||
| "isReadOnly": false, | ||
| "value": "Channel Gain Block" | ||
| }, | ||
| { | ||
| "id": { | ||
| "level": 2, | ||
| "index": 1 | ||
| }, | ||
| "name": "enabled", | ||
| "isReadOnly": false, | ||
| "value": true | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "recurse": false | ||
| } | ||
| } |
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,14 @@ | ||
| { | ||
| "value": [ | ||
| { | ||
| "rolePath": [ "root", "stereo-gain" ], | ||
| "status": 200, | ||
| "statusMessage": "OK" | ||
| }, | ||
| { | ||
| "rolePath": [ "root", "channel-gain" ], | ||
| "status": 200, | ||
| "statusMessage": "OK" | ||
| } | ||
| ] | ||
| } |
Oops, something went wrong.