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

View File

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