fix: 2.7 and 3.0 metadata system #1519

soyuka · 2022-03-15T15:52:59Z

TODO:

state providers
state processors

alanpoulain · 2022-03-15T16:00:02Z

core/graphql.md

-#[ApiResource]
-#[Query]
-#[Mutation(name: 'create')]
+#[ApiResource(graphQlOperations: [


Why using graphQlOperations?

alanpoulain · 2022-03-16T10:30:29Z

core/dto.md


 However, it's sometimes useful to use a specific class to represent the input or output data structure related to an operation.

-## Specifying an Input or an Output Data Representation
+## Implementing a write operation with an input different from the resource


Suggested change

## Implementing a write operation with an input different from the resource

## Implementing a Write Operation With an Input Different From the Resource

alanpoulain · 2022-03-16T10:31:22Z

core/dto.md

+
+```php
+<?php
+// api/src/Model/UserResetPasswordDto.php


Suggested change

// api/src/Model/UserResetPasswordDto.php

// api/src/Model/User.php

alanpoulain · 2022-03-16T10:32:12Z

core/dto.md

+        throw new NotFoundHttpException();
+    }
+
+     public function resumable(?string $operationName = null, array $context = []): bool {


Suggested change

public function resumable(?string $operationName = null, array $context = []): bool {

public function resumable(?string $operationName = null, array $context = []): bool

{

alanpoulain · 2022-03-16T10:32:46Z

core/dto.md

+}
+```
+
+## Implementing a read operation with an output different from the resource


Suggested change

## Implementing a read operation with an output different from the resource

## Implementing a Read Operation With an Output Different From the Resource

alanpoulain · 2022-03-16T10:33:13Z

core/dto.md

+
+final class BookRepresentationProvider implements ProviderInterface
+{
+    public function provide(string $resourceClass, array $identifiers = [], ?string $operationName = null, array $context = []) {


Suggested change

public function provide(string $resourceClass, array $identifiers = [], ?string $operationName = null, array $context = []) {

public function provide(string $resourceClass, array $identifiers = [], ?string $operationName = null, array $context = [])

{

alanpoulain · 2022-03-16T10:36:49Z

core/identifiers.md

        return $resourceClass === Person::class;
-    }
+     }


Suggested change

}

}

alanpoulain · 2022-03-16T10:36:59Z

core/identifiers.md

