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.

Sign up for GitHub

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

Jump to bottom

feat(specs): Review OpenAPI common specs #1692

Merged
merged 49 commits into from
Jul 19, 2023
Merged

feat(specs): Review OpenAPI common specs #1692

merged 49 commits into from
Jul 19, 2023

Conversation

gazconroy
Copy link
Contributor

@gazconroy gazconroy commented Jul 5, 2023 •
edited
Loading

Reviewing references that are common to all API specs.

🧭 What and Why

🎟 JIRA Ticket: DOC-1143

Changes included:

Content review., incorporating reviewe suggestions from abandoned monolithic search API PR (1618)

🧪 Test

@gazconroy gazconroy requested a review from a team as a code owner July 5, 2023 13:36
@gazconroy gazconroy requested review from damcou and aallam July 5, 2023 13:36
@netlify
Copy link

netlify bot commented Jul 5, 2023 •
edited
Loading

✅ Deploy Preview for api-clients-automation ready!

Name Link
🔨 Latest commit 3277490
🔍 Latest deploy log https://app.netlify.com/sites/api-clients-automation/deploys/64b7d48da892cb0008bb4353
😎 Deploy Preview https://deploy-preview-1692--api-clients-automation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@gazconroy gazconroy requested a review from kai687 July 5, 2023 13:36
@algolia-bot
Copy link
Collaborator

algolia-bot commented Jul 5, 2023 •
edited
Loading

✗ The generated branch has been deleted.

If the PR has been merged, you can check the generated code on the main branch.
You can still access the code generated on main via this commit.

kai687
kai687 requested changes Jul 5, 2023
View reviewed changes
Copy link
Contributor

@kai687 kai687 left a comment

Choose a reason for hiding this comment

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

Much better scope now! Thanks for splitting this up.

specs/common/parameters.yml Outdated Show resolved Hide resolved
specs/common/parameters.yml Outdated Show resolved Hide resolved
specs/common/responses/FeatureNotEnabled.yml Outdated Show resolved Hide resolved
specs/common/responses/RequestEntityTooLarge.yml Outdated Show resolved Hide resolved
specs/common/responses/StatusUnprocessableEntity.yml Outdated Show resolved Hide resolved
specs/common/schemas/SearchParams.yml Outdated Show resolved Hide resolved
specs/common/schemas/IndexSettings.yml Outdated Show resolved Hide resolved
specs/common/schemas/IndexSettings.yml Outdated Show resolved Hide resolved
specs/common/schemas/IndexSettings.yml Outdated Show resolved Hide resolved
specs/common/schemas/IndexSettings.yml Outdated Show resolved Hide resolved
shortcuts
shortcuts reviewed Jul 6, 2023
View reviewed changes
Copy link
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

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

No blocker on the API clients side, impressive work guys

gazconroy and others added 21 commits July 6, 2023 09:10
@gazconroy @kai687
Update specs/common/parameters.yml
ee0c64b 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/parameters.yml
10620b7 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/responses/FeatureNotEnabled.yml
8a82df4 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/responses/RequestEntityTooLarge.yml
ad9125c 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/responses/StatusUnprocessableEntity.yml
12d55ff 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/schemas/SearchParams.yml
5cf2885 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/schemas/IndexSettings.yml
79807a6 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/schemas/IndexSettings.yml
4e12c55 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/schemas/IndexSettings.yml
2e07046 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/schemas/IndexSettings.yml
ec217ba 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/responses/UnprocessableEntity.yml
479b356 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/schemas/CustomRequest.yml
c9251cc 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/schemas/SearchParams.yml
25d9042 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/schemas/SearchParams.yml
31809a2 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/schemas/SearchParams.yml
86fbcea 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/schemas/SearchParams.yml
46b95cc 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/schemas/SearchParams.yml
b8de0ec 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/schemas/SearchParams.yml
12e01db 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/schemas/SearchParams.yml
742090b 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/schemas/SearchParams.yml
c1417dd 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
Update specs/common/schemas/SearchParams.yml
eb5660e 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
docs(specs): Review OpenAPI Search API (record operations) (#1697)
41aa510 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
gazconroy and others added 12 commits July 11, 2023 12:50
@gazconroy
docs(specs): Review OpenAPI Search API (advanced operations) (#1704)
cad787c
@gazconroy
docs(specs): Review OpenAPI Search API (vault operations) (#1703)
3746ef0
@gazconroy @kai687 @shortcuts
docs(specs): Review OpenAPI Search API (search operations) (#1693)
68a875d 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
@gazconroy @shortcuts
docs(specs): Review OpenAPI Search API (index operations) (#1696)
f6921f5 
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
@gazconroy @kai687
docs(specs): Review OpenAPI Search API (dictionary operations) (#1700)
50450cf 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy
Update common.yml typo
30fba95
@gazconroy @kai687 @shortcuts
docs(specs): Review OpenAPI Recommend (#1682)
bd72fc5 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
@gazconroy
Update common.yml
ffd2ff5
@gazconroy @kai687
docs(specs): Review OpenAPI Analytics (search analytics) (#1689)
7414180 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @shortcuts
docs(specs): Review OpenAPI A/B testing specs (#1746)
5e2349c 
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
@gazconroy @kai687
docs(specs): Review OpenAPI Analytics (click analytics) (#1720)
e80f17e 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@gazconroy @kai687
docs(specs): Review OpenAPI Search API (rules operations) (#1698)
46708b2 
Co-authored-by: Kai Welke <kai.welke@algolia.com>
@shortcuts
Copy link
Member

(I'll handle the conflicts once this PR is ready to be merged on main)

shortcuts
shortcuts approved these changes Jul 19, 2023
View reviewed changes
Copy link
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

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

incredible work, congrats!

@shortcuts shortcuts requested a review from kai687 July 19, 2023 07:06
@shortcuts shortcuts changed the title docs(specs): Review OpenAPI common specs feat(specs): Review OpenAPI common specs Jul 19, 2023
@shortcuts
Copy link
Member

@kai687 do you do a last round of review for this one or can I merge?

kai687
kai687 approved these changes Jul 19, 2023
View reviewed changes
Copy link
Contributor

@kai687 kai687 left a comment

Choose a reason for hiding this comment

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

🚢 👍

@shortcuts shortcuts merged commit f15457f into main Jul 19, 2023
@shortcuts shortcuts deleted the fix/review-common-specs branch July 19, 2023 12:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shortcuts shortcuts shortcuts approved these changes

@kai687 kai687 kai687 approved these changes

@damcou damcou Awaiting requested review from damcou damcou is a code owner automatically assigned from algolia/api-clients-automation

@aallam aallam Awaiting requested review from aallam aallam is a code owner automatically assigned from algolia/api-clients-automation

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@gazconroy @algolia-bot @shortcuts @kai687