Update some doc on API

benjaminjonard · Jun 9, 2024 · 311be50 · 311be50
1 parent 6ce45fe
commit 311be50
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/src/Entity/Datum.php b/src/Entity/Datum.php
@@ -4,6 +4,7 @@
 
 namespace App\Entity;
 
+use ApiPlatform\Metadata\ApiProperty;
 use ApiPlatform\Metadata\ApiResource;
 use ApiPlatform\Metadata\Delete;
 use ApiPlatform\Metadata\Get;
@@ -74,11 +75,22 @@ class Datum implements VisibleInterface, \Stringable
     #[Groups(['datum:read', 'datum:write'])]
     #[Assert\NotBlank]
     #[Assert\Choice(choices: DatumTypeEnum::TYPES)]
+    #[ApiProperty(
+        openapiContext: [
+            'example' => 'text, textarea, country, date, rating, number, link, list, choice-list, checkbox, image, file, sign, video'
+        ]
+    )]
     private ?string $type = null;
 
     #[ORM\Column(type: Types::STRING, nullable: true)]
     #[Groups(['datum:read', 'datum:write'])]
     #[Assert\NotBlank]
+    #[ApiProperty(
+        openapiContext: [
+            'type' => 'string',
+            'example' => 'See wiki: https://github.com/benjaminjonard/koillection/wiki/API#example-values-for-data-fields'
+        ]
+    )]
     private ?string $label = null;
 
     #[ORM\Column(type: Types::TEXT, nullable: true)]

diff --git a/src/Enum/DatumTypeEnum.php b/src/Enum/DatumTypeEnum.php
@@ -50,6 +50,7 @@ class DatumTypeEnum
         self::TYPE_IMAGE,
         self::TYPE_FILE,
         self::TYPE_SIGN,
+        self::TYPE_VIDEO,
     ];
 
     public const array TEXT_TYPES = [