feat(specs): improve consistency and naming #96
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
millotp
reviewed
Jan 20, 2022
specs/query-suggestions/common/schemas/QuerySuggestionsIndex.yml
Outdated
Show resolved
Hide resolved
millotp
approved these changes
Jan 20, 2022
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
🎟 JIRA Ticket: https://algolia.atlassian.net/browse/APIC-270
Changes included:
Aims at improving the naming and the specs consistency.
Objectsuffix byParams, which was redundant in some cases, and also not always used.RecordtoHit,Recordis what is stored in Algolia,Hitis what is returned by the engine (additional properties).$refs from other definitions properties.IndextoIndice, as having anindex.EXTENSIONfile is usually used to define an entry point of a folder.null | undefined, as empty strings etc. are also wrong.Open issue
Our wrapped types in JavaScript are suffixed by the word
Props, which is really web-framework-react-vue-oriented, I did not find a better same yet, feel free to submit your ideas :D🧪 Test
CI :D