-
Notifications
You must be signed in to change notification settings - Fork 14
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
feat(specs): search advanced endpoints APIC-197 #40
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very clean ! Too bad for the snake case
method: | ||
type: string | ||
description: HTTP method of the perfomed request. | ||
answer_code: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the first time seeing snake case in the API, this ruins everything
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you !
You need to generate the new java client also ( |
Ah ok 👌 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perfect !
# /1/indexes/{indexName}/task/{taskID}: | ||
# $ref: './paths/advanced/getTask.yml' | ||
# /1/isalive: | ||
# $ref: './paths/advanced/isAlive.yml' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would still clarify this with search team, the goal of OpenApi is to reflect 1:1 the API not to reflect actual usage. If they don't want to document this endpoint fair enough, otherwise I would still keep it, at least in the spec
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To me the goal is to have consistent API Clients and an associated documentation of all the endpoints that we want to expose, not to list all weird legacy endpoints still replying 200.
But anyway for this one it has been clarified: https://docs.google.com/spreadsheets/d/1waVcU2Olr968Uni2rTM5N6NkUU3QY48kycfupBjZoBI/edit#gid=0
🧭 What and Why
🎟 JIRA Ticket: APIC-197
Changes included:
curl
call myself and looked in the csharp client and java client to list the properties (some of them seem wrong likeexhaustive
)isalive
endpoint that doesn't exist in many clients and is not usefulyarn generate
.gitignore
(e.g.**/node_modules
is covered bynode_modules
, see the OBSERVATION here: https://stackoverflow.com/a/38559600/1326281)