feat(specs): add dictionary specs
#49
Conversation
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: './common/schemas/DictionaryEntriesResponse.yml#/dictionaryEntriesResponse' |
There was a problem hiding this comment.
Didn't we say that we wanted to avoid refs like this when possible ?
There was a problem hiding this comment.
This one is not pointing to the properties, do you mean the ./ at the beginning?
There was a problem hiding this comment.
No I mean, I thought we should simply add the properties directly in the file without any ref, as it's done here for example : https://github.com/algolia/api-clients-automation/blob/main/specs/search/paths/synonyms/clearAllSynonyms.yml#L19-L26
There was a problem hiding this comment.
The same response is used in 3 endpoints, so IMO it made more sense to only have one definition. I can't remember if we had a discussion about this but I think we should reduce duplicate as mush as possible.
We could even have this generic response (updatedAt, taskId) as a common response for all of our clients. wdyt?
There was a problem hiding this comment.
Okay let's do this (same for deletedAt and createdAt maybe ?
There was a problem hiding this comment.
Could you list them all here?
I have a local branch that improve consistency between spec files, I can put it in this PR
There was a problem hiding this comment.
- taskID / updatedAt
- taskID / deletedAt
- taskID / createdAt
- hits / nbHits ?
- search / count / nbHits ?
There was a problem hiding this comment.
Thanks! I'll try to make them generic and find a good name D:
specs/search/paths/dictionaries/common/schemas/SearchDictionaryEntriesResponse.yml
Show resolved
Hide resolved
I did not did it for this PR since it was already big, I will do a PR right after with some tests for these (and some others) endpoints. wdyt? |
No problem :) . I just feel that I'm the only one to add tests until now ahah |
True D: |
馃Л What and Why
馃師 JIRA Ticket: https://algolia.atlassian.net/browse/APIC-194
Changes included:
dictionaryendpoint specsrefthat were not correct馃И Test
CI :D