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

Update graphql, events & extending docs for Laravel and v4 #2026

Open
wants to merge 13 commits into
base: 4.0
Choose a base branch
from

Conversation

vinceAmstoutz
Copy link
Contributor

The initial aim was to update the core/graphql.md, but I soon realized, with @soyuka's help, that some parts didn't work like that anymore in API Platform 4 (for example the "stages").

So we decided to move and rewrite some parts in core/extending.md and add a warning in core/events.md documentations.

Updated the documentation to reflect the requirement of `use_symfony_listeners: true` for activating event listeners in API Platform 4.0. Also reformatted existing notes for better clarity and added separation lines for improved readability.
This commit introduces detailed documentation on the workflow of state providers and processors in the system. It includes a schema, examples of decorating providers and processors, and specific implementations for both Symfony and Laravel frameworks.
This update adds detailed instructions for enabling and configuring GraphQL in a Laravel environment, complementing the existing Symfony guidance. It covers installation, route configurations, disabling features, custom resolvers, and altering default settings specific to Laravel, ensuring comprehensive and platform-specific documentation.
@vinceAmstoutz vinceAmstoutz force-pushed the docs-update-graphql-support-doc branch from 4a2a8cb to 002cd75 Compare October 3, 2024 10:09
Updated terminology from "stages" to "providers and processors" for better clarity. Removed redundant sections to streamline information on custom mutations and configuration examples.
@vinceAmstoutz vinceAmstoutz force-pushed the docs-update-graphql-support-doc branch from 002cd75 to 8495af2 Compare October 3, 2024 10:10
@vinceAmstoutz vinceAmstoutz changed the title [Core docs] update graphql, events & extending for Laravel and API Platform 4 Update graphql, events & extending docs for Laravel and API Platform 4 Oct 3, 2024
@vinceAmstoutz vinceAmstoutz changed the title Update graphql, events & extending docs for Laravel and API Platform 4 Update graphql, events & extending docs for Laravel and v4 Oct 3, 2024
Copy link
Member

@dunglas dunglas left a comment

Choose a reason for hiding this comment

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

This looks great!

core/extending.md Outdated Show resolved Hide resolved
core/extending.md Outdated Show resolved Hide resolved
core/extending.md Outdated Show resolved Hide resolved
core/extending.md Outdated Show resolved Hide resolved
core/graphql.md Outdated Show resolved Hide resolved
core/graphql.md Outdated Show resolved Hide resolved
core/graphql.md Show resolved Hide resolved
core/graphql.md Outdated Show resolved Hide resolved
core/graphql.md Outdated Show resolved Hide resolved
core/graphql.md Outdated Show resolved Hide resolved
vinceAmstoutz and others added 7 commits October 3, 2024 13:27
Co-authored-by: Kévin Dunglas <[email protected]>
Co-authored-by: Kévin Dunglas <[email protected]>
Co-authored-by: Kévin Dunglas <[email protected]>
Co-authored-by: Kévin Dunglas <[email protected]>
Co-authored-by: Kévin Dunglas <[email protected]>
Co-authored-by: Kévin Dunglas <[email protected]>
Copy link
Member

@soyuka soyuka left a comment

Choose a reason for hiding this comment

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

Nice, on graphql we also need to document how to secure routes using a middleware and probably also document policies.


### Symfony Access Checker Provider

When using Symfony, the access checker provider is used at three different stages:
Copy link
Member

Choose a reason for hiding this comment

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

This is only for rest I think

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For this one, do you want to add somewhere that it's only for REST?

core/extending.md Outdated Show resolved Hide resolved
core/extending.md Outdated Show resolved Hide resolved
core/extending.md Outdated Show resolved Hide resolved
@vinceAmstoutz
Copy link
Contributor Author

Nice, on graphql we also need to document how to secure routes using a middleware and probably also document policies.

Thanks, please let me know more about what's missing before we can merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants