Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / cec636cf769e3713ede2d2bf2a8e29722e710e98 / . / cps-rest / docs / openapi / components.yml
blob: a337a244b8dd600136951c1cd70c2ad7a35c6f13 [file] [log] [blame]
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]1components:
2 schemas:
JosephKeenanc6865f32021-06-08 13:16:37 +0100[diff] [blame]3
4 AnchorDetails:
5 type: object
6 title: Anchor details by anchor Name
7 properties:
8 name:
9 type: string
10 example: my_anchor
11 dataspaceName:
12 type: string
13 example: my_dataspace
14 schemaSetName:
15 type: string
16 example: my_schema_set
17
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]18 ErrorMessage:
19 type: object
20 title: Error
21 properties:
22 status:
23 type: string
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]24 example: 400
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]25 message:
26 type: string
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]27 example: Dataspace not found
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]28 details:
29 type: string
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]30 example: Dataspace with name D1 does not exist.
31
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]32 MultipartFile:
33 required:
34 - file
35 properties:
36 multipartFile:
37 type: string
38 description: multipartFile
39 format: binary
Rishi.Chail6d13f162021-01-26 05:58:39 +0000[diff] [blame]40 example: http://example.com/examples/example.yang
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]41
JosephKeenanc6865f32021-06-08 13:16:37 +0100[diff] [blame]42 ModuleReferences:
43 type: object
44 title: Module reference object
45 properties:
46 name:
47 type: string
48 example: module_reference_name
49 namespace:
50 type: string
51 example: module_reference_namespace
52 revision:
53 type: string
54 example: module_reference_revision
55
56 SchemaSetDetails:
57 type: object
58 title: Schema set details by dataspace and schemasetName
59 properties:
60 dataspaceName:
61 type: string
62 example: my_dataspace
63 moduleReferences:
64 type: array
65 items:
66 $ref: '#/components/schemas/ModuleReferences'
67 name:
68 type: string
69 example: my_schema_set
70
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]71 parameters:
72 dataspaceNameInQuery:
73 name: dataspace-name
74 in: query
75 description: dataspace-name
76 required: true
77 schema:
78 type: string
79 dataspaceNameInPath:
80 name: dataspace-name
81 in: path
82 description: dataspace-name
83 required: true
84 schema:
85 type: string
86 anchorNameInPath:
87 name: anchor-name
88 in: path
89 description: anchor-name
90 required: true
91 schema:
92 type: string
93 schemaSetNameInQuery:
94 name: schema-set-name
95 in: query
96 description: schema-set-name
97 required: true
98 schema:
99 type: string
100 schemaSetNameInPath:
101 name: schema-set-name
102 in: path
103 description: schema-set-name
104 required: true
105 schema:
106 type: string
107 anchorNameInQuery:
108 name: anchor-name
109 in: query
110 description: anchor-name
111 required: true
112 schema:
113 type: string
Ruslan Kashapov20983922021-02-01 10:47:25 +0200[diff] [blame]114 xpathInQuery:
Ruslan Kashapov24c72db2021-02-09 17:25:18 +0200[diff] [blame]115 name: xpath
Ruslan Kashapov20983922021-02-01 10:47:25 +0200[diff] [blame]116 in: query
Ruslan Kashapov24c72db2021-02-09 17:25:18 +0200[diff] [blame]117 description: xpath
Ruslan Kashapov20983922021-02-01 10:47:25 +0200[diff] [blame]118 required: false
119 schema:
120 type: string
121 default: /
Ruslan Kashapov0905ac12021-05-05 13:11:50 +0300[diff] [blame]122 requiredXpathInQuery:
123 name: xpath
124 in: query
125 description: xpath
126 required: true
127 schema:
128 type: string
niamhcore53f07ac2021-02-19 13:14:40 +0000[diff] [blame]129 cpsPathInQuery:
130 name: cps-path
131 in: query
132 description: cps-path
133 required: false
134 schema:
135 type: string
136 default: /
Ruslan Kashapov20983922021-02-01 10:47:25 +0200[diff] [blame]137 includeDescendantsOptionInQuery:
138 name: include-descendants
139 in: query
140 description: include-descendants
141 required: false
142 schema:
143 type: boolean
144 default: false
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]145
146 responses:
147 NotFound:
148 description: The specified resource was not found
149 content:
150 application/json:
151 schema:
152 $ref: '#/components/schemas/ErrorMessage'
153 Unauthorized:
154 description: Unauthorized
155 content:
156 application/json:
157 schema:
158 $ref: '#/components/schemas/ErrorMessage'
159 Forbidden:
160 description: Forbidden
161 content:
162 application/json:
163 schema:
164 $ref: '#/components/schemas/ErrorMessage'
165 BadRequest:
166 description: Bad Request
167 content:
168 application/json:
169 schema:
170 $ref: '#/components/schemas/ErrorMessage'
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]171 Conflict:
172 description: Conflict
173 content:
174 application/json:
175 schema:
176 $ref: '#/components/schemas/ErrorMessage'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]177 Ok:
178 description: OK
179 content:
180 application/json:
181 schema:
182 type: object
183 Created:
184 description: Created
185 content:
186 text/plain:
187 schema:
188 type: string
189 NoContent:
190 description: No Content
191 content: {}