Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
abd0123 authored May 22, 2024
1 parent 79a82a2 commit 53d1291
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Welcome to the Workup API documentation. This API provides endpoints for managin
##### Authentication
All endpoints require authentication using a bearer token. Include the token in the Authorization header of your requests.

```
```bash
Authorization: Bearer <your_access_token>
```

Expand All @@ -109,15 +109,15 @@ Description: Retrieves details of a specific job.
Request Parameters
- job_id (path parameter): The ID of the job to retrieve.
- Example Request
```
```bash
GET /api/v1/jobs/7ddda13b-8221-4766-983d-9068a6592eba
Authorization: Bearer <your_access_token>
```

Response
- 200 OK: Returns the details of the requested job.

```
```json
{
"id": "7ddda13b-8221-4766-983d-9068a6592eba",
"title": "Sample Job",
Expand All @@ -134,14 +134,14 @@ Description: Retrieves all proposals for a specific job.

Request Parameters
- job_id (path parameter): The ID of the job to retrieve - - - proposals for.
```
```bash
GET /api/v1/jobs/7ddda13b-8221-4766-983d-9068a6592eba/proposals
Authorization: Bearer <your_access_token>
```

Response
- 200 OK: Returns a list of proposals for the specified job.
```
```json
[
{
"id": "73fb1269-6e05-4756-93cc-947e10dac15e",
Expand All @@ -165,15 +165,15 @@ Request Parameters
- contract_id (path parameter): The ID of the contract to retrieve.


```
```bash
GET /api/v1/contracts/702a6e9a-343b-4b98-a86b-0565ee6d8ea5
Authorization: Bearer <your_access_token>
```

Response
- 200 OK: Returns the details of the requested contract.

```
```json
{
"id": "702a6e9a-343b-4b98-a86b-0565ee6d8ea5",
"client_id": "2d816b8f-592c-48c3-b66f-d7a1a4fd0c3a",
Expand All @@ -195,7 +195,7 @@ Request Parameters
- job_id (path parameter): The ID of the job to create a proposal for.

Request Body
```
```json
{
"coverLetter": "I am interested in this job...",
"jobDuration": "LESS_THAN_A_MONTH",
Expand All @@ -215,7 +215,7 @@ Request Body
Response
- 201 Created: Returns the newly created proposal.

```
```json
{
"id": "73fb1269-6e05-4756-93cc-947e10dac15e",
"job_id": "7ddda13b-8221-4766-983d-9068a6592eba",
Expand All @@ -234,7 +234,7 @@ Description: Retrieves details of a specific proposal.

Request Parameters
- proposal_id (path parameter): The ID of the proposal to retrieve.
```
```bash
GET /api/v1/proposals/73fb1269-6e05-4756-93cc-947e10dac15e
Authorization: Bearer <your_access_token>

Expand All @@ -243,7 +243,7 @@ Authorization: Bearer <your_access_token>
Response
- 200 OK: Returns the details of the requested proposal.

```
```json
{
"id": "73fb1269-6e05-4756-93cc-947e10dac15e",
"job_id": "7ddda13b-8221-4766-983d-9068a6592eba",
Expand All @@ -267,7 +267,7 @@ Request Parameters


Request Body
```
```json
{
"coverLetter": "Updated cover letter...",
"jobDuration": "ONE_TO_THREE_MONTHS",
Expand All @@ -285,7 +285,7 @@ Request Body

Response
- 200 OK: Returns the updated proposal.
```
```json
{
"id": "73fb1269-6e05-4756-93cc-947e10dac15e",
"job_id": "7ddda13b-8221-4766-983d-9068a6592eba",
Expand Down

0 comments on commit 53d1291

Please sign in to comment.