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

API Upgrade file updated after ShippingMethod endpoints changes #13659

Conversation

TheMilek
Copy link
Member

Q A
Branch? master
Bug fix? no
New feature? no
Deprecations? no
Related tickets #13628
License MIT

@TheMilek TheMilek requested a review from a team as a code owner February 17, 2022 11:54
@probot-autolabeler probot-autolabeler bot added the Maintenance CI configurations, READMEs, releases, etc. label Feb 17, 2022
@TheMilek TheMilek changed the title [API] Upgrade file updated after ShippingMethod endpoints changes API Upgrade file updated after ShippingMethod endpoints changes Feb 17, 2022
@lchrusciel lchrusciel closed this Feb 18, 2022
@lchrusciel lchrusciel reopened this Feb 18, 2022
UPGRADE-API-1.12.md Outdated Show resolved Hide resolved
@TheMilek TheMilek force-pushed the shipping-methods-shop-endpoints-refactor-documented branch from 8f8b6ff to 6f8185c Compare February 18, 2022 08:41
UPGRADE-API-1.12.md Outdated Show resolved Hide resolved
UPGRADE-API-1.12.md Outdated Show resolved Hide resolved
@TheMilek TheMilek force-pushed the shipping-methods-shop-endpoints-refactor-documented branch 2 times, most recently from 4d08c8a to 00da7d1 Compare February 18, 2022 09:05
UPGRADE-API-1.12.md Outdated Show resolved Hide resolved
@TheMilek TheMilek force-pushed the shipping-methods-shop-endpoints-refactor-documented branch from 00da7d1 to 2ee5438 Compare February 22, 2022 09:41
Comment on lines +22 to +60
Here is how the response looks like:

```
{
"@context": "/api/v2/contexts/ShippingMethod",
"@id": "/api/v2/shop/shipping-methods",
"@type": "hydra:Collection",
"hydra:member": [
{
"@id": "/api/v2/shop/shipping-methods/ups",
"@type": "ShippingMethod",
"id": 1,
"code": "ups",
"position": 0,
"name": "UPS",
"description": "Quasi perferendis debitis officiis ut inventore exercitationem."
}
],
"hydra:totalItems": 1,
"hydra:search": {
"@type": "hydra:IriTemplate",
"hydra:template": "/api/v2/shop/shipping-methods{?shipmentId,tokenValue}",
"hydra:variableRepresentation": "BasicRepresentation",
"hydra:mapping": [
{
"@type": "IriTemplateMapping",
"variable": "shipmentId",
"property": null,
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "tokenValue",
"property": null,
"required": false
}
]
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

IMHO this example is not necessary

@GSadee GSadee merged commit 584bc76 into Sylius:master Feb 23, 2022
@GSadee
Copy link
Member

GSadee commented Feb 23, 2022

Thank you, Kamil! 🎉

lchrusciel added a commit that referenced this pull request Mar 17, 2022
This PR was merged into the 1.12-dev branch.

Discussion
----------

| Q               | A
| --------------- | -----
| Branch?         | master <!-- see the comment below -->
| Bug fix?        | no
| New feature?    | no
| BC breaks?      | no
| Deprecations?   | no
| Related tickets | PR #13659 #13636
| License         | MIT

<!--
 - Bug fixes must be submitted against the 1.10 or 1.11 branch(the lowest possible)
 - Features and deprecations must be submitted against the master branch
 - Make sure that the correct base branch is set

 To be sure you are not breaking any Backward Compatibilities, check the documentation:
 https://docs.sylius.com/en/latest/book/organization/backward-compatibility-promise.html
-->
There was a wrong parameter names provided in our API UPGRADE file that could cause misunderstanding of the new endpoints

Commits
-------

0d542cb UPGRADE file parameter names fixed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Maintenance CI configurations, READMEs, releases, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants