Separate update schema

Author: tobyzerner

src/Endpoint/Update.php

@@ -78,6 +78,11 @@ public function handle(Context $context): ?ResponseInterface
 
     public function getOpenApiPaths(Collection $collection): array
     {
+        $resourcesUpdate = array_map(
+            fn($resource) => ['$ref' => "#/components/schemas/{$resource}Update"],
+            $collection->resources(),
+        );
+
         $resources = array_map(
             fn($resource) => [
                 '$ref' => "#/components/schemas/$resource",
@@ -106,9 +111,9 @@ public function getOpenApiPaths(Collection $collection): array
                                     'required' => ['data'],
                                     'properties' => [
                                         'data' =>
-                                            count($resources) === 1
-                                                ? $resources[0]
-                                                : ['oneOf' => $resources],
+                                            count($resourcesUpdate) === 1
+                                                ? $resourcesUpdate[0]
+                                                : ['oneOf' => $resourcesUpdate],
                                     ],
                                 ],
                             ],

src/OpenApi/OpenApiGenerator.php

@@ -45,34 +45,71 @@ public function generate(JsonApi $api): array
 
         foreach ($api->resources as $resource) {
             $schema = ['attributes' => [], 'relationships' => []];
+            $writableSchema = ['attributes' => [], 'relationships' => []];
 
             foreach ($resource->fields() as $field) {
                 $schema[location($field)]['properties'][$field->name] = $field->getSchema($api);
+                $schema[location($field)]['required'][] = $field->name;
 
-                if ($field->required) {
-                    $schema[location($field)]['required'][] = $field->name;
+                if ($field->writable) {
+                    $writableSchema[location($field)]['properties'][
+                        $field->name
+                    ] = $field->getSchema($api);
+
+                    if ($field->required) {
+                        $writableSchema[location($field)]['required'][] = $field->name;
+                    }
                 }
             }
 
+            $schemas[$resource->type()] = [
+                'type' => 'object',
+                'required' => ['type', 'id'],
+                'properties' => [
+                    'type' => ['type' => 'string', 'const' => $resource->type()],
+                    'id' => ['type' => 'string', 'readOnly' => true],
+                    ...$schema['attributes']
+                        ? ['attributes' => ['type' => 'object'] + $schema['attributes']]
+                        : [],
+                    ...$schema['relationships']
+                        ? ['relationships' => ['type' => 'object'] + $schema['relationships']]
+                        : [],
+                ],
+            ];
+
             $schemas["{$resource->type()}Create"] = [
                 'type' => 'object',
                 'required' => ['type'],
                 'properties' => [
                     'type' => ['type' => 'string', 'const' => $resource->type()],
                     'id' => ['type' => 'string'],
-                    'attributes' => ['type' => 'object'] + $schema['attributes'],
-                    'relationships' => ['type' => 'object'] + $schema['relationships'],
+                    ...$writableSchema['attributes']
+                        ? ['attributes' => ['type' => 'object'] + $writableSchema['attributes']]
+                        : [],
+                    ...$writableSchema['relationships']
+                        ? [
+                            'relationships' =>
+                                ['type' => 'object'] + $writableSchema['relationships'],
+                        ]
+                        : [],
                 ],
             ];
 
-            $schemas[$resource->type()] = [
+            $schemas["{$resource->type()}Update"] = [
                 'type' => 'object',
                 'required' => ['type', 'id'],
                 'properties' => [
                     'type' => ['type' => 'string', 'const' => $resource->type()],
-                    'id' => ['type' => 'string', 'readOnly' => true],
-                    'attributes' => ['type' => 'object'] + $schema['attributes'],
-                    'relationships' => ['type' => 'object'] + $schema['relationships'],
+                    'id' => ['type' => 'string'],
+                    ...$writableSchema['attributes']
+                        ? ['attributes' => ['type' => 'object'] + $writableSchema['attributes']]
+                        : [],
+                    ...$writableSchema['relationships']
+                        ? [
+                            'relationships' =>
+                                ['type' => 'object'] + $writableSchema['relationships'],
+                        ]
+                        : [],
                 ],
             ];
         }