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

feat(specs): search advanced endpoints APIC-197 #40

Merged
merged 12 commits into from
Dec 15, 2021

Conversation

sbellone
Copy link
Contributor

@sbellone sbellone commented Dec 14, 2021

🧭 What and Why

🎟 JIRA Ticket: APIC-197

Changes included:

@sbellone sbellone self-assigned this Dec 14, 2021
Copy link
Collaborator

@millotp millotp left a 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:
Copy link
Collaborator

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

specs/search/paths/advanced/getLogs.yml Show resolved Hide resolved
specs/search/paths/advanced/getLogs.yml Show resolved Hide resolved
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
millotp
millotp previously approved these changes Dec 15, 2021
Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

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

Thank you !

@millotp
Copy link
Collaborator

millotp commented Dec 15, 2021

You need to generate the new java client also (yarn generate java search)

@sbellone
Copy link
Contributor Author

Ah ok 👌

Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

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

Perfect !

@sbellone sbellone merged commit 1bb1322 into main Dec 15, 2021
@sbellone sbellone deleted the feat/specs-search-advanced branch December 15, 2021 14:51
# /1/indexes/{indexName}/task/{taskID}:
# $ref: './paths/advanced/getTask.yml'
# /1/isalive:
# $ref: './paths/advanced/isAlive.yml'
Copy link
Contributor

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

Copy link
Contributor Author

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

shortcuts pushed a commit that referenced this pull request Apr 22, 2022
* add .idea/ to .gitignore
* specs: Get logs endpoint
* specs: Get task endpoint
* yarn generate
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