459f225559
# Pull Request Template ## Description Updates the public swagger spec to be OpenAPI 3.0.4 compliant. Regarding #7893, I'm investigating the use of [oas_rails](https://github.com/a-chacon/oas_rails) to auto-generate the documentation along with correct expected payloads. Mostly fixes #10531, related to #7893 ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality not to work as expected) - [ ] This change requires a documentation update ## How Has This Been Tested? Copied spec into swagger editor, reviewed outputs:  Note that this shows two errors with the `DELETE` endpoints as technically these should not have a `requestBody` - in which case we should be making use of another HTTP verb or another endpoint. ## Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [x] I have commented on my code, particularly in hard-to-understand areas - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [x] Any dependent changes have been merged and published in downstream modules --------- Co-authored-by: Daniel Jimenez <devildan.knex@gmail.com> Co-authored-by: Daniel Jimenez <daniel.jimenez@spark64.com>
40 lines
979 B
YAML
40 lines
979 B
YAML
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
description: The ID of the portal
|
|
archived:
|
|
type: boolean
|
|
description: Whether the portal is archived
|
|
color:
|
|
type: string
|
|
description: The color code for the portal
|
|
config:
|
|
$ref: '#/components/schemas/portal_config'
|
|
custom_domain:
|
|
type: string
|
|
description: Custom domain for the portal
|
|
header_text:
|
|
type: string
|
|
description: The header text for the portal
|
|
homepage_link:
|
|
type: string
|
|
description: Homepage link for the portal
|
|
name:
|
|
type: string
|
|
description: Name of the portal
|
|
slug:
|
|
type: string
|
|
description: URL slug for the portal
|
|
page_title:
|
|
type: string
|
|
description: Page title for the portal
|
|
account_id:
|
|
type: integer
|
|
description: ID of the account the portal belongs to
|
|
inbox:
|
|
$ref: '#/components/schemas/inbox'
|
|
logo:
|
|
$ref: '#/components/schemas/portal_logo'
|
|
meta:
|
|
$ref: '#/components/schemas/portal_meta' |