From 5e7323392195ac6c0b2d74d1b4f1f90d2b2de3aa Mon Sep 17 00:00:00 2001 From: dsantosferreira Date: Sun, 10 Sep 2023 20:22:54 +0100 Subject: [PATCH] Improved applications' endpoints documentation --- documentation/docs/applications/approve.md | 1 + documentation/docs/applications/create.md | 12 ++++++++---- documentation/docs/applications/reject.md | 1 + documentation/docs/applications/search.md | 2 +- 4 files changed, 11 insertions(+), 5 deletions(-) diff --git a/documentation/docs/applications/approve.md b/documentation/docs/applications/approve.md index 4a530069..160f2510 100644 --- a/documentation/docs/applications/approve.md +++ b/documentation/docs/applications/approve.md @@ -170,6 +170,7 @@ values={[ + ### Example 5 - Application is not verified **Code** : 409 CONFLICT diff --git a/documentation/docs/applications/create.md b/documentation/docs/applications/create.md index cc0786e4..953d12d8 100644 --- a/documentation/docs/applications/create.md +++ b/documentation/docs/applications/create.md @@ -13,8 +13,8 @@ import Highlight from "../../src/highlight.js" ## Details This endpoint is used to create company applications. -In order of a Company to use its account, the company must verify its application by clicking in a link sent by email after the creation of the application and then the Company should -finish its registration. +In order for a Company to use its account, the company must verify its application by clicking in a link sent +by email after its creation. After that the Company should finish its registration. **URL** : `/apply/company` @@ -36,7 +36,11 @@ see [register](../auth/register). Email used for the company application and subsequent account. Must be in a valid email format. -Can't already be in use for accounts or other applications. +Can't already be in use on any account. + +:::info +After creating an application, if another application is created with the same email after 10 minutes, the existing one will be replaced. Creating the new application before the 10 minute mark will result in an error. +::: ### password @@ -181,7 +185,7 @@ values={[ "password": "password123", "companyName": "Company", "motivation": "We wish to revolutionize the industry with young engineers." -} +}ara quem usa o timetable-bruteforcer ``` diff --git a/documentation/docs/applications/reject.md b/documentation/docs/applications/reject.md index 2a889402..1ef7a3a9 100644 --- a/documentation/docs/applications/reject.md +++ b/documentation/docs/applications/reject.md @@ -197,6 +197,7 @@ values={[ + ### Example 5 - Application is not verified **Code** : 409 CONFLICT diff --git a/documentation/docs/applications/search.md b/documentation/docs/applications/search.md index a96a6171..574f52f2 100644 --- a/documentation/docs/applications/search.md +++ b/documentation/docs/applications/search.md @@ -188,7 +188,7 @@ values={[ "submittedAt": "2022-09-07T13:15:15.971Z", "isVerified": false, "__v": 0, - "state": "PENDING" + "state": "UNVERIFIED" } ], "docCount": 4