Skip to content

Commit

Permalink
📝 Update docs
Browse files Browse the repository at this point in the history
Update docs
  • Loading branch information
Rachid F committed Dec 20, 2023
1 parent f06268e commit 75f2a93
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 21 deletions.
6 changes: 4 additions & 2 deletions .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ node_modules/
apps/webapp/node_modules
apps/webapp/dist

packages/api/node_modules
packages/api/dist
apps/frontend-snippet/node_modules
apps/frontend-snippet/dist

packages/api/node_modules
packages/api/dist
18 changes: 3 additions & 15 deletions docs/crm/contacts/api/get.mdx
Original file line number Diff line number Diff line change
@@ -1,17 +1,5 @@
---
title: 'List all contacts'
description: 'Retrieve all contacts from all connected CRMs using one endpoint'
openapi: "GET /crm/contact"
title: 'Retrieve a contact'
description: 'Retrieve a contact from connected CRMs'
openapi: "GET /crm/contact/{id}"
---

Example API Response:


```json JSON
{
"id_contact": "f4e1ff72-e727-409a-8935-a63a63d4891e"
"first_name": "John"
"last_name": "Doe"
}
```

17 changes: 17 additions & 0 deletions docs/crm/contacts/api/list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: 'List all contacts'
description: 'Retrieve all contacts from all connected CRMs using one endpoint'
openapi: "GET /crm/contact"
---

Example API Response:


```json JSON
{
"id_contact": "f4e1ff72-e727-409a-8935-a63a63d4891e"
"first_name": "John"
"last_name": "Doe"
}
```

5 changes: 5 additions & 0 deletions docs/crm/contacts/api/update.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'Update a contact'
description: 'Update a contacts from any connected CRM'
openapi: "PATCH /crm/contact"
---
2 changes: 1 addition & 1 deletion docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
"crm/catalog",
{
"group": "Contacts",
"pages": [ "crm/contacts/overview", "crm/contacts/api/get", "crm/contacts/api/create" ]
"pages": [ "crm/contacts/overview", "crm/contacts/api/list", "crm/contacts/api/get", "crm/contacts/api/create", "crm/contacts/api/update" ]
},
{
"group": "Deals",
Expand Down
4 changes: 2 additions & 2 deletions packages/api/src/crm/contact/contact.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ export class ContactController {
@ApiOperation({
operationId: 'getContact',
summary: 'Retrieve a CRM Contact',
description: 'Retrive a contact in any supported CRM',
description: 'Retrieve a contact from any connected CRM',
})
@ApiParam({ name: 'id', required: true, type: String })
@ApiParam({ name: 'id', required: true, type: String, description: "id of the `contact` you want to retrive." })
@ApiQuery({ name: 'remote_data', required: false, type: Boolean, description: 'Set to true to include data from the original CRM software.' })
@ApiCustomResponse(ContactResponse)
@Get(':id')
Expand Down
3 changes: 2 additions & 1 deletion packages/api/swagger/swagger-spec.json
Original file line number Diff line number Diff line change
Expand Up @@ -790,12 +790,13 @@
"get": {
"operationId": "getContact",
"summary": "Retrieve a CRM Contact",
"description": "Retrive a contact in any supported CRM",
"description": "Retrieve a contact from any connected CRM",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"description": "id of the `contact` you want to retrive.",
"schema": {
"type": "string"
}
Expand Down

0 comments on commit 75f2a93

Please sign in to comment.