diff options
author | Renu Kumari <renu.kumari@bell.ca> | 2021-10-12 13:41:01 -0400 |
---|---|---|
committer | Renu Kumari <renu.kumari@bell.ca> | 2021-10-12 13:44:22 -0400 |
commit | 3aea57e78651eabe954a2cfb9b2c85289295806f (patch) | |
tree | 5160bfe12e74790fa43c9e1bfaf38e85fb64953f /docs/openapi/components.yml | |
parent | 73e2c15554f094fc303c0d691472b4977c0398e2 (diff) |
Provide complete openapi.yml in read the docs
- Seperate openapi.yml for code gen and read the docs
- Added few env varaibles in docker-compose.yml
Issue-ID: CPS-733
Signed-off-by: Renu Kumari <renu.kumari@bell.ca>
Change-Id: Ibda007c40396436a5adce137d9f69806100253dc
Diffstat (limited to 'docs/openapi/components.yml')
-rw-r--r-- | docs/openapi/components.yml | 202 |
1 files changed, 0 insertions, 202 deletions
diff --git a/docs/openapi/components.yml b/docs/openapi/components.yml deleted file mode 100644 index 30e5987f..00000000 --- a/docs/openapi/components.yml +++ /dev/null @@ -1,202 +0,0 @@ -components: - schemas: - ErrorMessage: - type: object - title: Error - properties: - status: - type: string - message: - type: string - details: - type: string - - CmHandles: - type: object - properties: - cmHandles: - type: array - items: - type: string - - ModuleReferencesRequest: - type: object - properties: - cmHandleProperties: - $ref: '#/components/schemas/cmHandleProperties' - - ModuleResourcesReadRequest: - type: object - properties: - data: - type: object - properties: - modules: - type: array - items: - type: object - properties: - name: - $ref: '#/components/schemas/name' - revision: - $ref: '#/components/schemas/revision' - cmHandleProperties: - $ref: '#/components/schemas/cmHandleProperties' - - ModuleSet: - type: object - properties: - schemas: - type: array - items: - type: object - properties: - moduleName: - type: string - revision: - $ref: '#/components/schemas/revision' - namespace: - type: string - - YangResources: - type: array - items: - type: object - $ref: '#/components/schemas/YangResource' - - YangResource: - properties: - yangSource: - type: string - moduleName: - type: string - revision: - $ref: '#/components/schemas/revision' - - DataAccessReadRequest: - type: object - properties: - operation: - type: string - enum: [ read ] - cmHandleProperties: - $ref: '#/components/schemas/cmHandleProperties' - - DataAccessWriteRequest: - type: object - properties: - operation: - type: string - enum: [ create ] - dataType: - type: string - data: - type: string - cmHandleProperties: - $ref: '#/components/schemas/cmHandleProperties' - - cmHandleProperties: - type: object - additionalProperties: - type: string - example: {"prop1":"value1","prop2":"value2"} - - name: - type: string - example: someName - - revision: - type: string - example: someRevision - - responses: - NotFound: - description: The specified resource was not found - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - Unauthorized: - description: Unauthorized - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - Forbidden: - description: Forbidden - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - BadRequest: - description: Bad Request - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - Conflict: - description: Conflict - content: - application/json: - schema: - $ref: '#/components/schemas/ErrorMessage' - Ok: - description: OK - content: - application/json: - schema: - type: object - Created: - description: Created - content: - text/plain: - schema: - type: string - NoContent: - description: No Content - content: {} - - parameters: - cmHandleInPath: - name: cmHandle - in: path - description: The identifier for a network function, network element, subnetwork, or any other cm object by managed Network CM Proxy - required: true - schema: - type: string - - resourceIdentifierInQuery: - name: resourceIdentifier - in: query - description: Resource identifier to get/set the resource data - required: true - allowReserved: true - schema: - type: string - - acceptParamInHeader: - name: accept - in: header - description: Accept parameter for response, if accept parameter is null, that means client can accept any format. - schema: - type: string - enum: [ application/json, application/yang-data+json ] - - optionsParamInQuery: - name: options - in: query - description: options parameter in query, it is mandatory to wrap key(s)=value(s) in parenthesis'()'. - required: false - schema: - type: string - allowReserved: true - 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])
\ No newline at end of file |