welcome back to dyb-tech

2024-05-18 02:28:01 +02:00
parent 9513cdba09
commit 9f30bc98c7
6149 changed files with 668407 additions and 0 deletions
@@ -0,0 +1,98 @@
+<?php declare(strict_types=1);
+
+/**
+ * @license Apache 2.0
+ */
+
+namespace OpenApi\Annotations;
+
+use OpenApi\Generator;
+
+/**
+ * @Annotation
+ */
+class Examples extends AbstractAnnotation
+{
+    /**
+     * The relative or absolute path to an example.
+     *
+     * @see [Using refs](https://swagger.io/docs/specification/using-ref/)
+     *
+     * @var string|class-string|object
+     */
+    public $ref = Generator::UNDEFINED;
+
+    /**
+     * The key into `#/components/examples`.
+     *
+     * @var string
+     */
+    public $example = Generator::UNDEFINED;
+
+    /**
+     * Short description for the example.
+     *
+     * @var string
+     */
+    public $summary = Generator::UNDEFINED;
+
+    /**
+     * Embedded literal example.
+     *
+     * The value field and externalValue field are mutually exclusive.
+     *
+     * To represent examples of media types that cannot naturally be represented
+     * in JSON or YAML, use a string value to contain the example, escaping where necessary.
+     *
+     * @var string
+     */
+    public $description = Generator::UNDEFINED;
+
+    /**
+     * Embedded literal example.
+     *
+     * The value field and externalValue field are mutually exclusive.
+     *
+     * To represent examples of media types that cannot naturally be represented
+     * in JSON or YAML, use a string value to contain the example, escaping where necessary.
+     *
+     * @var int|string|array
+     */
+    public $value = Generator::UNDEFINED;
+
+    /**
+     * An URL that points to the literal example.
+     *
+     * This provides the capability to reference examples that cannot easily be included
+     * in JSON or YAML documents.
+     *
+     * The value field and externalValue field are mutually exclusive.
+     *
+     * @var string
+     */
+    public $externalValue = Generator::UNDEFINED;
+
+    public static $_types = [
+        'summary' => 'string',
+        'description' => 'string',
+        'externalValue' => 'string',
+    ];
+
+    public static $_required = ['summary'];
+
+    public static $_parents = [
+        Components::class,
+        Parameter::class,
+        PathParameter::class,
+        MediaType::class,
+        JsonContent::class,
+        XmlContent::class,
+    ];
+
+    /**
+     * @inheritdoc
+     */
+    public static $_nested = [
+        Attachable::class => ['attachables'],
+    ];
+}