apie-lib / openapi-schema

src/Spec/Document.php

<?php


namespace Apie\OpenapiSchema\Spec;

use Apie\OpenapiSchema\Concerns\CompositeValueObjectWithExtension;
use Apie\OpenapiSchema\Contract\InfoContract;
use Apie\OpenapiSchema\Map\SecurityRequirementList;
use Apie\OpenapiSchema\Map\ServerList;
use Apie\OpenapiSchema\Map\TagList;
use Apie\OpenapiSchema\ValueObjects\OpenApiVersion;
use Apie\ValueObjects\ValueObjectInterface;

/**
 * @see https://swagger.io/specification/#openapi-object
 */
final class Document implements ValueObjectInterface
{
    use CompositeValueObjectWithExtension;

The trait Apie\OpenapiSchema\Concerns\CompositeValueObjectWithExtension requires the property $name which is not provided by Apie\OpenapiSchema\Spec\Document.

    /**
     * @var OpenApiVersion
     */
    private $openapi;

    /**
     * @var InfoContract|Info
     */
    private $info;

    /**
     * @var ServerList|null
     */
    private $servers;

The private property $servers is not used, and could be removed.

    /**
     * @var Paths
     */
    private $paths;

    /**
     * @var Components|null
     */
    private $components;

    /**
     * @var SecurityRequirementList|null
     */
    private $security;

The private property $security is not used, and could be removed.

    /**
     * @var TagList|null
     */
    private $tags;

The private property $tags is not used, and could be removed.

    /**
     * @var ExternalDocs|null
     */
    private $externalDocs;

The private property $externalDocs is not used, and could be removed.

    public function __construct(InfoContract $info, Paths $paths)
    {
        $this->openapi = new OpenApiVersion('');
        $this->info = $info;
        $this->paths = $paths;
    }

    /**
     * @return Paths
     */
    public function getPaths(): Paths
    {
        return $this->paths;
    }

    /**
     * @return Components|null
     */
    public function getComponents(): ?Components
    {
        return $this->components;
    }
}