Skip to content

Commit

Permalink
Merge branch 'v1.0-dev' into publish-jrt
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathan-r-thorpe committed Mar 7, 2024
2 parents 58cadbf + e80ae6f commit 123c133
Show file tree
Hide file tree
Showing 10 changed files with 37 additions and 137 deletions.
10 changes: 5 additions & 5 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'
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'
responses:
200:
body:
Expand Down Expand Up @@ -63,7 +63,7 @@ documentation:
/properties:
displayName: 'Properties'
get:
description: 'Get Properties of the object'
description: 'Get Properties of the object. This response MUST include all object properties including all the inherited properties'
responses:
200:
body:
Expand Down Expand Up @@ -112,7 +112,7 @@ documentation:
/descriptor:
displayName: 'Datatype Descriptor of property'
get:
description: 'Get MS-05 Datatype Descriptor of property'
description: 'Get MS-05 Datatype Descriptor of property. This descriptor MUST include all inherited elements'
responses:
200:
body:
Expand All @@ -125,7 +125,7 @@ documentation:
/methods:
displayName: 'Methods'
get:
description: 'Get Methods of this object.'
description: 'Get Methods of this object. This response MUST include all object methods including all the inherited methods'
responses:
200:
body:
Expand Down Expand Up @@ -158,7 +158,7 @@ documentation:
/descriptor:
displayName: 'Class Descriptor'
get:
description: 'Get MS-05 Class Descriptor of this object.'
description: 'Get MS-05 Class Descriptor of this object. This descriptor MUST include all inherited elements'
responses:
200:
body:
Expand Down
24 changes: 2 additions & 22 deletions APIs/schemas/method-patch-request.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,12 @@
"description": "PATCH request body for invoking a method",
"title": "Invoke method body",
"required": [
"methodId"
"arguments"
],
"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."
"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."
}
}
}
138 changes: 29 additions & 109 deletions docs/API requests.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Transport and message encoding.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Transport and message encoding

Implementations MUST use `HTTP` as the communication transport.
Implementations MUST use `HTTP` or `HTTPS` as the communication transport.

Implementations MUST use `JSON` as the message encoding data format.
Binary file modified docs/images/getting-a-property.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/getting-block-members.png
Binary file not shown.
Binary file modified docs/images/getting-class-descriptor.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 modified docs/images/getting-datatype-descriptor.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 modified docs/images/invoking-a-method.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 modified docs/images/putting-a-property.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 123c133

Please sign in to comment.