Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / 541952b8b233fbac02d258d4869494cef75c0ba1 / . / cps-rest / docs / api / swagger / components.yml
blob: bb1f12002268600a55c595483d92c690670069f7 [file] [log] [blame]
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]1components:
2 schemas:
3 ErrorMessage:
4 type: object
5 title: Error
6 properties:
7 status:
8 type: string
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]9 example: 400
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]10 message:
11 type: string
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]12 example: Dataspace not found
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]13 details:
14 type: string
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]15 example: Dataspace with name D1 does not exist.
16
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]17 MultipartFile:
18 required:
19 - file
20 properties:
21 multipartFile:
22 type: string
23 description: multipartFile
24 format: binary
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]25 example: http://example.com/examples/example.yang
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]26
27 parameters:
28 dataspaceNameInQuery:
29 name: dataspace-name
30 in: query
31 description: dataspace-name
32 required: true
33 schema:
34 type: string
35 dataspaceNameInPath:
36 name: dataspace-name
37 in: path
38 description: dataspace-name
39 required: true
40 schema:
41 type: string
42 anchorNameInPath:
43 name: anchor-name
44 in: path
45 description: anchor-name
46 required: true
47 schema:
48 type: string
49 schemaSetNameInQuery:
50 name: schema-set-name
51 in: query
52 description: schema-set-name
53 required: true
54 schema:
55 type: string
56 schemaSetNameInPath:
57 name: schema-set-name
58 in: path
59 description: schema-set-name
60 required: true
61 schema:
62 type: string
63 anchorNameInQuery:
64 name: anchor-name
65 in: query
66 description: anchor-name
67 required: true
68 schema:
69 type: string
Ruslan Kashapov20983922021-02-01 10:47:25 +0200[diff] [blame]70 xpathInQuery:
Ruslan Kashapov24c72db2021-02-09 17:25:18 +0200[diff] [blame]71 name: xpath
Ruslan Kashapov20983922021-02-01 10:47:25 +0200[diff] [blame]72 in: query
Ruslan Kashapov24c72db2021-02-09 17:25:18 +0200[diff] [blame]73 description: xpath
Ruslan Kashapov20983922021-02-01 10:47:25 +0200[diff] [blame]74 required: false
75 schema:
76 type: string
77 default: /
niamhcore53f07ac2021-02-19 13:14:40 +0000[diff] [blame]78 cpsPathInQuery:
79 name: cps-path
80 in: query
81 description: cps-path
82 required: false
83 schema:
84 type: string
85 default: /
Ruslan Kashapov20983922021-02-01 10:47:25 +0200[diff] [blame]86 includeDescendantsOptionInQuery:
87 name: include-descendants
88 in: query
89 description: include-descendants
90 required: false
91 schema:
92 type: boolean
93 default: false
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]94
95 responses:
96 NotFound:
97 description: The specified resource was not found
98 content:
99 application/json:
100 schema:
101 $ref: '#/components/schemas/ErrorMessage'
102 Unauthorized:
103 description: Unauthorized
104 content:
105 application/json:
106 schema:
107 $ref: '#/components/schemas/ErrorMessage'
108 Forbidden:
109 description: Forbidden
110 content:
111 application/json:
112 schema:
113 $ref: '#/components/schemas/ErrorMessage'
114 BadRequest:
115 description: Bad Request
116 content:
117 application/json:
118 schema:
119 $ref: '#/components/schemas/ErrorMessage'
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]120 Conflict:
121 description: Conflict
122 content:
123 application/json:
124 schema:
125 $ref: '#/components/schemas/ErrorMessage'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]126 Ok:
127 description: OK
128 content:
129 application/json:
130 schema:
131 type: object
132 Created:
133 description: Created
134 content:
135 text/plain:
136 schema:
137 type: string
138 NoContent:
139 description: No Content
140 content: {}