apie-lib / openapi-schema

src/Spec/Parameter.php

<?php


namespace Apie\OpenapiSchema\Spec;

use Apie\OpenapiSchema\Concerns\CompositeValueObjectWithExtension;
use Apie\OpenapiSchema\Contract\SchemaContract;
use Apie\OpenapiSchema\Map\ExampleMap;
use Apie\OpenapiSchema\ValueObjects\ParameterIn;
use Apie\ValueObjects\ValueObjectInterface;

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

    /**
     * @var string
     */
    private $name;

    /**
     * @var ParameterIn
     */
    private $in;

    /**
     * @var string|null
     */
    private $description;

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

    /**
     * @var bool|null
     */
    private $required;

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

    /**
     * @var bool|null
     */
    private $deprecated;

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

    /**
     * @var bool|null
     */
    private $allowEmptyValue;

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

    /**
     * @var string|null
     */
    private $style;

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

    /**
     * @var bool|null
     */
    private $explode;

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

    /**
     * @var bool|null
     */
    private $allowReserved;

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

    /**
     * @var SchemaContract|Schema|Reference|null
     */
    private $schema;

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

    /**
     * @var mixed|null
     */
    private $example;

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

    /**
     * @var ExampleMap|null
     */
    private $examples;

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

    /**
     * @var string|MediaType|null
     */
    private $content;

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

    public function __construct(string $name, ParameterIn $in)
    {
        $this->name = $name;
        $this->in = $in;
    }

    /**
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * @return ParameterIn
     */
    public function getIn(): ParameterIn
    {
        return $this->in;
    }
}