erasys\OpenApi\Spec\v3\Operation

Complexity

Total Complexity

1

Size/Duplication

Total Lines	163
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1

<?php

namespace erasys\OpenApi\Spec\v3;

/**
 * Describes a single API operation on a path.
 *
 * @see https://swagger.io/specification/#operationObject
 */
class Operation extends AbstractObject implements ExtensibleInterface
{
    /**
     * REQUIRED. The list of possible responses as they are returned from executing this operation.
     *
     * Map between the response HTTP status code (as a string) and the definition object.
     *
     * The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be
     * known in advance. However, documentation is expected to cover a successful operation response and any known
     * errors. The "default" code MAY be used as a default response object for all HTTP codes that are not covered
     * individually by the specification.
     *
     * The Responses Object MUST contain at least one response code, and it SHOULD be the response for a successful
     * operation call.
     *
     * Any HTTP status code can be used as the property name, but only one property per code, to describe the
     * expected response for that HTTP status code. A Reference Object can link to a response that is defined in the
     * OpenAPI Object's components/responses section. This field MUST be enclosed in quotation marks (for example,
     * "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the
     * uppercase wildcard character X. For example, 2XX represents all response codes between [200-299]. The following
     * range definitions are allowed: 1XX, 2XX, 3XX, 4XX, and 5XX. If a response range is defined using an explicit
     * code, the explicit code definition takes precedence over the range definition for that code.
     *
     * @see https://swagger.io/specification/#responsesObject
     *
     * @var Response[]|Reference[] array<string, Response>|array<string, Reference>
     */
    public $responses;

    /**
     * A list of tags for API documentation control.
     * Tags can be used for logical grouping of operations by resources or any other qualifier.
     *
     * @var string[]
     */
    public $tags;

    /**
     * A short summary of what the operation does.
     *
     * @var string
     */
    public $summary;

    /**
     * A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation.
     *
     * @var string
     */
    public $description;

    /**
     * Additional external documentation for this operation.
     *
     * @var ExternalDocumentation
     */
    public $externalDocs;

    /**
     * Unique string used to identify the operation.
     *
     * The id MUST be unique among all operations described in the API.
     * Tools and libraries MAY use the operationId to uniquely identify an operation,
     * therefore, it is RECOMMENDED to follow common programming naming conventions.
     *
     * @var string
     */
    public $operationId;

    /**
     * A list of parameters that are applicable for this operation.
     * If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.
     * The list MUST NOT include duplicated parameters.
     * A unique parameter is defined by a combination of a name and location.
     * The list can use the Reference Object to link to parameters that are defined at the
     * OpenAPI Object's components/parameters.
     *
     * @see https://swagger.io/specification/#parameterName
     * @see https://swagger.io/specification/#parameterIn
     * @see https://swagger.io/specification/#referenceObject
     * @see https://swagger.io/specification/#componentsParameters
     *
     * @var Parameter[]|Reference[]
     */
    public $parameters;

    /**
     * The request body applicable for this operation.
     * The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231
     * has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague,
     * requestBody SHALL be ignored by consumers.
     *
     * @see https://tools.ietf.org/html/rfc7231#section-4.3.1
     *
     * @var RequestBody|Reference
     */
    public $requestBody;

    /**
     * A map of possible out-of band callbacks (aka. web hooks) related to the parent operation.
     * The key is a unique identifier for the Callback Object.
     * Each value in the map is a Callback Object that describes a request that may be initiated by
     * the API provider and the expected responses. The key value used to identify the callback object
     * is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.
     *
     * @see https://swagger.io/specification/#callbackObject
     *
     * @var PathItem[]|Reference[] array<string, PathItem>|array<string, Reference>
     */
    public $callbacks;

    /**
     * Declares this operation to be deprecated.
     * Consumers SHOULD refrain from usage of the declared operation. Default value is false (if not specified).
     *
     * @var bool
     */
    public $deprecated;

    /**
     * A declaration of which security mechanisms can be used for this operation.
     * The list of values includes alternative security requirement objects that can be used
     * Only one of the security requirement objects need to be satisfied to authorize a request.
     * This definition overrides any declared top-level security. To remove a top-level security declaration,
     * an empty array can be used.
     *
     * Each name (key) MUST correspond to a security scheme which is declared in the Security Schemes
     * under the Components Object. If the security scheme is of type "oauth2" or "openIdConnect",
     * then the value is a list of scope names required for the execution. For other security scheme types,
     * the array MUST be empty.
     *
     * @example {"api_key": []}
     *
     * @see     https://swagger.io/specification/#securityRequirementObject
     * @var string[] array<string, string[]>
     */
    public $security;

    /**
     * An alternative server array to service this operation.
     * If an alternative server object is specified at the Path Item Object or Root level,
     * it will be overridden by this value.
     *
     * @var Server[]
     */
    public $servers;

    /**
     * @param Response[]|Reference[] $responses
     * @param string|null            $operationId
     * @param string|null            $summary
     * @param array                  $additionalProperties
     */
    public function __construct(
        array $responses,
        string $operationId = null,
        string $summary = null,
        array $additionalProperties = []
    ) {
        parent::__construct($additionalProperties);
        $this->responses   = $responses;
        $this->operationId = $operationId;
        $this->summary     = $summary;
    }
}