Skip to content

Commit

Permalink
Updates and fixes to API RAML, schemas and examples. (#10)
Browse files Browse the repository at this point in the history
* Fix bulkProperties endpoint definition

* Add regular expression patterns to method and property identifiers

* Fix rolePaths schemas

* Fix method and property regular expressions

* Add uriParameter for rolePath

* Fix RAML propertyId parameter definition

* Corrected "get descriptor" examples
  • Loading branch information
jonathan-r-thorpe authored Apr 30, 2024
1 parent 36c7329 commit 3c22ee6
Show file tree
Hide file tree
Showing 7 changed files with 384 additions and 368 deletions.
14 changes: 11 additions & 3 deletions APIs/ConfigurationAPI.raml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ documentation:
example: !include ../examples/rolePaths-base-get-200.json
type: !include schemas/rolePaths-base.json
/{rolePath}:
displayName: 'Attributes of a Role Path'
uriParameters:
rolePath:
type: string
get:
description: 'Get attributes of the object specified by rolePath'
responses:
Expand Down Expand Up @@ -102,7 +104,10 @@ documentation:
example: !include ../examples/methods-base-get-200.json
type: !include schemas/methods-base.json
/{methodId}:
displayName: 'Invoke Method.'
uriParameters:
methodId:
type: string
pattern: "^[0-9]+m[0-9]+"
patch:
description: 'Invoke method.'
body:
Expand Down Expand Up @@ -135,7 +140,10 @@ documentation:
example: !include ../examples/properties-base-get-200.json
type: !include schemas/properties-base.json
/{propertyId}:
displayName: 'Attributes of a Property'
uriParameters:
propertyId:
type: string
pattern: "^[0-9]+p[0-9]+"
get:
description: 'Get attributes of a Property'
responses:
Expand Down
3 changes: 2 additions & 1 deletion APIs/schemas/methods-base.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
"description": "Describes the Configuration API /rolePaths/{rolePath}/methods base",
"title": "Configuration API /rolePaths/{rolePath}/methods base",
"items": {
"type": "string"
"type": "string",
"pattern": "^[0-9]+m[0-9]+"
},
"uniqueItems": true
}
3 changes: 2 additions & 1 deletion APIs/schemas/properties-base.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
"description": "Describes the Configuration API /rolePaths/{rolePath}/properties base",
"title": "Configuration API /rolePaths/{rolePath}/properties base",
"items": {
"type": "string"
"type": "string",
"pattern": "^[0-9]+p[0-9]+"
},
"uniqueItems": true
}
4 changes: 2 additions & 2 deletions APIs/schemas/rolePath.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
"items": {
"type": "string",
"enum": [
"bulkProperties",
"descriptors/",
"bulkProperties/",
"descriptor/",
"methods/",
"properties/"
]
Expand Down
Loading

0 comments on commit 3c22ee6

Please sign in to comment.