Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / 20983922daff86e3282bc5e2da900a8ab1cc82ed / . / cps-rest / docs / api / swagger / components.yaml
blob: bc7aa57e7a67f16cbd75a2dbbd0668337ff190a2 [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
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:
23 dataspaceNameInQuery:
24 name: dataspace-name
25 in: query
26 description: dataspace-name
27 required: true
28 schema:
29 type: string
30 dataspaceNameInPath:
31 name: dataspace-name
32 in: path
33 description: dataspace-name
34 required: true
35 schema:
36 type: string
37 anchorNameInPath:
38 name: anchor-name
39 in: path
40 description: anchor-name
41 required: true
42 schema:
43 type: string
44 schemaSetNameInQuery:
45 name: schema-set-name
46 in: query
47 description: schema-set-name
48 required: true
49 schema:
50 type: string
51 schemaSetNameInPath:
52 name: schema-set-name
53 in: path
54 description: schema-set-name
55 required: true
56 schema:
57 type: string
58 anchorNameInQuery:
59 name: anchor-name
60 in: query
61 description: anchor-name
62 required: true
63 schema:
64 type: string
Ruslan Kashapov20983922021-02-01 10:47:25 +0200[diff] [blame^]65 xpathInQuery:
66 name: cps-path
67 in: query
68 description: cps-path
69 required: false
70 schema:
71 type: string
72 default: /
73 includeDescendantsOptionInQuery:
74 name: include-descendants
75 in: query
76 description: include-descendants
77 required: false
78 schema:
79 type: boolean
80 default: false
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]81
82 responses:
83 NotFound:
84 description: The specified resource was not found
85 content:
86 application/json:
87 schema:
88 $ref: '#/components/schemas/ErrorMessage'
89 Unauthorized:
90 description: Unauthorized
91 content:
92 application/json:
93 schema:
94 $ref: '#/components/schemas/ErrorMessage'
95 Forbidden:
96 description: Forbidden
97 content:
98 application/json:
99 schema:
100 $ref: '#/components/schemas/ErrorMessage'
101 BadRequest:
102 description: Bad Request
103 content:
104 application/json:
105 schema:
106 $ref: '#/components/schemas/ErrorMessage'
Ruslan Kashapovdce4e312021-01-11 15:34:10 +0200[diff] [blame]107 Conflict:
108 description: Conflict
109 content:
110 application/json:
111 schema:
112 $ref: '#/components/schemas/ErrorMessage'
puthuparambil.aditya001e7732021-01-13 12:06:20 +0000[diff] [blame]113 Ok:
114 description: OK
115 content:
116 application/json:
117 schema:
118 type: object
119 Created:
120 description: Created
121 content:
122 text/plain:
123 schema:
124 type: string
125 NoContent:
126 description: No Content
127 content: {}