feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11374)

This commit is contained in:
Daniel Jimenez
2025-05-22 19:26:44 +12:00
committed by GitHub
parent 8697a30dc5
commit 4b417ce9e7
189 changed files with 10098 additions and 5847 deletions

View File

@@ -5,16 +5,22 @@ summary: Add a new portal
description: Add a new portal to account
security:
- userApiKey: []
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/portal_create_update_payload'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/portal_create_update_payload'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/portal'
content:
application/json:
schema:
$ref: '#/components/schemas/portal'
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'

View File

@@ -3,17 +3,23 @@ tags:
operationId: get-portal
summary: List all portals in an account
parameters:
- $ref: '#/parameters/account_id'
- $ref: '#/components/parameters/account_id'
description: Get details of portals in an Account
security:
- userApiKey: []
responses:
'200':
description: Success
schema:
type: array
description: Array of all portals
items:
$ref: '#/definitions/portal'
content:
application/json:
schema:
type: array
description: Array of all portals
items:
$ref: '#/components/schemas/portal'
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'

View File

@@ -1,20 +1,26 @@
tags:
- Help Center
operationId: update-new-portal-to-account
summary: update a new portal
description: update a new portal to account
operationId: update-portal-to-account
summary: Update a portal
description: Update a portal to account
security:
- userApiKey: []
parameters:
- name: data
in: body
required: true
schema:
$ref: '#/definitions/portal_create_update_payload'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/portal_create_update_payload'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/portal'
content:
application/json:
schema:
$ref: '#/components/schemas/portal'
'403':
description: Access denied
content:
application/json:
schema:
$ref: '#/components/schemas/bad_request_error'