|
149 | 149 | }, |
150 | 150 | "paths": { |
151 | 151 | "/ocs/v2.php/apps/terms_of_service/terms": { |
| 152 | + "get": { |
| 153 | + "operationId": "terms-index", |
| 154 | + "summary": "Get all available terms for the current country", |
| 155 | + "tags": [ |
| 156 | + "terms" |
| 157 | + ], |
| 158 | + "security": [ |
| 159 | + {}, |
| 160 | + { |
| 161 | + "bearer_auth": [] |
| 162 | + }, |
| 163 | + { |
| 164 | + "basic_auth": [] |
| 165 | + } |
| 166 | + ], |
| 167 | + "parameters": [ |
| 168 | + { |
| 169 | + "name": "OCS-APIRequest", |
| 170 | + "in": "header", |
| 171 | + "description": "Required to be true for the API request to pass", |
| 172 | + "required": true, |
| 173 | + "schema": { |
| 174 | + "type": "boolean", |
| 175 | + "default": true |
| 176 | + } |
| 177 | + } |
| 178 | + ], |
| 179 | + "responses": { |
| 180 | + "200": { |
| 181 | + "description": "Get list successfully", |
| 182 | + "content": { |
| 183 | + "application/json": { |
| 184 | + "schema": { |
| 185 | + "type": "object", |
| 186 | + "required": [ |
| 187 | + "ocs" |
| 188 | + ], |
| 189 | + "properties": { |
| 190 | + "ocs": { |
| 191 | + "type": "object", |
| 192 | + "required": [ |
| 193 | + "meta", |
| 194 | + "data" |
| 195 | + ], |
| 196 | + "properties": { |
| 197 | + "meta": { |
| 198 | + "$ref": "#/components/schemas/OCSMeta" |
| 199 | + }, |
| 200 | + "data": { |
| 201 | + "type": "object", |
| 202 | + "required": [ |
| 203 | + "terms", |
| 204 | + "languages", |
| 205 | + "hasSigned" |
| 206 | + ], |
| 207 | + "properties": { |
| 208 | + "terms": { |
| 209 | + "type": "array", |
| 210 | + "items": { |
| 211 | + "$ref": "#/components/schemas/Terms" |
| 212 | + } |
| 213 | + }, |
| 214 | + "languages": { |
| 215 | + "type": "object", |
| 216 | + "additionalProperties": { |
| 217 | + "type": "string" |
| 218 | + } |
| 219 | + }, |
| 220 | + "hasSigned": { |
| 221 | + "type": "boolean" |
| 222 | + } |
| 223 | + } |
| 224 | + } |
| 225 | + } |
| 226 | + } |
| 227 | + } |
| 228 | + } |
| 229 | + } |
| 230 | + } |
| 231 | + } |
| 232 | + } |
| 233 | + }, |
152 | 234 | "post": { |
153 | 235 | "operationId": "terms-create", |
154 | 236 | "summary": "Create new terms", |
|
268 | 350 | } |
269 | 351 | }, |
270 | 352 | "/ocs/v2.php/apps/terms_of_service/sign": { |
| 353 | + "post": { |
| 354 | + "operationId": "signing-sign-terms", |
| 355 | + "summary": "As a logged in user sign the terms", |
| 356 | + "tags": [ |
| 357 | + "signing" |
| 358 | + ], |
| 359 | + "security": [ |
| 360 | + { |
| 361 | + "bearer_auth": [] |
| 362 | + }, |
| 363 | + { |
| 364 | + "basic_auth": [] |
| 365 | + } |
| 366 | + ], |
| 367 | + "requestBody": { |
| 368 | + "required": true, |
| 369 | + "content": { |
| 370 | + "application/json": { |
| 371 | + "schema": { |
| 372 | + "type": "object", |
| 373 | + "required": [ |
| 374 | + "termId" |
| 375 | + ], |
| 376 | + "properties": { |
| 377 | + "termId": { |
| 378 | + "type": "integer", |
| 379 | + "format": "int64", |
| 380 | + "description": "The terms the user signed" |
| 381 | + } |
| 382 | + } |
| 383 | + } |
| 384 | + } |
| 385 | + } |
| 386 | + }, |
| 387 | + "parameters": [ |
| 388 | + { |
| 389 | + "name": "OCS-APIRequest", |
| 390 | + "in": "header", |
| 391 | + "description": "Required to be true for the API request to pass", |
| 392 | + "required": true, |
| 393 | + "schema": { |
| 394 | + "type": "boolean", |
| 395 | + "default": true |
| 396 | + } |
| 397 | + } |
| 398 | + ], |
| 399 | + "responses": { |
| 400 | + "200": { |
| 401 | + "description": "Signed successfully", |
| 402 | + "content": { |
| 403 | + "application/json": { |
| 404 | + "schema": { |
| 405 | + "type": "object", |
| 406 | + "required": [ |
| 407 | + "ocs" |
| 408 | + ], |
| 409 | + "properties": { |
| 410 | + "ocs": { |
| 411 | + "type": "object", |
| 412 | + "required": [ |
| 413 | + "meta", |
| 414 | + "data" |
| 415 | + ], |
| 416 | + "properties": { |
| 417 | + "meta": { |
| 418 | + "$ref": "#/components/schemas/OCSMeta" |
| 419 | + }, |
| 420 | + "data": {} |
| 421 | + } |
| 422 | + } |
| 423 | + } |
| 424 | + } |
| 425 | + } |
| 426 | + } |
| 427 | + } |
| 428 | + } |
| 429 | + }, |
271 | 430 | "delete": { |
272 | 431 | "operationId": "signing-reset-all-signatories", |
273 | 432 | "summary": "Reset the signatories of all accounts", |
|
0 commit comments