turtlebasket
/
JobSpy
mirror of https://github.com/Bunsly/JobSpy
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: update readme

pull/16/head
Cullen Watson 2023-08-26 21:13:11 -05:00
parent 62a47e9967
commit 77eb56722a
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -12,7 +12,6 @@
POST `/api/v1/jobs/` POST `/api/v1/jobs/`
### Request Schema ### Request Schema
```plaintext ```plaintext
Request Request
├── Required ├── Required
@ -27,7 +26,7 @@ Request
└── easy_apply (bool): only for linkedin └── easy_apply (bool): only for linkedin
``` ```
### Example ### Request Example
<pre> <pre>
{ {
"site_type": ["linkedin", "indeed"], "site_type": ["linkedin", "indeed"],
@ -39,7 +38,7 @@ Request
} }
</pre> </pre>
## Response Schema ### Response Schema
```plaintext ```plaintext
site_type (enum) site_type (enum)
└── response (SiteResponse) └── response (SiteResponse)
@ -68,7 +67,7 @@ site_type (enum)
└── returned_results (int) └── returned_results (int)
``` ```
### Example ### Response Example
<details> <details>
<summary><code>Sample Response JSON</code></summary> <summary><code>Sample Response JSON</code></summary>
<pre><code>{ <pre><code>{