Skip to content

Commit a9405b1

Browse files
kai687shortcuts
andauthored
fix(specs): usage api (#3624)
Co-authored-by: Clément Vannicatte <[email protected]>
1 parent e3af955 commit a9405b1

File tree

4 files changed

+9
-7
lines changed

4 files changed

+9
-7
lines changed

specs/common/parameters.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ StartDate:
3737
StartDateRequired:
3838
in: query
3939
name: startDate
40-
description: Start date of the period to analyze, in `YYYY-MM-DD` format.
40+
description: Start date of the period to analyze, in RFC 3339 format.
4141
required: true
4242
schema:
4343
type: string
44-
example: 2022-09-19
44+
example: 2024-08-30T00:00:00Z
4545

4646
EndDate:
4747
in: query
@@ -54,11 +54,11 @@ EndDate:
5454
EndDateRequired:
5555
in: query
5656
name: endDate
57-
description: End date of the period to analyze, in `YYYY-MM-DD` format.
57+
description: End date of the period to analyze, in RFC 3339 format.
5858
required: true
5959
schema:
6060
type: string
61-
example: 2023-01-21
61+
example: 2024-08-30T00:00:00Z
6262

6363
ForwardToReplicas:
6464
in: query

specs/usage/paths/statistic.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ get:
33
summary: Retrieve usage information
44
description: |
55
Retrieves usage statistics evaluated over a specified period.
6+
tags:
7+
- statistics
68
parameters:
79
- $ref: '../common/parameters.yml#/statisticParameter'
810
- $ref: '../../common/parameters.yml#/StartDateRequired'

specs/usage/paths/statisticIndex.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ get:
33
summary: Retrieve usage information for one index
44
description: |
55
Retrieves the selected usage statistics for one index.
6+
tags:
7+
- statistics
68
parameters:
79
- $ref: '../common/parameters.yml#/statisticParameter'
810
- $ref: '../../common/parameters.yml#/IndexName'

specs/usage/spec.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,11 @@ components:
4242
servers:
4343
- url: 'https://usage.algolia.com'
4444
description: Base URL of the Usage API.
45-
- url: 'https://usage-dev.algolia.com'
46-
description: Base URL for the development version of the Usage API (Algolia employees only).
4745
security:
4846
- appId: []
4947
apiKey: []
5048
tags:
51-
- name: usage
49+
- name: statistics
5250
x-displayName: Usage statistics
5351
description: Get various metrics related to the usage of your Algolia applications.
5452
paths:

0 commit comments

Comments
 (0)