vendor/api-platform/core/src/OpenApi/OpenApi.php line 22

  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace ApiPlatform\OpenApi;
  16. use ApiPlatform\Documentation\DocumentationInterface;
  17. use ApiPlatform\OpenApi\Model\Components;
  18. use ApiPlatform\OpenApi\Model\ExtensionTrait;
  19. use ApiPlatform\OpenApi\Model\Info;
  20. use ApiPlatform\OpenApi\Model\Paths;
  22. final class OpenApi implements DocumentationInterface
  23. {
  24.     use ExtensionTrait;
  26.     // We're actually supporting 3.1 but swagger ui has a version constraint
  27.     // public const VERSION = '3.1.0';
  28.     public const VERSION = '3.0.0';
  30.     private string $openapi = self::VERSION;
  32.     public function __construct(private Info $info, private array $servers, private Paths $paths, private ?Components $components = null, private array $security = [], private array $tags = [], private $externalDocs = null, private ?string $jsonSchemaDialect = null, private readonly ?\ArrayObject $webhooks = null)
  33.     {
  34.     }
  36.     public function getOpenapi(): string
  37.     {
  38.         return $this->openapi;
  39.     }
  41.     public function getInfo(): Info
  42.     {
  43.         return $this->info;
  44.     }
  46.     public function getServers(): array
  47.     {
  48.         return $this->servers;
  49.     }
  51.     public function getPaths(): Paths
  52.     {
  53.         return $this->paths;
  54.     }
  56.     public function getComponents(): Components
  57.     {
  58.         return $this->components;
  59.     }
  61.     public function getSecurity(): array
  62.     {
  63.         return $this->security;
  64.     }
  66.     public function getTags(): array
  67.     {
  68.         return $this->tags;
  69.     }
  71.     public function getExternalDocs(): ?array
  72.     {
  73.         return $this->externalDocs;
  74.     }
  76.     public function getJsonSchemaDialect(): ?string
  77.     {
  78.         return $this->jsonSchemaDialect;
  79.     }
  81.     public function getWebhooks(): ?\ArrayObject
  82.     {
  83.         return $this->webhooks;
  84.     }
  86.     public function withOpenapi(string $openapi): self
  87.     {
  88.         $clone = clone $this;
  89.         $clone->openapi = $openapi;
  91.         return $clone;
  92.     }
  94.     public function withInfo(Info $info): self
  95.     {
  96.         $clone = clone $this;
  97.         $clone->info = $info;
  99.         return $clone;
  100.     }
  102.     public function withServers(array $servers): self
  103.     {
  104.         $clone = clone $this;
  105.         $clone->servers = $servers;
  107.         return $clone;
  108.     }
  110.     public function withPaths(Paths $paths): self
  111.     {
  112.         $clone = clone $this;
  113.         $clone->paths = $paths;
  115.         return $clone;
  116.     }
  118.     public function withComponents(Components $components): self
  119.     {
  120.         $clone = clone $this;
  121.         $clone->components = $components;
  123.         return $clone;
  124.     }
  126.     public function withSecurity(array $security): self
  127.     {
  128.         $clone = clone $this;
  129.         $clone->security = $security;
  131.         return $clone;
  132.     }
  134.     public function withTags(array $tags): self
  135.     {
  136.         $clone = clone $this;
  137.         $clone->tags = $tags;
  139.         return $clone;
  140.     }
  142.     public function withExternalDocs(array $externalDocs): self
  143.     {
  144.         $clone = clone $this;
  145.         $clone->externalDocs = $externalDocs;
  147.         return $clone;
  148.     }
  150.     public function withJsonSchemaDialect(?string $jsonSchemaDialect): self
  151.     {
  152.         $clone = clone $this;
  153.         $clone->jsonSchemaDialect = $jsonSchemaDialect;
  155.         return $clone;
  156.     }
  157. }