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

vinceAmstoutz · 2024-10-03T09:23:15Z

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.

Updated terminology from "stages" to "providers and processors" for better clarity. Removed redundant sections to streamline information on custom mutations and configuration examples.

dunglas

This looks great!

core/extending.md

core/graphql.md

Co-authored-by: Kévin Dunglas <[email protected]>

soyuka

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

core/extending.md

vinceAmstoutz · 2024-10-03T15:05:16Z

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.

core/extending.md

core/events.md

core/extending.md

core/graphql.md

Co-authored-by: Antoine Bluchet <[email protected]>

core/extending.md

core/graphql.md

Co-authored-by: Antoine Bluchet <[email protected]>

Co-authored-by: Alan Poulain <[email protected]>

…iewed

vinceAmstoutz · 2024-10-04T09:38:57Z

@soyuka @alanpoulain Reviewed changes resolved!

core/graphql.md

Co-authored-by: Alan Poulain <[email protected]>

alanpoulain

Don't forget to squash!

core/graphql.md

soyuka · 2024-10-04T13:00:05Z

Nice thanks!

vinceAmstoutz added 4 commits October 3, 2024 11:15

Remove specific framework & Docker for GraphQL installation commands

060b4a6

vinceAmstoutz force-pushed the docs-update-graphql-support-doc branch from 4a2a8cb to 002cd75 Compare October 3, 2024 10:09

Refactor GraphQL & extending documentations for clarity and accuracy

8495af2

Updated terminology from "stages" to "providers and processors" for better clarity. Removed redundant sections to streamline information on custom mutations and configuration examples.

vinceAmstoutz force-pushed the docs-update-graphql-support-doc branch from 002cd75 to 8495af2 Compare October 3, 2024 10:10

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

dunglas reviewed Oct 3, 2024

View reviewed changes

vinceAmstoutz and others added 7 commits October 3, 2024 13:27

Fix capitalize title

044156e

Co-authored-by: Kévin Dunglas <[email protected]>

Fix capitalize title

f51aa64

Co-authored-by: Kévin Dunglas <[email protected]>

Fix capitalize title

d88be0d

Co-authored-by: Kévin Dunglas <[email protected]>

Fix capitalize title

8df3eeb

Co-authored-by: Kévin Dunglas <[email protected]>

Fix title

c077e4d

Co-authored-by: Kévin Dunglas <[email protected]>

Fix title

1e5733d

Co-authored-by: Kévin Dunglas <[email protected]>

Fix titles and coding style

e4f4605

vinceAmstoutz requested a review from dunglas October 3, 2024 11:34

soyuka reviewed Oct 3, 2024

View reviewed changes

core/extending.md 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

Fix wrong implementation & rm duplicate code

0f7d85b

vinceAmstoutz requested a review from soyuka October 3, 2024 15:06

soyuka reviewed Oct 4, 2024

View reviewed changes

core/extending.md Show resolved Hide resolved

soyuka reviewed Oct 4, 2024

View reviewed changes

core/events.md Show resolved Hide resolved

soyuka requested changes Oct 4, 2024

View reviewed changes

vinceAmstoutz and others added 5 commits October 4, 2024 10:01

Fix spelling and class rendering

6d8fa0f

Co-authored-by: Antoine Bluchet <[email protected]>

Fix title with a better title name

4881372

Co-authored-by: Antoine Bluchet <[email protected]>

Fix title with a better title name

8817275

Co-authored-by: Antoine Bluchet <[email protected]>

Fix remove unused method

dab74c7

Co-authored-by: Antoine Bluchet <[email protected]>

Fix remove unused method

2420773

Co-authored-by: Antoine Bluchet <[email protected]>

Fix remove unused method

b8e244e

Co-authored-by: Antoine Bluchet <[email protected]>

alanpoulain reviewed Oct 4, 2024

View reviewed changes

vinceAmstoutz and others added 12 commits October 4, 2024 10:05

Fix by rephrasing not available commands message

c97e010

Co-authored-by: Antoine Bluchet <[email protected]>

Fix better explanations to enable GraphQL

48c5c96

Co-authored-by: Antoine Bluchet <[email protected]>

Fix remove unused declaration in the Laravel container

5876275

Co-authored-by: Antoine Bluchet <[email protected]>

Fix typo

5faa513

Co-authored-by: Alan Poulain <[email protected]>

Fix typo

52903a3

Co-authored-by: Alan Poulain <[email protected]>

Fix spelling

6b6e7a4

Co-authored-by: Alan Poulain <[email protected]>

Fix typo

fe8941c

Co-authored-by: Alan Poulain <[email protected]>

Fix typo

b7b20fd

Co-authored-by: Alan Poulain <[email protected]>

Fix missing var assignation

f451b87

Co-authored-by: Alan Poulain <[email protected]>

Add recommendation for using system providers and processors

a7ef500

Add GraphQL state provider access checker notes & cleanup

a713745

Completes GraphQL doc for Laravel support & clarified some points rev…

ace7aeb

…iewed

vinceAmstoutz requested review from soyuka and alanpoulain October 4, 2024 09:39

alanpoulain reviewed Oct 4, 2024

View reviewed changes

core/graphql.md Outdated Show resolved Hide resolved

Fix string syntax error

a70e3b7

Co-authored-by: Alan Poulain <[email protected]>

vinceAmstoutz requested a review from alanpoulain October 4, 2024 10:31

alanpoulain approved these changes Oct 4, 2024

View reviewed changes

soyuka reviewed Oct 4, 2024

View reviewed changes

core/graphql.md Outdated Show resolved Hide resolved

Apply suggestions from code review

07f6032

soyuka merged commit d84cd2f into api-platform:4.0 Oct 4, 2024
1 check passed

vinceAmstoutz deleted the docs-update-graphql-support-doc branch October 4, 2024 13:07

Uh oh!

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

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

Uh oh!

Conversation

vinceAmstoutz commented Oct 3, 2024

Uh oh!

dunglas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

soyuka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vinceAmstoutz commented Oct 3, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vinceAmstoutz commented Oct 4, 2024

Uh oh!

Uh oh!

alanpoulain left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

soyuka commented Oct 4, 2024

Uh oh!

Uh oh!