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] Add and improve new api docs #12599

Merged
merged 3 commits into from May 7, 2021

Conversation

AdamKasp
Copy link
Contributor

@AdamKasp AdamKasp commented May 5, 2021

Q A
Branch? master
Bug fix? no
License MIT

@AdamKasp AdamKasp added Documentation Documentation related issues and PRs - requests, fixes, proposals. API APIs related issues and PRs. labels May 5, 2021
@AdamKasp AdamKasp requested a review from a team as a code owner May 5, 2021 09:49
docs/customization/api.rst Outdated Show resolved Hide resolved
docs/customization/api.rst Outdated Show resolved Hide resolved
docs/customization/api.rst Outdated Show resolved Hide resolved
docs/customization/api.rst Outdated Show resolved Hide resolved
docs/customization/api.rst Outdated Show resolved Hide resolved
docs/customization/api.rst Outdated Show resolved Hide resolved
==================================

Let's assume that your shop offer only digital products so you don't need setting shipment method at all.
To remove endpoint you only need to delete unnecessary configuration from ``config/api_platform/Order.xml``
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this sentence true? I mean we have some underlying logic that changes states of cart and checkout. Speaking of endpoint only POV, well we can just remove the endpoint and go drink some margarita 🍸 , but I don't think we can finish checkout process 🙁

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, but actually no :D
if you have only one shipping method and enabled option Skip shipping step if only one shipping method is available? on the channel, while checkout you don't need to set shipping method :)
you can check how it works on UI :)

docs/customization/api.rst Outdated Show resolved Hide resolved
docs/customization/api.rst Outdated Show resolved Hide resolved
docs/customization/api.rst Outdated Show resolved Hide resolved
docs/api/unified_api/sylius_api_paths.rst Outdated Show resolved Hide resolved
docs/customization/api.rst Outdated Show resolved Hide resolved
docs/customization/api.rst Outdated Show resolved Hide resolved
docs/customization/api.rst Outdated Show resolved Hide resolved
docs/customization/api.rst Outdated Show resolved Hide resolved
docs/customization/api.rst Outdated Show resolved Hide resolved
docs/customization/api.rst Outdated Show resolved Hide resolved
docs/customization/api.rst Outdated Show resolved Hide resolved
docs/customization/api.rst Outdated Show resolved Hide resolved
docs/customization/api.rst Show resolved Hide resolved
@AdamKasp AdamKasp force-pushed the add-and-improve-new-api-docs branch from 05db891 to 95b0f0a Compare May 6, 2021 08:52
docs/customization/api.rst Outdated Show resolved Hide resolved
docs/customization/api.rst Outdated Show resolved Hide resolved
docs/customization/api.rst Outdated Show resolved Hide resolved
@AdamKasp AdamKasp force-pushed the add-and-improve-new-api-docs branch from 95b0f0a to 004f4e1 Compare May 7, 2021 06:19
@GSadee GSadee merged commit 2ec679d into Sylius:master May 7, 2021
@GSadee
Copy link
Member

GSadee commented May 7, 2021

Thanks, Adam! 🥇

Comment on lines +15 to +24
# config/packages/api_platform.yaml
api_platform:
mapping:
paths:
- '%kernel.project_dir%/vendor/sylius/sylius/src/Sylius/Bundle/ApiBundle/Resources/config/api_resources'
- '%kernel.project_dir%/config/api_platform'
patch_formats:
json: ['application/merge-patch+json']
swagger:
versions: [3]
Copy link
Member

Choose a reason for hiding this comment

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

Can we provide this config in Sylius Standard?

GSadee added a commit that referenced this pull request May 20, 2021
…tency (CoderMaggie)

This PR was merged into the 1.10-dev branch.

Discussion
----------

| Q               | A
| --------------- | -----
| Branch?         | master
| Doc fix?        | yes #12599 
| License         | MIT

Commits
-------

3e498bd Fix Customizing API doc headers inconsistency
@AdamKasp AdamKasp deleted the add-and-improve-new-api-docs branch July 19, 2021 06:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API APIs related issues and PRs. Documentation Documentation related issues and PRs - requests, fixes, proposals.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants