diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/swagger/openapi.yaml | 28 | ||||
| -rw-r--r-- | docs/conf.py | 1 |
2 files changed, 8 insertions, 21 deletions
diff --git a/docs/api/swagger/openapi.yaml b/docs/api/swagger/openapi.yaml index b8dedc6a..fcc2302a 100644 --- a/docs/api/swagger/openapi.yaml +++ b/docs/api/swagger/openapi.yaml @@ -181,20 +181,14 @@ paths: name: resourceIdentifier required: true schema: - example: my-schema:my-node + example: '/ManagedElement=NRNode1/GNBDUFunction=1' type: string - description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\ \ in parenthesis'()'." examples: sample1: value: - options: "(key1=value1,key2=value2)" - sample2: - value: - options: "(key1=value1,key2=value1/value2)" - sample3: - value: - options: "(key1=10,key2=value2,key3=val31,val32)" + options: (fields=NRCellDU/attributes/cellLocalId) in: query name: options required: false @@ -345,7 +339,7 @@ components: name: resourceIdentifier required: true schema: - example: my-schema:my-node + example: '/ManagedElement=NRNode1/GNBDUFunction=1' type: string optionsParamInQuery: description: "options parameter in query, it is mandatory to wrap key(s)=value(s)\ @@ -353,13 +347,7 @@ components: examples: sample1: value: - options: "(key1=value1,key2=value2)" - sample2: - value: - options: "(key1=value1,key2=value1/value2)" - sample3: - value: - options: "(key1=10,key2=value2,key3=val31,val32)" + options: (fields=NRCellDU/attributes/cellLocalId) in: query name: options required: false @@ -649,9 +637,9 @@ components: type: object DataOperationRequest: example: - resourceIdentifier: some resource identifier + resourceIdentifier: '/ManagedElement=NRNode1/GNBDUFunction=1' datastore: ncmp-datastore:passthrough-operational - options: some option + options: (fields=NRCellDU/attributes/cellLocalId) operationId: "12" cmHandles: - id: cmHandle123 @@ -678,10 +666,10 @@ components: example: ncmp-datastore:passthrough-operational type: string options: - example: some option + example: (fields=NRCellDU/attributes/cellLocalId) type: string resourceIdentifier: - example: some resource identifier + example: '/ManagedElement=NRNode1/GNBDUFunction=1' type: string cmHandles: items: diff --git a/docs/conf.py b/docs/conf.py index 9e775787..724b903f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -60,7 +60,6 @@ spelling_lang = "en_GB" intersphinx_mapping = {} intersphinx_mapping['onap-cps'] = ('{}/onap-cps/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-cps-cps-temporal'] = ('{}/onap-cps-cps-temporal/en/%s'.format(doc_url) % branch, None) linkcheck_ignore = [ 'http://localhost', |