Skip to content

Commit 0be0cf9

Browse files
Improved applications' endpoints documentation
1 parent 69fa138 commit 0be0cf9

File tree

5 files changed

+13
-7
lines changed

5 files changed

+13
-7
lines changed

documentation/docs/applications/approve.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,7 @@ values={[
170170

171171
</TabItem>
172172
</Tabs>
173+
173174
### Example 5 - Application is not verified
174175

175176
**Code** : <Highlight level="danger" inline>409 CONFLICT</Highlight>

documentation/docs/applications/create.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ import Highlight from "../../src/highlight.js"
1313
## Details
1414

1515
This endpoint is used to create company applications.
16-
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
17-
finish its registration.
16+
In order for a Company to use its account, the company must verify its application by clicking in a link sent
17+
by email after its creation. After that the Company should finish its registration.
1818

1919
**URL** : `/apply/company`
2020

@@ -36,7 +36,11 @@ see [register](../auth/register).
3636
Email used for the company application and subsequent account.
3737

3838
Must be in a valid email format.
39-
Can't already be in use for accounts or other applications.
39+
Can't already be in use on any account.
40+
41+
:::info
42+
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.
43+
:::
4044

4145
### password
4246

@@ -181,7 +185,7 @@ values={[
181185
"password": "password123",
182186
"companyName": "Company",
183187
"motivation": "We wish to revolutionize the industry with young engineers."
184-
}
188+
}ara quem usa o timetable-bruteforcer
185189
```
186190

187191
</TabItem>

documentation/docs/applications/reject.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,7 @@ values={[
197197

198198
</TabItem>
199199
</Tabs>
200+
200201
### Example 5 - Application is not verified
201202

202203
**Code** : <Highlight level="danger" inline>409 CONFLICT</Highlight>

documentation/docs/applications/search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ values={[
188188
"submittedAt": "2022-09-07T13:15:15.971Z",
189189
"isVerified": false,
190190
"__v": 0,
191-
"state": "PENDING"
191+
"state": "UNVERIFIED"
192192
}
193193
],
194194
"docCount": 4

documentation/docs/companies/get-application.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ values={[
7777

7878
### Example 2 - Insufficient permission
7979

80-
**Code** : <Highlight level="success" inline>401 UNAUTHORIZED</Highlight>
80+
**Code** : <Highlight level="danger" inline>401 UNAUTHORIZED</Highlight>
8181

8282
<Tabs
8383
defaultValue="request"
@@ -113,7 +113,7 @@ values={[
113113

114114
### Example 3 - Invalid ID
115115

116-
**Code** : <Highlight level="success" inline>422 UNPROCESSABLE ENTITY</Highlight>
116+
**Code** : <Highlight level="danger" inline>422 UNPROCESSABLE ENTITY</Highlight>
117117

118118
<Tabs
119119
defaultValue="request"

0 commit comments

Comments
 (0)