Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cullenwatson committed Aug 27, 2023
1 parent 73d1e28 commit ebe2bdc
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 54 deletions.
67 changes: 36 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,19 @@ POST `/api/v1/jobs/`
### Request Schema

```plaintext
Request
├── Required
├── site_type (List[enum]): linkedin, zip_recruiter, indeed
└── search_term (str)
└── Optional
{
Required
├── site_type (List[enum]): linkedin, zip_recruiter, indeed
└── search_term (str)
Optional
├── location (int)
├── distance (int)
├── job_type (enum): fulltime, parttime, internship, contract
├── is_remote (bool)
├── results_wanted (int): per site_type
── easy_apply (bool): only for linkedin
── easy_apply (bool): only for linkedin
└── output_format (enum): json, csv
}
```

### Request Example
Expand All @@ -35,36 +36,40 @@ Request
"location": "austin, tx",
"distance": 10,
"job_type": "fulltime",
"results_wanted": 15,
"output_format": "json"
"results_wanted": 15
}
```

### Response Schema
```plaintext
site_type (enum)
└── response (SiteResponse)
├── success (bool)
├── error (str)
├── jobs (List[JobPost])
│ └── JobPost
│ ├── title (str)
│ ├── company_name (str)
│ ├── job_url (str)
│ ├── location (object)
│ │ ├── country (str)
│ │ ├── city (str)
│ │ ├── state (str)
│ ├── description (str)
│ ├── job_type (enum)
│ ├── compensation (object)
│ │ ├── interval (CompensationInterval): yearly, monthly, weekly, daily, hourly
│ │ ├── min_amount (float)
│ │ ├── max_amount (float)
│ │ └── currency (str)
│ └── date_posted (datetime)
├── total_results (int)
└── returned_results (int)
{
site_type (enum): {
JobResponse
├── success (bool)
├── error (str)
├── jobs (List[JobPost])
│ └── JobPost
│ ├── title (str)
│ ├── company_name (str)
│ ├── job_url (str)
│ ├── location (object)
│ │ ├── country (str)
│ │ ├── city (str)
│ │ ├── state (str)
│ ├── description (str)
│ ├── job_type (enum)
│ ├── compensation (object)
│ │ ├── interval (CompensationInterval): yearly, monthly, weekly, daily, hourly
│ │ ├── min_amount (float)
│ │ ├── max_amount (float)
│ │ └── currency (str): default is "US"
│ └── date_posted (datetime)
├── total_results (int)
└── returned_results (int)
}, ...
}
```

### Response Example (JSON)
Expand Down
46 changes: 23 additions & 23 deletions postman/JobSpy.postman_collection.json

Large diffs are not rendered by default.

0 comments on commit ebe2bdc

Please sign in to comment.