mirror of
https://github.com/lingble/chatwoot.git
synced 2026-03-20 03:52:43 +00:00
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>
84 lines
2.7 KiB
JSON
84 lines
2.7 KiB
JSON
{
|
|
"name": "Chatwoot Developer Docs",
|
|
"description": "Official developer documentation for Chatwoot - the open-source customer support platform. Learn about our APIs, integrations, and development guidelines.",
|
|
"logo": {
|
|
"dark": "/logo/dark.png",
|
|
"light": "/logo/light.png"
|
|
},
|
|
"favicon": "/favicon.png",
|
|
"colors": {
|
|
"primary": "#0069ED",
|
|
"light": "#4D9CFF",
|
|
"dark": "#0050B4"
|
|
},
|
|
"theme": "maple",
|
|
"navigation": {
|
|
"tabs": [
|
|
{
|
|
"tab": "API Documentation",
|
|
"groups": [
|
|
{
|
|
"group": "Platform API",
|
|
"description": "APIs for managing platform aspects of Chatwoot",
|
|
"includeTags": [
|
|
"Accounts",
|
|
"Account Users",
|
|
"AgentBots",
|
|
"Users"
|
|
],
|
|
"openapi": "https://raw.githubusercontent.com/chatwoot/chatwoot/develop/swagger/tag_groups/platform_swagger.json"
|
|
},
|
|
{
|
|
"group": "Application API",
|
|
"description": "APIs for managing application aspects of Chatwoot",
|
|
"includeTags": [
|
|
"Account AgentBots",
|
|
"Agents",
|
|
"Canned Responses",
|
|
"Contacts",
|
|
"Contact Labels",
|
|
"Conversation Assignments",
|
|
"Conversation Labels",
|
|
"Conversations",
|
|
"Custom Attributes",
|
|
"Custom Filters",
|
|
"Inboxes",
|
|
"Integrations",
|
|
"Messages",
|
|
"Profile",
|
|
"Reports",
|
|
"Teams",
|
|
"Webhooks",
|
|
"Automation Rule",
|
|
"Help Center"
|
|
],
|
|
"openapi": "https://raw.githubusercontent.com/chatwoot/chatwoot/develop/swagger/tag_groups/application_swagger.json"
|
|
},
|
|
{
|
|
"group": "Client API",
|
|
"description": "APIs for client applications",
|
|
"includeTags": [
|
|
"Contacts API",
|
|
"Conversations API",
|
|
"Messages API"
|
|
],
|
|
"openapi": "https://raw.githubusercontent.com/chatwoot/chatwoot/develop/swagger/tag_groups/client_swagger.json"
|
|
},
|
|
{
|
|
"group": "Other APIs",
|
|
"description": "Other Chatwoot APIs",
|
|
"includeTags": [
|
|
"CSAT Survey Page"
|
|
],
|
|
"openapi": "https://raw.githubusercontent.com/chatwoot/chatwoot/develop/swagger/tag_groups/other_swagger.json"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"footerSocials": {
|
|
"twitter": "https://twitter.com/chatwootapp",
|
|
"github": "https://github.com/chatwoot",
|
|
"linkedin": "https://www.linkedin.com/company/chatwoot"
|
|
}
|
|
} |