coupon-admin/vendor/zircote/swagger-php/src/Annotations/ExternalDocumentation.php

69 lines
1.4 KiB
PHP
Raw Normal View History

2021-11-18 09:57:04 +00:00
<?php declare(strict_types=1);
/**
* @license Apache 2.0
*/
namespace OpenApi\Annotations;
use OpenApi\Generator;
/**
* @Annotation
* Allows referencing an external resource for extended documentation.
*
* A "External Documentation Object": https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#external-documentation-object
*/
class ExternalDocumentation extends AbstractAnnotation
{
/**
* A short description of the target documentation. GFM syntax can be used for rich text representation.
*
* @var string
*/
public $description = Generator::UNDEFINED;
/**
* The URL for the target documentation.
*
* @var string
*/
public $url = Generator::UNDEFINED;
/**
* @inheritdoc
*/
public static $_types = [
'description' => 'string',
'url' => 'string',
];
/**
* @inheritdoc
*/
public static $_required = ['url'];
/**
* @inheritdoc
*/
public static $_parents = [
OpenApi::class,
Tag::class,
Schema::class,
AdditionalProperties::class,
Property::class,
Operation::class,
Get::class,
Post::class,
Put::class,
Delete::class,
Patch::class,
Head::class,
Options::class,
Trace::class,
Items::class,
JsonContent::class,
XmlContent::class,
];
}