diff options
Diffstat (limited to 'cps-rest/docs/openapi')
| -rw-r--r-- | cps-rest/docs/openapi/components.yml | 44 | ||||
| -rw-r--r-- | cps-rest/docs/openapi/cpsAdmin.yml | 22 |
2 files changed, 62 insertions, 4 deletions
diff --git a/cps-rest/docs/openapi/components.yml b/cps-rest/docs/openapi/components.yml index 5a21a730e..a337a244b 100644 --- a/cps-rest/docs/openapi/components.yml +++ b/cps-rest/docs/openapi/components.yml @@ -1,5 +1,20 @@ components: schemas: + + AnchorDetails: + type: object + title: Anchor details by anchor Name + properties: + name: + type: string + example: my_anchor + dataspaceName: + type: string + example: my_dataspace + schemaSetName: + type: string + example: my_schema_set + ErrorMessage: type: object title: Error @@ -24,6 +39,35 @@ components: format: binary example: http://example.com/examples/example.yang + ModuleReferences: + type: object + title: Module reference object + properties: + name: + type: string + example: module_reference_name + namespace: + type: string + example: module_reference_namespace + revision: + type: string + example: module_reference_revision + + SchemaSetDetails: + type: object + title: Schema set details by dataspace and schemasetName + properties: + dataspaceName: + type: string + example: my_dataspace + moduleReferences: + type: array + items: + $ref: '#/components/schemas/ModuleReferences' + name: + type: string + example: my_schema_set + parameters: dataspaceNameInQuery: name: dataspace-name diff --git a/cps-rest/docs/openapi/cpsAdmin.yml b/cps-rest/docs/openapi/cpsAdmin.yml index cf2629928..1a2e65f7d 100644 --- a/cps-rest/docs/openapi/cpsAdmin.yml +++ b/cps-rest/docs/openapi/cpsAdmin.yml @@ -78,7 +78,11 @@ schemaSetBySchemaSetName: - $ref: 'components.yml#/components/parameters/schemaSetNameInPath' responses: '200': - $ref: 'components.yml#/components/responses/Ok' + description: OK + content: + application/json: + schema: + $ref: 'components.yml#/components/schemas/SchemaSetDetails' '400': $ref: 'components.yml#/components/responses/BadRequest' '401': @@ -120,7 +124,13 @@ anchorsByDataspace: - $ref: 'components.yml#/components/parameters/dataspaceNameInPath' responses: '200': - $ref: 'components.yml#/components/responses/Ok' + description: OK + content: + application/json: + schema: + type: array + items: + $ref: 'components.yml#/components/schemas/AnchorDetails' '400': $ref: 'components.yml#/components/responses/BadRequest' '401': @@ -162,7 +172,11 @@ anchorByDataspaceAndAnchorName: - $ref: 'components.yml#/components/parameters/anchorNameInPath' responses: '200': - $ref: 'components.yml#/components/responses/Ok' + description: OK + content: + application/json: + schema: + $ref: 'components.yml#/components/schemas/AnchorDetails' '400': $ref: 'components.yml#/components/responses/BadRequest' '401': @@ -189,4 +203,4 @@ anchorByDataspaceAndAnchorName: '401': $ref: 'components.yml#/components/responses/Unauthorized' '403': - $ref: 'components.yml#/components/responses/Forbidden' + $ref: 'components.yml#/components/responses/Forbidden'
\ No newline at end of file |