search

arangodb / docs-hugo

Source code of the ArangoDB online documentation
https://docs.arangodb.com
Apache License 2.0
5 stars 5 forks source link

Render accepted HTTP headers, explain API basics #456

Closed Simran-B closed 7 months ago

Simran-B commented 7 months ago

Description

For example, https://docs.arangodb.com/stable/develop/http-api/documents/#get-a-document doesn't list the available parameters you can set in: header because the OpenAPI render template misses to handle them

Added some explanations around URLs, endpoints, and how to interpret the API docs (e.g. what Query Parameters are) - let me know if this is understandable

Preview with HTTP headers: https://deploy-preview-456--docs-hugo.netlify.app/stable/develop/http-api/documents/#get-a-document

Upstream PRs

arangodb-docs-automation[bot] commented 7 months ago

Deploy Preview Available Via
https://deploy-preview-456--docs-hugo.netlify.app

Simran-B commented 7 months ago

Open question: does HEAD /_api/document support the x-arango-allow-dirty-read HTTP header, or is it limited to the GET method?

Simran-B commented 7 months ago

Yes, Jan checked and HEAD uses the same code path as the single document GET (but without generating the response body). We don't offer an API for only retrieving the metadata for multiple documents.