+     public function supports(string $resourceClass, array $identifiers = [], ?string $operationName = null, array $context = []): bool
+     {


Suggested change

public function supports(string $resourceClass, array $identifiers = [], ?string $operationName = null, array $context = []): bool

{

public function supports(string $resourceClass, array $identifiers = [], ?string $operationName = null, array $context = []): bool

{

alanpoulain · 2022-03-16T10:37:25Z

core/identifiers.md

 }
 ```

-To cover this use case, we need to `denormalize` the identifier to an instance of our `App\Uuid` class. This case is covered by an identifier denormalizer:
+To cover this use case, we need to `convert` the identifier to an instance of our `App\Uuid` class. This case is covered by an uri variable transformer:


Suggested change

To cover this use case, we need to `convert` the identifier to an instance of our `App\Uuid` class. This case is covered by an uri variable transformer:

To cover this use case, we need to `transform` the identifier to an instance of our `App\Uuid` class. This case is covered by an uri variable transformer:

alanpoulain · 2022-03-16T10:39:31Z

core/identifiers.md


    /**
-     * {@inheritdoc}
+     * Checks whether the given class is supported for denormalization by this normalizer.


Suggested change

* Checks whether the given class is supported for denormalization by this normalizer.

* Checks whether the given uri variable is supported for transformation by this transformer.

alanpoulain · 2022-03-16T10:40:23Z

core/identifiers.md

 {
    /**
-     * {@inheritdoc}
+     * Denormalizes data back into an object of the given class.


Suggested change

* Denormalizes data back into an object of the given class.

* Transforms a uri variable value.

alanpoulain · 2022-03-16T10:42:31Z

core/security.md

@@ -343,4 +347,4 @@ section.

 ## Changing Serialization Groups Depending of the Current User

-See [how to dynamically change](serialization.md#changing-the-serialization-context-dynamically) the current Serializer context according to the current logged in user.
+See [how 


alanpoulain · 2022-03-16T10:43:18Z

core/subresources.md

-The starting point of a subresource must be a relation on an existing resource.
-For example, let's create two entities (Question, Answer) and set up a subresource so that `/question/42/answer` gives us
-the answer to the question 42:
+## URI variables configuration


Suggested change

## URI variables configuration

## URI Variables Configuration

alanpoulain · 2022-03-16T10:45:04Z

core/subresources.md

-In the previous examples, the `method` attribute is mandatory, because the operation name doesn't match a supported HTTP
-method.
+In this example, we instructed API Platform that the `Answer` we retrieve comes **from** the **class** `Question` 
+**from** the **propety** `answer` of that class.


Suggested change

**from** the **propety** `answer` of that class.

**from** the **property** `answer` of that class.

alanpoulain · 2022-03-16T10:45:49Z

core/subresources.md

 ```

-### Access Control of Subresources
+### Company employee's


Suggested change

### Company employee's

### Company Employee's

alanpoulain · 2022-03-16T10:46:53Z

core/subresources.md

-
-You can control depth of subresources with the parameter `maxDepth`. For example, if the `Answer` entity also has a subresource
-such as `comments` and you don't want the route `api/questions/{id}/answers/{id}/comments` to be generated. You can do this by adding the parameter maxDepth in the ApiSubresource annotation or YAML/XML file configuration.
+Now lets add the Company class:


Suggested change

Now lets add the Company class:

Now let's add the Company class:

alanpoulain · 2022-03-16T10:47:51Z

core/subresources.md

+}
+```
+
+We did not define any Doctrine annotation here and if we want thinks to work properly with GraphQl, we need to map the `employees` field as a Link to the class `Employee` using the property `company`.


Suggested change

We did not define any Doctrine annotation here and if we want thinks to work properly with GraphQl, we need to map the `employees` field as a Link to the class `Employee` using the property `company`.

We did not define any Doctrine annotation here and if we want thinks to work properly with GraphQL, we need to map the `employees` field as a Link to the class `Employee` using the property `company`.

alanpoulain · 2022-03-16T10:48:18Z

core/subresources.md

+
+We did not define any Doctrine annotation here and if we want thinks to work properly with GraphQl, we need to map the `employees` field as a Link to the class `Employee` using the property `company`.
+
+As a general rule, if the property we want to crete a link from is in the `fromClass`, use `fromProperty`, if not, use `toProperty`.


Suggested change

As a general rule, if the property we want to crete a link from is in the `fromClass`, use `fromProperty`, if not, use `toProperty`.

As a general rule, if the property we want to create a link from is in the `fromClass`, use `fromProperty`, if not, use `toProperty`.

core/subresources.md

alanpoulain · 2022-03-16T10:49:23Z

core/upgrade-guide.md

@@ -0,0 +1,145 @@
+# Upgrade guide


Suggested change

# Upgrade guide

# Upgrade Guide

alanpoulain · 2022-03-16T10:50:05Z

core/upgrade-guide.md

@@ -0,0 +1,145 @@
+# Upgrade guide
+
+## What changed between 2.6 and 2.7?


Suggested change

## What changed between 2.6 and 2.7?

## What Has Changed Between 2.6 And 2.7?

alanpoulain · 2022-03-16T10:53:12Z

core/upgrade-guide.md

+
+You can use the `api:upgrade-resource` command to upgrade your resources automatically, [see instructions here](#the-upgrade-command).
+
+### Removal of item/collection operations


Suggested change

### Removal of item/collection operations

### Removal of Item/Collection Operations

core/state-processors.md

alanpoulain · 2022-03-29T09:46:36Z

core/state-processors.md

+
+    public function process($data, array $identifiers = [], ?string $operationName = null, array $context = [])
+    {
+        $result = $this->decorated->persist($data, $context);


Suggested change

$result = $this->decorated->persist($data, $context);

$result = $this->decorated->process($data, $identifiers, $operationName, $context);

core/state-providers.md

alanpoulain · 2022-03-29T09:52:03Z

core/state-providers.md

+final class BlogPostStateProvider implements ProviderInterface
+{
+    /**
+     * Provides data.


inheritDoc?

alanpoulain · 2022-03-29T09:52:32Z

core/state-processors.md

+        $this->mailer = $mailer;
+    }
+
+    public function process($data, array $identifiers = [], ?string $operationName = null, array $context = [])


uriVariables?

alanpoulain · 2022-03-29T09:52:44Z

core/state-processors.md

+        return $result;
+    }
+
+    public function supports($data, array $identifiers = [], ?string $operationName = null, array $context = []): bool


uriVariables?

core/state-providers.md

alanpoulain · 2022-03-29T09:54:28Z

core/state-providers.md

+services:
+    # ...
+    'App\DataProvider\BlogPostStateProvider':
+        tags: [ { name: 'api_platform.state_provider', priority: 2 } ]


priority in comment since it's not the default configuration?

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

alanpoulain reviewed Mar 15, 2022

View reviewed changes

alanpoulain reviewed Mar 16, 2022

View reviewed changes

core/identifiers.md Outdated

return $resourceClass === Person::class;

}

}

Copy link

Member

alanpoulain Mar 16, 2022

Choose a reason for hiding this comment

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

Suggested change

}

}

alanpoulain reviewed Mar 16, 2022

View reviewed changes

core/subresources.md Outdated Show resolved Hide resolved

alanpoulain reviewed Mar 16, 2022

View reviewed changes

core/upgrade-guide.md Outdated

@@ -0,0 +1,145 @@

# Upgrade guide

Copy link

Member

alanpoulain Mar 16, 2022

Choose a reason for hiding this comment

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

Suggested change

# Upgrade guide

# Upgrade Guide

alanpoulain reviewed Mar 16, 2022

View reviewed changes

doc: new metadata

7899078

soyuka force-pushed the fix-metadata-3 branch from f4a1670 to 7899078 Compare March 16, 2022 11:32

soyuka changed the title ~~fix: API Platform 2.7|3.0 metadata system~~ fix: 2.7 and 3.0 metadata system Mar 16, 2022

soyuka added 3 commits March 17, 2022 17:29

State processors/providers

940f8a6

bump

361d845

fix links

d4ad3e0

soyuka force-pushed the fix-metadata-3 branch from 39a0dff to d4ad3e0 Compare March 28, 2022 14:15

lint

9b45216

lint

9822dc4