Skip to content

fix(specs): usage api #3624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions specs/common/parameters.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 2 additions & 0 deletions specs/usage/paths/statistic.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
2 changes: 2 additions & 0 deletions specs/usage/paths/statisticIndex.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
4 changes: 1 addition & 3 deletions specs/usage/spec.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading