mirror of
https://github.com/lingble/chatwoot.git
synced 2025-11-01 11:37:58 +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>
29 lines
915 B
Markdown
29 lines
915 B
Markdown
## Chatwoot Developer Documentation
|
|
|
|
Welcome to the official Chatwoot developer documentation. This guide contains everything you need to know about Chatwoot APIs and build custom flows on top of Chatwoot APIs.
|
|
|
|
### 👩💻 Development
|
|
|
|
Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
|
|
|
|
```
|
|
npm i -g mintlify
|
|
```
|
|
|
|
Run the following command at the root of your documentation (where mint.json is)
|
|
|
|
```
|
|
mintlify dev
|
|
```
|
|
|
|
### 😎 Publishing Changes
|
|
|
|
Changes will be deployed to production automatically after pushing to the default branch.
|
|
|
|
You can also preview changes using PRs, which generates a preview link of the docs.
|
|
|
|
#### Troubleshooting
|
|
|
|
- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
|
|
- Page loads as a 404 - Make sure you are running in a folder with `mint.json`
|