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>
61 lines
1.8 KiB
YAML
61 lines
1.8 KiB
YAML
tags:
|
|
- Help Center
|
|
operationId: get-portal
|
|
summary: List all portals in an account
|
|
parameters:
|
|
- $ref: '#/components/parameters/account_id'
|
|
description: Get details of portals in an Account
|
|
security:
|
|
- userApiKey: []
|
|
responses:
|
|
'200':
|
|
description: Success
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/portal'
|
|
example:
|
|
payload:
|
|
- id: 4
|
|
color: "#1F93FF"
|
|
custom_domain: "chatwoot.help"
|
|
header_text: "Handbook"
|
|
homepage_link: "https://www.chatwoot.com"
|
|
name: "Handbook"
|
|
page_title: "Handbook"
|
|
slug: "handbook"
|
|
archived: false
|
|
account_id: 1
|
|
config:
|
|
allowed_locales:
|
|
- code: "en"
|
|
articles_count: 32
|
|
categories_count: 9
|
|
inbox:
|
|
id: 37
|
|
avatar_url: "https://example.com/avatar.png"
|
|
channel_id: 1
|
|
name: "Chatwoot"
|
|
channel_type: "Channel::WebWidget"
|
|
greeting_enabled: true
|
|
widget_color: "#1F93FF"
|
|
website_url: "chatwoot.com"
|
|
logo:
|
|
id: 19399916
|
|
portal_id: 4
|
|
file_type: "image/png"
|
|
account_id: 1
|
|
file_url: "https://example.com/logo.png"
|
|
blob_id: 21239614
|
|
filename: "square.png"
|
|
meta:
|
|
all_articles_count: 0
|
|
categories_count: 9
|
|
default_locale: "en"
|
|
'403':
|
|
description: Access denied
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/bad_request_error'
|