Skip to content

Commit

Permalink
fix: more intro
Browse files Browse the repository at this point in the history
  • Loading branch information
kai687 committed Apr 4, 2024
1 parent b6c2847 commit d915744
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions specs/crawler/spec.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,26 @@ info:
You can find both in the [Crawler dashboard](https://crawler.algolia.com/admin/settings/).
The Crawler dashboard and API key are different from the regular Algolia dashboard and API keys.
# Request format
Request bodies must be JSON objects.
# Parameters
Parameters are passed as query parameters for GET requests,
and in the request body for POST and PATCH requests.
Query parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding).
Non-ASCII characters must be UTF-8 encoded.
# Response status and errors
The Crawler API returns JSON responses.
Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.
Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status.
Error responses have a `message` property with more information.
# Version
The current version of the Crawler API is version 1, as indicated by the `/1/` in each endpoint's URL.
Expand Down

0 comments on commit d915744

Please sign in to comment.