Skip to content
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

fix(specs): usage api #2954

Merged
merged 2 commits into from
Apr 5, 2024
Merged

fix(specs): usage api #2954

merged 2 commits into from
Apr 5, 2024

Conversation

kai687
Copy link
Contributor

@kai687 kai687 commented Apr 4, 2024

🧭 What and Why

Update of the Usage API spec.
Unfortunately, I can't test the Usage API (can't make any requests) so I can't independently verify the information like I did for the other APIs, so I only did a few style updates.

Changes included:

  • Use an enum for the {statistics} parameter
  • Increased reuse of existing schemas.

@algolia-bot
Copy link
Collaborator

algolia-bot commented Apr 4, 2024

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.
You can still access the code generated on main via this commit.

@kai687 kai687 marked this pull request as ready for review April 4, 2024 13:08
@kai687 kai687 requested a review from a team as a code owner April 4, 2024 13:08
@kai687 kai687 requested review from morganleroi and Fluf22 April 4, 2024 13:08
Copy link

github-actions bot commented Apr 4, 2024

@github-actions github-actions bot temporarily deployed to pull request April 4, 2024 13:09 Inactive
Copy link
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks wonderful!

Comment on lines +42 to +45
appId:
$ref: '../common/securitySchemes.yml#/appId'
apiKey:
$ref: '../common/securitySchemes.yml#/apiKey'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's really this and not basic? if so we will be able to generate clients then!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shortcuts I thought the Usage API isn't part of the SDKs?

The current/old API reference in the docs say that it uses the x-algolia-* headers and not basic auth.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes it's not because generating clients only works with the appID and apiKey combo for now, but since it doesn't use the basic auth anymore, we can make a client for it!

@github-actions github-actions bot temporarily deployed to pull request April 5, 2024 12:08 Inactive
@shortcuts
Copy link
Member

nice my fix worked :D

Copy link
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks a ton!!

@shortcuts shortcuts merged commit 60e23f8 into main Apr 5, 2024
13 checks passed
@shortcuts shortcuts deleted the docs/usage-api branch April 5, 2024 12:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants