Skip to content

Commit 5e6f0ed

Browse files
Merge branch 'v1.0-dev' into publish-backup-restore
2 parents 421ca63 + c35423a commit 5e6f0ed

7 files changed

+399
-368
lines changed

APIs/ConfigurationAPI.raml

+26-3
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ documentation:
3434
example: !include ../examples/rolePaths-base-get-200.json
3535
type: !include schemas/rolePaths-base.json
3636
/{rolePath}:
37-
displayName: 'Attributes of a Role Path'
37+
uriParameters:
38+
rolePath:
39+
type: string
3840
get:
3941
description: 'Get attributes of the object specified by rolePath'
4042
responses:
@@ -60,6 +62,11 @@ documentation:
6062
type: !include schemas/bulkProperties-get-response.json
6163
example: !include ../examples/bulkProperties-get-200.json
6264
options:
65+
description: A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes
66+
responses:
67+
200:
68+
403:
69+
patch:
6370
description: 'Validate an NcBulkValuesHolder object against the Device Model'
6471
body:
6572
type: !include schemas/bulkProperties-validate-request.json
@@ -102,7 +109,15 @@ documentation:
102109
example: !include ../examples/methods-base-get-200.json
103110
type: !include schemas/methods-base.json
104111
/{methodId}:
105-
displayName: 'Invoke Method.'
112+
uriParameters:
113+
methodId:
114+
type: string
115+
pattern: "^[0-9]+m[0-9]+"
116+
options:
117+
description: A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes
118+
responses:
119+
200:
120+
403:
106121
patch:
107122
description: 'Invoke method.'
108123
body:
@@ -135,7 +150,10 @@ documentation:
135150
example: !include ../examples/properties-base-get-200.json
136151
type: !include schemas/properties-base.json
137152
/{propertyId}:
138-
displayName: 'Attributes of a Property'
153+
uriParameters:
154+
propertyId:
155+
type: string
156+
pattern: "^[0-9]+p[0-9]+"
139157
get:
140158
description: 'Get attributes of a Property'
141159
responses:
@@ -173,6 +191,11 @@ documentation:
173191
description: 'Returned when the Property was unable to be retrieved. Corresponds to NcMethodStatus code 500.'
174192
body:
175193
type: !include schemas/ms05-error.json
194+
options:
195+
description: A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes
196+
responses:
197+
200:
198+
403:
176199
put:
177200
descriptions: 'Put value of a Property'
178201
body:

APIs/schemas/methods-base.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
"description": "Describes the Configuration API /rolePaths/{rolePath}/methods base",
55
"title": "Configuration API /rolePaths/{rolePath}/methods base",
66
"items": {
7-
"type": "string"
7+
"type": "string",
8+
"pattern": "^[0-9]+m[0-9]+"
89
},
910
"uniqueItems": true
1011
}

APIs/schemas/properties-base.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
"description": "Describes the Configuration API /rolePaths/{rolePath}/properties base",
55
"title": "Configuration API /rolePaths/{rolePath}/properties base",
66
"items": {
7-
"type": "string"
7+
"type": "string",
8+
"pattern": "^[0-9]+p[0-9]+"
89
},
910
"uniqueItems": true
1011
}

APIs/schemas/rolePath.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
"items": {
77
"type": "string",
88
"enum": [
9-
"bulkProperties",
10-
"descriptors/",
9+
"bulkProperties/",
10+
"descriptor/",
1111
"methods/",
1212
"properties/"
1313
]

0 commit comments

Comments
 (0)