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): ingestion partial update method changed to patch #1564

Merged
merged 3 commits into from
May 25, 2023

Conversation

mehmetaligok
Copy link
Contributor

🧭 What and Why

🎟 JIRA Ticket: https://algolia.atlassian.net/browse/DI-1280

Ingestion partial updates will use PATCH instead of PUT.

Changes included:

  • PUT method changed to PATCH for partial updates.

@mehmetaligok mehmetaligok added the Specs Issue related to the REST API specs label May 23, 2023
@mehmetaligok mehmetaligok self-assigned this May 23, 2023
@netlify
Copy link

netlify bot commented May 23, 2023

Deploy Preview for api-clients-automation ready!

Name Link
🔨 Latest commit 5c11470
🔍 Latest deploy log https://app.netlify.com/sites/api-clients-automation/deploys/646cd2276227c10008d7f03b
😎 Deploy Preview https://deploy-preview-1564--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 settings.

@algolia-bot
Copy link
Collaborator

algolia-bot commented May 23, 2023

✗ 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.

@mehmetaligok mehmetaligok changed the title feat(spec): ingestion partial update method changed to patch feat(specs): ingestion partial update method changed to patch May 23, 2023
@mehmetaligok mehmetaligok marked this pull request as ready for review May 24, 2023 09:25
@mehmetaligok mehmetaligok requested a review from a team as a code owner May 24, 2023 09:25
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.

we should have both methods available, right? otherwise it's a breaking change

@mehmetaligok
Copy link
Contributor Author

we should have both methods available, right? otherwise it's a breaking change

@shortcuts

For the generated client-wise, it shouldn't be a breaking change for now. Since we are only changing the HTTP method, the name and all the parameters will be the same. For example, usage will stay as updateAuthentication and nothing will change from the outer perspective.

for the documentation part we will only show PATCH since we want the user to use PATCH for partial updates and currently, we are allowing both PUT and PATCH and that shouldn't be a breaking change yet.

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.

oh I thought it was changing the method names, then it should be :okidoki:

@mehmetaligok mehmetaligok merged commit 635806c into main May 25, 2023
20 checks passed
@mehmetaligok mehmetaligok deleted the feat/change-ingestion-partial-update branch May 25, 2023 08:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Specs Issue related to the REST API specs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants