writinwaters commited on
Commit
75d5476
·
1 Parent(s): 49c21eb

Updated list_documents() (#3126)

Browse files

### What problem does this PR solve?



### Type of change


- [x] Documentation Update

docs/references/http_api_reference.md CHANGED
@@ -613,14 +613,14 @@ Failure:
613
 
614
  ## List documents
615
 
616
- **GET** `/api/v1/datasets/{dataset_id}/documents?offset={offset}&limit={limit}&orderby={orderby}&desc={desc}&keywords={keywords}&id={document_id}`
617
 
618
  Lists documents in a specified dataset.
619
 
620
  ### Request
621
 
622
  - Method: GET
623
- - URL: `/api/v1/datasets/{dataset_id}/documents?keywords={keyword}&page={page}&page_size={limit}&orderby={orderby}&desc={desc}&name={name}`
624
  - Headers:
625
  - `'content-Type: application/json'`
626
  - `'Authorization: Bearer <YOUR_API_KEY>'`
@@ -629,7 +629,7 @@ Lists documents in a specified dataset.
629
 
630
  ```bash
631
  curl --request GET \
632
- --url http://{address}/api/v1/datasets/{dataset_id}/documents?keywords={keywords}&offset={offset}&limit={limit}&orderby={orderby}&desc={desc}&id={document_id} \
633
  --header 'Authorization: Bearer <YOUR_API_KEY>'
634
  ```
635
 
 
613
 
614
  ## List documents
615
 
616
+ **GET** `/api/v1/datasets/{dataset_id}/documents?offset={offset}&limit={limit}&orderby={orderby}&desc={desc}&keywords={keywords}&id={document_id}&name={document_name}`
617
 
618
  Lists documents in a specified dataset.
619
 
620
  ### Request
621
 
622
  - Method: GET
623
+ - URL: `/api/v1/datasets/{dataset_id}/documents?offset={offset}&limit={limit}&orderby={orderby}&desc={desc}&keywords={keywords}&id={document_id}&name={document_name}`
624
  - Headers:
625
  - `'content-Type: application/json'`
626
  - `'Authorization: Bearer <YOUR_API_KEY>'`
 
629
 
630
  ```bash
631
  curl --request GET \
632
+ --url http://{address}/api/v1/datasets/{dataset_id}/documents?offset={offset}&limit={limit}&orderby={orderby}&desc={desc}&keywords={keywords}&id={document_id}&name={document_name} \
633
  --header 'Authorization: Bearer <YOUR_API_KEY>'
634
  ```
635