82 lines
1.9 KiB
PHP
82 lines
1.9 KiB
PHP
<?php declare(strict_types=1);
|
|
|
|
/**
|
|
* @license Apache 2.0
|
|
*/
|
|
|
|
namespace OpenApi\Annotations;
|
|
|
|
use OpenApi\Generator;
|
|
|
|
/**
|
|
* @Annotation
|
|
*/
|
|
class Examples extends AbstractAnnotation
|
|
{
|
|
/**
|
|
* $ref See https://swagger.io/docs/specification/using-ref/.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $ref = Generator::UNDEFINED;
|
|
|
|
/**
|
|
* The key into Components->examples array.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $example = Generator::UNDEFINED;
|
|
|
|
/**
|
|
* Short description for the example.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $summary = Generator::UNDEFINED;
|
|
|
|
/**
|
|
* Embedded literal example. The value field and externalValue field are
|
|
* mutually exclusive. To represent examples of media types that cannot
|
|
* naturally represented in JSON or YAML, use a string value to contain
|
|
* the example, escaping where necessary.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $description = Generator::UNDEFINED;
|
|
|
|
/**
|
|
* Embedded literal example.
|
|
* The value field and externalValue field are mutually exclusive.
|
|
* To represent examples of media types that cannot naturally represented
|
|
* in JSON or YAML, use a string value to contain the example, escaping
|
|
* where necessary.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $value = Generator::UNDEFINED;
|
|
|
|
/**
|
|
* A URL that points to the literal example. This provides the
|
|
* capability to reference examples that cannot easily be included
|
|
* in JSON or YAML documents.
|
|
* The value field and externalValue field are mutually exclusive.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $externalValue = Generator::UNDEFINED;
|
|
|
|
public static $_types = [
|
|
'summary' => 'string',
|
|
'description' => 'string',
|
|
'externalValue' => 'string',
|
|
];
|
|
|
|
public static $_required = ['summary'];
|
|
|
|
public static $_parents = [
|
|
Components::class,
|
|
Parameter::class,
|
|
MediaType::class,
|
|
];
|
|
}
|