| Ruslan Kashapov | 9f52f60 | 2021-01-22 12:53:01 +0200 | [diff] [blame] | 1 | components: |
| 2 | schemas: |
| 3 | ErrorMessage: |
| 4 | type: object |
| 5 | title: Error |
| 6 | properties: |
| 7 | status: |
| 8 | type: string |
| 9 | message: |
| 10 | type: string |
| 11 | details: |
| 12 | type: string |
| 13 | MultipartFile: |
| 14 | required: |
| 15 | - file |
| 16 | properties: |
| 17 | multipartFile: |
| 18 | type: string |
| 19 | description: multipartFile |
| 20 | format: binary |
| 21 | |
| 22 | parameters: |
| Hanif Kukkalli | 83e318f | 2021-02-23 12:26:39 +0100 | [diff] [blame^] | 23 | cmHandleInPath: |
| 24 | name: cm-handle |
| 25 | in: path |
| 26 | description: The identifier for a network function, network element, subnetwork or any other cm object by managed NF-Proxy |
| 27 | required: true |
| 28 | schema: |
| 29 | type: string |
| 30 | xpathInQuery: |
| 31 | name: xpath |
| 32 | in: query |
| 33 | description: xpath |
| 34 | required: false |
| 35 | schema: |
| 36 | type: string |
| 37 | default: / |
| 38 | includeDescendantsOptionInQuery: |
| 39 | name: include-descendants |
| 40 | in: query |
| 41 | description: include-descendants |
| 42 | required: false |
| 43 | schema: |
| 44 | type: boolean |
| 45 | default: false |
| Ruslan Kashapov | 9f52f60 | 2021-01-22 12:53:01 +0200 | [diff] [blame] | 46 | |
| 47 | responses: |
| 48 | NotFound: |
| 49 | description: The specified resource was not found |
| 50 | content: |
| 51 | application/json: |
| 52 | schema: |
| 53 | $ref: '#/components/schemas/ErrorMessage' |
| 54 | Unauthorized: |
| 55 | description: Unauthorized |
| 56 | content: |
| 57 | application/json: |
| 58 | schema: |
| 59 | $ref: '#/components/schemas/ErrorMessage' |
| 60 | Forbidden: |
| 61 | description: Forbidden |
| 62 | content: |
| 63 | application/json: |
| 64 | schema: |
| 65 | $ref: '#/components/schemas/ErrorMessage' |
| 66 | BadRequest: |
| 67 | description: Bad Request |
| 68 | content: |
| 69 | application/json: |
| 70 | schema: |
| 71 | $ref: '#/components/schemas/ErrorMessage' |
| 72 | Conflict: |
| 73 | description: Conflict |
| 74 | content: |
| 75 | application/json: |
| 76 | schema: |
| 77 | $ref: '#/components/schemas/ErrorMessage' |
| Hanif Kukkalli | 83e318f | 2021-02-23 12:26:39 +0100 | [diff] [blame^] | 78 | NotImplemented: |
| 79 | description: The given path has not been implemented |
| 80 | content: |
| 81 | application/json: |
| 82 | schema: |
| 83 | $ref: '#/components/schemas/ErrorMessage' |
| Ruslan Kashapov | 9f52f60 | 2021-01-22 12:53:01 +0200 | [diff] [blame] | 84 | Ok: |
| 85 | description: OK |
| 86 | content: |
| 87 | application/json: |
| 88 | schema: |
| 89 | type: object |
| 90 | Created: |
| 91 | description: Created |
| 92 | content: |
| 93 | text/plain: |
| 94 | schema: |
| 95 | type: string |
| 96 | NoContent: |
| 97 | description: No Content |
| 98 | content: {} |