diff --git a/packages/component-invite/README.md b/packages/component-invite/README.md index f40d9ef50aeeb1e6c6b1d48157f6bb3bca352417..a4f9beb8ff5ee72503ba15d96f05821b956da668 100644 --- a/packages/component-invite/README.md +++ b/packages/component-invite/README.md @@ -7,6 +7,7 @@ This endpoint allows creates a new User, linking it to a Collection through a Te #### Invite User Request `POST /api/collections/:collectionId/invitations` + | URI Parameter | Requiered | Requirements | Description | | ------------- | --------- | ------------ | ------------------ | | collectionId | No | String | The ID of the collection | @@ -22,7 +23,7 @@ This endpoint allows creates a new User, linking it to a Collection through a Te #### Invite User Response -```json +```javascript HTTP/1.1 200 OK { "id": "7b2431af-210c-49f9-a69a-e19271066ebd", @@ -53,7 +54,7 @@ This endpoint allows you to get a list of invitations based on role. #### Get Invitations Response -```json +```javascript HTTP/1.1 200 OK [ { @@ -92,7 +93,7 @@ This endpoint allows you to accept or to decline an invitation. #### Accept/Decline Response -```json +```javascript HTTP/1.1 200 OK { "id": "7b2431af-210c-49f9-a69a-e19271066ebd", @@ -128,7 +129,7 @@ This endpoint allows you to decline an invitation without authenticating. #### Decline Response -```json +```javascript HTTP/1.1 200 OK {} ``` @@ -148,6 +149,6 @@ This endpoint allows you to delete an invitation. #### Delete Invitation Response -```json +```javascript HTTP/1.1 204 No Content ``` \ No newline at end of file