mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-02-09 02:59:27 +03:00
78664ef9ec
* Initial pass for OA3 upgrade * Fix Util Tests * Fix first batch of Unit Tests. Up to Model * Another batch of fixed tests * Update annotations * Convert Model & Property Describers * Update tests, Fix RouteDescribers, FIx additional bugs * Another batch of updates * Another batch of fixed Functional Tests * Fix FunctionalTest tests * Fix Bazinga Tests * FIx FOS Rest * Fix JMS TEsts & describers * Fix all Tests * Fix few stuff from own CR * CS Fixes * CS Fixes 2 * CS Fixes 3 * CS Fixes 4 * Remove collection bug * Updates after first CRs * CS * Drop support for SF3 * Update the docs * Add an upgrade guide * misc doc fixes * Configurable media types * Code Style Fixes * Don't use ::$ref for @Response and @RequestBody * Fix upgrading guide * Fix OA case Co-authored-by: Filip Benčo <filip.benco@websupport.sk> Co-authored-by: Guilhem Niot <guilhem.niot@gmail.com> Co-authored-by: Mantis Development <mantis@users.noreply.github.com>
51 lines
1.1 KiB
PHP
51 lines
1.1 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the NelmioApiDocBundle package.
|
|
*
|
|
* (c) Nelmio
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Nelmio\ApiDocBundle\Describer;
|
|
|
|
use Nelmio\ApiDocBundle\OpenApiPhp\Util;
|
|
use OpenApi\Annotations as OA;
|
|
|
|
class ExternalDocDescriber implements DescriberInterface
|
|
{
|
|
private $externalDoc;
|
|
|
|
private $overwrite;
|
|
|
|
/**
|
|
* @param array|callable $externalDoc
|
|
* @param bool $overwrite
|
|
*/
|
|
public function __construct($externalDoc, bool $overwrite = false)
|
|
{
|
|
$this->externalDoc = $externalDoc;
|
|
$this->overwrite = $overwrite;
|
|
}
|
|
|
|
public function describe(OA\OpenApi $api)
|
|
{
|
|
$externalDoc = $this->getExternalDoc();
|
|
|
|
if (!empty($externalDoc)) {
|
|
Util::merge($api, $externalDoc, $this->overwrite);
|
|
}
|
|
}
|
|
|
|
private function getExternalDoc()
|
|
{
|
|
if (is_callable($this->externalDoc)) {
|
|
return call_user_func($this->externalDoc);
|
|
}
|
|
|
|
return $this->externalDoc;
|
|
}
|
|
}
|