diff --git a/specs/common/parameters.yml b/specs/common/parameters.yml index 5bcd2f91f3..67ffffee4e 100644 --- a/specs/common/parameters.yml +++ b/specs/common/parameters.yml @@ -37,11 +37,11 @@ StartDate: StartDateRequired: in: query name: startDate - description: Start date of the period to analyze, in `YYYY-MM-DD` format. + description: Start date of the period to analyze, in RFC 3339 format. required: true schema: type: string - example: 2022-09-19 + example: 2024-08-30T00:00:00Z EndDate: in: query @@ -54,11 +54,11 @@ EndDate: EndDateRequired: in: query name: endDate - description: End date of the period to analyze, in `YYYY-MM-DD` format. + description: End date of the period to analyze, in RFC 3339 format. required: true schema: type: string - example: 2023-01-21 + example: 2024-08-30T00:00:00Z ForwardToReplicas: in: query diff --git a/specs/usage/paths/statistic.yml b/specs/usage/paths/statistic.yml index 4cf2a3139e..f69ec6c5cc 100644 --- a/specs/usage/paths/statistic.yml +++ b/specs/usage/paths/statistic.yml @@ -3,6 +3,8 @@ get: summary: Retrieve usage information description: | Retrieves usage statistics evaluated over a specified period. + tags: + - statistics parameters: - $ref: '../common/parameters.yml#/statisticParameter' - $ref: '../../common/parameters.yml#/StartDateRequired' diff --git a/specs/usage/paths/statisticIndex.yml b/specs/usage/paths/statisticIndex.yml index b0478dde1d..015e84d681 100644 --- a/specs/usage/paths/statisticIndex.yml +++ b/specs/usage/paths/statisticIndex.yml @@ -3,6 +3,8 @@ get: summary: Retrieve usage information for one index description: | Retrieves the selected usage statistics for one index. + tags: + - statistics parameters: - $ref: '../common/parameters.yml#/statisticParameter' - $ref: '../../common/parameters.yml#/IndexName' diff --git a/specs/usage/spec.yml b/specs/usage/spec.yml index 6289c87f84..7dfdd88afe 100644 --- a/specs/usage/spec.yml +++ b/specs/usage/spec.yml @@ -42,13 +42,11 @@ components: servers: - url: 'https://usage.algolia.com' description: Base URL of the Usage API. - - url: 'https://usage-dev.algolia.com' - description: Base URL for the development version of the Usage API (Algolia employees only). security: - appId: [] apiKey: [] tags: - - name: usage + - name: statistics x-displayName: Usage statistics description: Get various metrics related to the usage of your Algolia applications. paths: