Skip to content

Commit 6d4fe66

Browse files
docs: remove unused headers
1 parent cb637af commit 6d4fe66

File tree

1 file changed

+1
-3
lines changed

1 file changed

+1
-3
lines changed

apps/api/docs/api-documentation.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ curl --location 'http://localhost:3000/graphql' \
3737
--header 'Content-Type: application/json' \
3838
--header 'Accept: application/json' \
3939
--header 'Connection: keep-alive' \
40-
--header 'Origin: chrome-extension://flnheeellpciglgpaodhkhmapeljopja' \
4140
--header 'x-apollo-operation-name: createSummary' \
4241
--header 'Authorization: Bearer auth-token' \
4342
--form 'operations="{\"query\":\"mutation (\$file: Upload\!) {\\n createSummary(createSummaryInput: { inputFile: \$file }) {\\n jobId\\n }\\n}\"}"' \
@@ -68,7 +67,7 @@ The different options that can be used while fetching summaries are as follows:
6867
- `sortBy:` Sort the results by the provided key
6968
- `sortOrder:` Sort the results in either `ASC`ending or `DESC`ending order
7069
- `search:` Display those results which contain the input string. Searchable fields: `inputFile`, `createdBy`, `outputText`
71-
- `filters:` Filter the results based on the provided `createdOn` and `createdBy`. Operator can be `eq` (equal), `ne` (not equal), `contains`, `gt` (greater than) or `lt` (less than)
70+
- `filters:` Filter the results based on the provided `createdOn` and `createdBy`. Operator can be `eq` (equal), `ne` (not equal), `contains`, `gt` (greater than), `gte` (greater than or equal to), `lt` (less than) or `lte` (less than or equal to)
7271

7372
**Endpoint:** `http://localhost:3000/graphql`
7473

@@ -127,7 +126,6 @@ curl --location 'http://localhost:3000/graphql' \
127126
--header 'Content-Type: application/json' \
128127
--header 'Accept: application/json' \
129128
--header 'Connection: keep-alive' \
130-
--header 'Origin: chrome-extension://flnheeellpciglgpaodhkhmapeljopja' \
131129
--header 'Authorization: Bearer auth-token' \
132130
--data-raw '{"query":"{\n summaries(\n options: {\n limit: 10\n offset: 0\n sortOrder: ASC\n search: \"John Doe\" # Remove search if you want complete data\n filters: [ # Remove filters if you want complete data\n { field: \"createdOn\", operator: \"gte\", value: \"2023-01-01\" } # Specify the date range to fetch record\n { field: \"createdOn\", operator: \"lte\", value: \"2024-06-06\" } # Specify the upper limit for the date range\n { field: \"createdBy\", operator: \"in\", value: \"[\\\"user@example.com\\\",\\\"admin@example.com\\\"]\" } # Specify the email id of the person whose record you want to find\n ]\n }\n ) {\n limit\n offset\n summaries {\n createdBy\n createdOn\n jobId\n inputFile\n jobStatus\n modifiedBy\n modifiedOn\n outputText\n status\n }\n total\n }\n}\n","variables":{}}'
133131
```

0 commit comments

Comments
 (0)