<?php declare(strict_types=1);
/**
* @license Apache 2.0
*/
namespace OpenApi\Annotations;
use OpenApi\Generator;
/**
* Configuration details for a supported OAuth Flow.
*
* @see [OAI OAuth Flow Object](https://swagger.io/specification/#oauthFlowObject)
*
* @Annotation
*/
class Flow extends AbstractAnnotation
{
/**
* The authorization url to be used for this flow.
*
* This must be in the form of an url.
*
* @var string
*/
public $authorizationUrl = Generator::UNDEFINED;
/**
* The token URL to be used for this flow.
*
* This must be in the form of an url.
*
* @var string
*/
public $tokenUrl = Generator::UNDEFINED;
/**
* The URL to be used for obtaining refresh tokens.
*
* This must be in the form of an url.
*
* @var string
*/
public $refreshUrl = Generator::UNDEFINED;
/**
* Flow name.
*
* One of ['implicit', 'password', 'authorizationCode', 'clientCredentials'].
*
* @var string
*/
public $flow = Generator::UNDEFINED;
/**
* The available scopes for the OAuth2 security scheme.
*
* A map between the scope name and a short description for it.
*
* @var array
*/
public $scopes = Generator::UNDEFINED;
/**
* @inheritdoc
*/
public static $_required = ['scopes', 'flow'];
/**
* @inheritdoc
*/
public static $_types = [
'flow' => ['implicit', 'password', 'authorizationCode', 'clientCredentials'],
'refreshUrl' => 'string',
'authorizationUrl' => 'string',
'tokenUrl' => 'string',
];
/**
* @inheritdoc
*/
public static $_parents = [
SecurityScheme::class,
];
/**
* @inheritdoc
*/
public static $_nested = [
Attachable::class => ['attachables'],
];
/**
* @inheritdoc
*/
#[\ReturnTypeWillChange]
public function jsonSerialize()
{
if (is_array($this->scopes) && empty($this->scopes)) {
$this->scopes = new \stdClass();
}
return parent::jsonSerialize();
}
}