summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorniamhcore <niamh.core@est.tech>2021-08-11 16:13:53 +0100
committerniamhcore <niamh.core@est.tech>2021-08-18 10:34:58 +0100
commit577efb09a39282c608b53a3099b7edc95954f9c2 (patch)
treeefc72509fd6b46c296446ef3958db2b594979751 /docs
parente398be5923a47650b109512c795244cdc2b5eb10 (diff)
Transform module information from NetConf node to Generic format for NCMP
Issue-ID: CPS-531 Signed-off-by: niamhcore <niamh.core@est.tech> Change-Id: I918be4db5066d92b23e25fc7fbc22d4535fafc8c
Diffstat (limited to 'docs')
-rw-r--r--docs/openapi/components.yml15
-rw-r--r--docs/openapi/openapi.yml24
2 files changed, 24 insertions, 15 deletions
diff --git a/docs/openapi/components.yml b/docs/openapi/components.yml
index 05f1ac06..3d8aa2cf 100644
--- a/docs/openapi/components.yml
+++ b/docs/openapi/components.yml
@@ -43,6 +43,21 @@ components:
type: string
example: system-001
+ ModuleSet:
+ type: object
+ properties:
+ schemas:
+ type: array
+ items:
+ type: object
+ properties:
+ moduleName:
+ type: string
+ revision:
+ type: string
+ namespace:
+ type: string
+
OperationalRequest:
type: object
properties:
diff --git a/docs/openapi/openapi.yml b/docs/openapi/openapi.yml
index a4a238c4..114c521e 100644
--- a/docs/openapi/openapi.yml
+++ b/docs/openapi/openapi.yml
@@ -51,22 +51,16 @@ paths:
content:
application/json:
schema:
- type: string
+ $ref: 'components.yml#/components/schemas/ModuleSet'
example: {
- 'schemas': {
- 'schema': [
- {
- 'identifier': 'example-identifier',
- 'version': 'example-version',
- 'format': 'example-format',
- 'namespace': 'example:namespace',
- 'location': [
- 'example-location'
- ]
- }
- ]
- }
- }
+ "schemas": [
+ {
+ "moduleName": "example-identifier",
+ "revision": "example-version",
+ "namespace": "example-namespace"
+ }
+ ]
+ }
'400':
$ref: 'components.yml#/components/responses/BadRequest'
'401':