fix(specs): update documentation for consistency #2976
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
shortcuts
force-pushed
the
fix/specs-style
branch
from
8e745b9
to
f92a2f1
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧭 What and Why
Follow up with PR #2962 to align the APIs (except the in progress Recommend, Personalization, and A/B testing APIs) with the guidelines established by that PR.
Changes included:
h2rather thanh1headingsI didn't update the
X-Algolia-User-IDheader, because making it all lowercase breaks the tests. This parameter is only used in the deprecated Multi-cluster management endpoints, so I thought it's ok to leave it as it is.