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

[DOCS] API custom logic example #12627

Merged
merged 3 commits into from May 14, 2021
Merged

Conversation

arti0090
Copy link
Contributor

Q A
Branch? master
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
License MIT

@arti0090 arti0090 requested a review from a team as a code owner May 12, 2021 11:26
@probot-autolabeler probot-autolabeler bot added the Documentation Documentation related issues and PRs - requests, fixes, proposals. label May 12, 2021
@arti0090 arti0090 force-pushed the api-custom-logic-doc branch 2 times, most recently from 2f84962 to 155afb2 Compare May 12, 2021 12:10
@AdamKasp
Copy link
Contributor

And IMO you should also mention that this customization will work with API without any extra steps

docs/getting-started-with-sylius/custom-business-logic.rst Outdated Show resolved Hide resolved
Comment on lines +157 to +159
"shippingState": "string",
"tokenValue": "CART_TOKEN",
"id": 123,
Copy link
Member

@GSadee GSadee May 13, 2021

Choose a reason for hiding this comment

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

I wonder if we shouldn't show the whole response

@GSadee GSadee merged commit 962ef7a into Sylius:master May 14, 2021
@GSadee
Copy link
Member

GSadee commented May 14, 2021

Thank you, @arti0090! 🎉

GSadee added a commit that referenced this pull request May 14, 2021
…arti0090)

This PR was merged into the 1.10-dev branch.

Discussion
----------

| Q               | A
| --------------- | -----
| Branch?         |  master
| Bug fix?        | no
| New feature?    | no
| BC breaks?      | no
| Deprecations?   | no
| Related tickets | improves #12627 
| License         | MIT
![Zrzut ekranu 2021-05-14 o 07 42 42](https://user-images.githubusercontent.com/35863747/118227970-b7141d00-b489-11eb-82e4-b7e3bc4ba83d.png)

The response in those endpoints are quite long and json codeblock does not let us use comments. I changed them to javascript (which does no change to UI/UX of docs) and added comments, so this would cut out confusion why responses are so short.

Commits
-------

1b1d258 [DOCS] Change response codeblocks to be more clarified
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation related issues and PRs - requests, fixes, proposals.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants