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,87 @@
+<?php declare(strict_types=1);
+
+/**
+ * @license Apache 2.0
+ */
+
+namespace OpenApi\Annotations;
+
+use OpenApi\Generator;
+
+/**
+ * An object representing a server.
+ *
+ * @see [OAI Server Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-object)
+ *
+ * @Annotation
+ */
+class Server extends AbstractAnnotation
+{
+    /**
+     * An URL to the target host.
+     *
+     * This URL supports Server Variables and may be relative,
+     * to indicate that the host location is relative to the location where the OpenAPI document is being served.
+     * Variable substitutions will be made when a variable is named in {brackets}.
+     *
+     * @var string
+     */
+    public $url = Generator::UNDEFINED;
+
+    /**
+     * An optional string describing the host designated by the URL.
+     *
+     * CommonMark syntax may be used for rich text representation.
+     *
+     * @var string
+     */
+    public $description = Generator::UNDEFINED;
+
+    /**
+     * A map between a variable name and its value.
+     *
+     * The value is used for substitution in the server's URL template.
+     *
+     * @var ServerVariable[]
+     */
+    public $variables = Generator::UNDEFINED;
+
+    /**
+     * @inheritdoc
+     */
+    public static $_parents = [
+        OpenApi::class,
+        PathItem::class,
+        Operation::class,
+        Get::class,
+        Post::class,
+        Put::class,
+        Delete::class,
+        Patch::class,
+        Head::class,
+        Options::class,
+        Trace::class,
+        Link::class,
+    ];
+
+    /**
+     * @inheritdoc
+     */
+    public static $_nested = [
+        ServerVariable::class => ['variables', 'serverVariable'],
+        Attachable::class => ['attachables'],
+    ];
+
+    /**
+     * @inheritdoc
+     */
+    public static $_required = ['url'];
+
+    /**
+     * @inheritdoc
+     */
+    public static $_types = [
+        'url' => 'string',
+        'description' => 'string',
+    ];
+}