loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-12-08 20:36:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

[php] Deprecated annotation on operations and fields (#10085)

Browse Source
This commit is contained in:
Nathan Baulch
2021-08-04 19:29:19 +10:00
committed by GitHub
parent dc23267580
commit ca5de9d503
22 changed files with 82 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
modules/openapi-generator/src/main/resources/php-laravel/api.mustache vendored
View File

@@ -21,9 +21,12 @@ use Illuminate\Support\Facades\Request;
* *
* {{{summary}}}. * {{{summary}}}.
* *
{{#pathParams}} * @param {{dataType}} ${{paramName}} {{description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} {{#pathParams}} * @param {{dataType}} ${{paramName}} {{description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
{{/pathParams}} * {{/pathParams}} *
* @return Http response * @return Http response
{{#isDeprecated}}
* @deprecated
{{/isDeprecated}}
*/ */
public function {{operationId}}({{#pathParams}}${{paramName}}{{^-last}}, {{/-last}}{{/pathParams}}) public function {{operationId}}({{#pathParams}}${{paramName}}{{^-last}}, {{/-last}}{{/pathParams}})
{ {

3
modules/openapi-generator/src/main/resources/php-laravel/model.mustache vendored
View File

@@ -11,6 +11,9 @@ class {{classname}} {
{{#vars}} {{#vars}}
/** @var {{{dataType}}} ${{name}} {{#description}}{{description}}{{/description}}*/ /** @var {{{dataType}}} ${{name}} {{#description}}{{description}}{{/description}}*/
{{#deprecated}}
/** @deprecated */
{{/deprecated}}
private ${{name}}; private ${{name}};
{{/vars}} {{/vars}}

5
modules/openapi-generator/src/main/resources/php-lumen/api.mustache vendored
View File

@@ -21,9 +21,12 @@ use Illuminate\Support\Facades\Request;
* *
* {{{summary}}}. * {{{summary}}}.
* *
{{#pathParams}} * @param {{dataType}} ${{paramName}} {{description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} {{#pathParams}} * @param {{dataType}} ${{paramName}} {{description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
{{/pathParams}} * {{/pathParams}} *
* @return Http response * @return Http response
{{#isDeprecated}}
* @deprecated
{{/isDeprecated}}
*/ */
public function {{operationId}}({{#pathParams}}${{paramName}}{{^-last}}, {{/-last}}{{/pathParams}}) public function {{operationId}}({{#pathParams}}${{paramName}}{{^-last}}, {{/-last}}{{/pathParams}})
{ {

3
modules/openapi-generator/src/main/resources/php-mezzio-ph/api.mustache vendored
View File

@@ -57,6 +57,9 @@ class {{classname}}
* *
* @return {{returnType}} * @return {{returnType}}
{{/returnType}} {{/returnType}}
{{#isDeprecated}}
* @deprecated
{{/isDeprecated}}
*/ */
public function {{operationId}}(ServerRequestInterface $request){{#returnType}}: {{returnType}}{{/returnType}} public function {{operationId}}(ServerRequestInterface $request){{#returnType}}: {{returnType}}{{/returnType}}
{ {

3
modules/openapi-generator/src/main/resources/php-slim-server/api.mustache vendored
View File

@@ -84,6 +84,9 @@ abstract class {{classname}}
* *
* @return ResponseInterface * @return ResponseInterface
* @throws Exception to force implementation class to override this method * @throws Exception to force implementation class to override this method
{{#isDeprecated}}
* @deprecated
{{/isDeprecated}}
*/ */
public function {{operationId}}(ServerRequestInterface $request, ResponseInterface $response, array $args) public function {{operationId}}(ServerRequestInterface $request, ResponseInterface $response, array $args)
{ {

3
modules/openapi-generator/src/main/resources/php-slim-server/model.mustache vendored
View File

@@ -27,6 +27,9 @@ class {{classname}}
{{#vars}} {{#vars}}
/** @var {{dataType}} ${{name}} {{#description}}{{description}}{{/description}}*/ /** @var {{dataType}} ${{name}} {{#description}}{{description}}{{/description}}*/
{{#deprecated}}
/** @deprecated */
{{/deprecated}}
private ${{name}}; private ${{name}};
{{/vars}} {{/vars}}
} }

3
modules/openapi-generator/src/main/resources/php-slim4-server/api.mustache vendored
View File

@@ -60,6 +60,9 @@ abstract class {{classname}}
* *
* @return ResponseInterface * @return ResponseInterface
* @throws HttpNotImplementedException to force implementation class to override this method * @throws HttpNotImplementedException to force implementation class to override this method
{{#isDeprecated}}
* @deprecated
{{/isDeprecated}}
*/ */
public function {{operationId}}(ServerRequestInterface $request, ResponseInterface $response, array $args) public function {{operationId}}(ServerRequestInterface $request, ResponseInterface $response, array $args)
{ {

6
modules/openapi-generator/src/main/resources/php-symfony/api.mustache vendored
View File

@@ -57,13 +57,15 @@ interface {{classname}}
* *
{{/description}} {{/description}}
{{#allParams}} {{#allParams}}
* @param {{vendorExtensions.x-comment-type}} ${{paramName}} {{description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} * @param {{vendorExtensions.x-comment-type}} ${{paramName}} {{description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
{{/allParams}} {{/allParams}}
* @param \int $responseCode The HTTP response code to return * @param \int $responseCode The HTTP response code to return
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return {{{vendorExtensions.x-comment-type}}} * @return {{{vendorExtensions.x-comment-type}}}
* {{#isDeprecated}}
* @deprecated
{{/isDeprecated}}
*/ */
public function {{operationId}}({{#allParams}}{{#vendorExtensions.x-parameter-type}}{{vendorExtensions.x-parameter-type}} {{/vendorExtensions.x-parameter-type}}${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}}, {{/allParams}}&$responseCode, array &$responseHeaders); public function {{operationId}}({{#allParams}}{{#vendorExtensions.x-parameter-type}}{{vendorExtensions.x-parameter-type}} {{/vendorExtensions.x-parameter-type}}${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}}, {{/allParams}}&$responseCode, array &$responseHeaders);
{{/operation}} {{/operation}}

3
modules/openapi-generator/src/main/resources/php-symfony/api_controller.mustache vendored
View File

@@ -54,6 +54,9 @@ class {{controllerName}} extends Controller
{{/description}} {{/description}}
* @param Request $request The Symfony request to handle. * @param Request $request The Symfony request to handle.
* @return Response The Symfony response. * @return Response The Symfony response.
{{#isDeprecated}}
* @deprecated
{{/isDeprecated}}
*/ */
public function {{operationId}}Action(Request $request{{#hasPathParams}}{{#pathParams}}, ${{paramName}}{{/pathParams}}{{/hasPathParams}}) public function {{operationId}}Action(Request $request{{#hasPathParams}}{{#pathParams}}, ${{paramName}}{{/pathParams}}{{/hasPathParams}})
{ {

25
modules/openapi-generator/src/main/resources/php/api.mustache vendored
View File

@@ -131,12 +131,15 @@ use {{invokerPackage}}\ObjectSerializer;
{{/-last}} {{/-last}}
{{/servers}} {{/servers}}
{{#allParams}} {{#allParams}}
* @param {{{dataType}}} ${{paramName}}{{#description}} {{description}}{{/description}}{{^description}} {{paramName}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} * @param {{{dataType}}} ${{paramName}}{{#description}} {{description}}{{/description}}{{^description}} {{paramName}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
{{/allParams}} {{/allParams}}
* *
* @throws \{{invokerPackage}}\ApiException on non-2xx response * @throws \{{invokerPackage}}\ApiException on non-2xx response
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
* @return {{#returnType}}{{#responses}}{{#dataType}}{{^-first}}|{{/-first}}{{/dataType}}{{{dataType}}}{{/responses}}{{/returnType}}{{^returnType}}void{{/returnType}} * @return {{#returnType}}{{#responses}}{{#dataType}}{{^-first}}|{{/-first}}{{/dataType}}{{{dataType}}}{{/responses}}{{/returnType}}{{^returnType}}void{{/returnType}}
{{#isDeprecated}}
* @deprecated
{{/isDeprecated}}
*/ */
public function {{operationId}}({{^vendorExtensions.x-group-parameters}}{{#allParams}}${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}{{#vendorExtensions.x-group-parameters}}$associative_array{{/vendorExtensions.x-group-parameters}}) public function {{operationId}}({{^vendorExtensions.x-group-parameters}}{{#allParams}}${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}{{#vendorExtensions.x-group-parameters}}$associative_array{{/vendorExtensions.x-group-parameters}})
{ {
@@ -169,12 +172,15 @@ use {{invokerPackage}}\ObjectSerializer;
{{/-last}} {{/-last}}
{{/servers}} {{/servers}}
{{#allParams}} {{#allParams}}
* @param {{{dataType}}} ${{paramName}}{{#description}} {{description}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} * @param {{{dataType}}} ${{paramName}}{{#description}} {{description}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
{{/allParams}} {{/allParams}}
* *
* @throws \{{invokerPackage}}\ApiException on non-2xx response * @throws \{{invokerPackage}}\ApiException on non-2xx response
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
* @return array of {{#returnType}}{{#responses}}{{#dataType}}{{^-first}}|{{/-first}}{{/dataType}}{{{dataType}}}{{/responses}}{{/returnType}}{{^returnType}}null{{/returnType}}, HTTP status code, HTTP response headers (array of strings) * @return array of {{#returnType}}{{#responses}}{{#dataType}}{{^-first}}|{{/-first}}{{/dataType}}{{{dataType}}}{{/responses}}{{/returnType}}{{^returnType}}null{{/returnType}}, HTTP status code, HTTP response headers (array of strings)
{{#isDeprecated}}
* @deprecated
{{/isDeprecated}}
*/ */
public function {{operationId}}WithHttpInfo({{^vendorExtensions.x-group-parameters}}{{#allParams}}${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}{{#vendorExtensions.x-group-parameters}}$associative_array{{/vendorExtensions.x-group-parameters}}) public function {{operationId}}WithHttpInfo({{^vendorExtensions.x-group-parameters}}{{#allParams}}${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}{{#vendorExtensions.x-group-parameters}}$associative_array{{/vendorExtensions.x-group-parameters}})
{ {
@@ -294,11 +300,14 @@ use {{invokerPackage}}\ObjectSerializer;
{{/-last}} {{/-last}}
{{/servers}} {{/servers}}
{{#allParams}} {{#allParams}}
* @param {{{dataType}}} ${{paramName}}{{#description}} {{description}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} * @param {{{dataType}}} ${{paramName}}{{#description}} {{description}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
{{/allParams}} {{/allParams}}
* *
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
* @return \GuzzleHttp\Promise\PromiseInterface * @return \GuzzleHttp\Promise\PromiseInterface
{{#isDeprecated}}
* @deprecated
{{/isDeprecated}}
*/ */
public function {{operationId}}Async({{^vendorExtensions.x-group-parameters}}{{#allParams}}${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}{{#vendorExtensions.x-group-parameters}}$associative_array{{/vendorExtensions.x-group-parameters}}) public function {{operationId}}Async({{^vendorExtensions.x-group-parameters}}{{#allParams}}${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}{{#vendorExtensions.x-group-parameters}}$associative_array{{/vendorExtensions.x-group-parameters}})
{ {
@@ -335,11 +344,14 @@ use {{invokerPackage}}\ObjectSerializer;
{{/-last}} {{/-last}}
{{/servers}} {{/servers}}
{{#allParams}} {{#allParams}}
* @param {{{dataType}}} ${{paramName}}{{#description}} {{description}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} * @param {{{dataType}}} ${{paramName}}{{#description}} {{description}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
{{/allParams}} {{/allParams}}
* *
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
* @return \GuzzleHttp\Promise\PromiseInterface * @return \GuzzleHttp\Promise\PromiseInterface
{{#isDeprecated}}
* @deprecated
{{/isDeprecated}}
*/ */
public function {{operationId}}AsyncWithHttpInfo({{^vendorExtensions.x-group-parameters}}{{#allParams}}${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}{{#vendorExtensions.x-group-parameters}}$associative_array{{/vendorExtensions.x-group-parameters}}) public function {{operationId}}AsyncWithHttpInfo({{^vendorExtensions.x-group-parameters}}{{#allParams}}${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}{{#vendorExtensions.x-group-parameters}}$associative_array{{/vendorExtensions.x-group-parameters}})
{ {
@@ -401,11 +413,14 @@ use {{invokerPackage}}\ObjectSerializer;
{{/-last}} {{/-last}}
{{/servers}} {{/servers}}
{{#allParams}} {{#allParams}}
* @param {{{dataType}}} ${{paramName}}{{#description}} {{description}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}} * @param {{{dataType}}} ${{paramName}}{{#description}} {{description}}{{/description}} {{#required}}(required){{/required}}{{^required}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}}
{{/allParams}} {{/allParams}}
* *
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
* @return \GuzzleHttp\Psr7\Request * @return \GuzzleHttp\Psr7\Request
{{#isDeprecated}}
* @deprecated
{{/isDeprecated}}
*/ */
public function {{operationId}}Request({{^vendorExtensions.x-group-parameters}}{{#allParams}}${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}{{#vendorExtensions.x-group-parameters}}$associative_array{{/vendorExtensions.x-group-parameters}}) public function {{operationId}}Request({{^vendorExtensions.x-group-parameters}}{{#allParams}}${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}}{{/vendorExtensions.x-group-parameters}}{{#vendorExtensions.x-group-parameters}}$associative_array{{/vendorExtensions.x-group-parameters}})
{ {

6
modules/openapi-generator/src/main/resources/php/model_generic.mustache vendored
View File

@@ -279,6 +279,9 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}}{{/parentSchema}}{{^par
* Gets {{name}} * Gets {{name}}
* *
* @return {{{dataType}}}{{^required}}|null{{/required}} * @return {{{dataType}}}{{^required}}|null{{/required}}
{{#deprecated}}
* @deprecated
{{/deprecated}}
*/ */
public function {{getter}}() public function {{getter}}()
{ {
@@ -291,6 +294,9 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}}{{/parentSchema}}{{^par
* @param {{{dataType}}}{{^required}}|null{{/required}} ${{name}}{{#description}} {{{description}}}{{/description}}{{^description}} {{{name}}}{{/description}} * @param {{{dataType}}}{{^required}}|null{{/required}} ${{name}}{{#description}} {{{description}}}{{/description}}{{^description}} {{{name}}}{{/description}}
* *
* @return self * @return self
{{#deprecated}}
* @deprecated
{{/deprecated}}
*/ */
public function {{setter}}(${{name}}) public function {{setter}}(${{name}})
{ {

15
samples/client/petstore/php/OpenAPIClient-php/lib/Api/PetApi.php
View File

@@ -598,7 +598,7 @@ class PetApi
* *
* Finds Pets by status * Finds Pets by status
* *
* @param string[] $status Status values that need to be considered for filter (required) * @param string[] $status Status values that need to be considered for filter (required) (deprecated)
* *
* @throws \OpenAPI\Client\ApiException on non-2xx response * @throws \OpenAPI\Client\ApiException on non-2xx response
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
@@ -615,7 +615,7 @@ class PetApi
* *
* Finds Pets by status * Finds Pets by status
* *
* @param string[] $status Status values that need to be considered for filter (required) * @param string[] $status Status values that need to be considered for filter (required) (deprecated)
* *
* @throws \OpenAPI\Client\ApiException on non-2xx response * @throws \OpenAPI\Client\ApiException on non-2xx response
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
@@ -701,7 +701,7 @@ class PetApi
* *
* Finds Pets by status * Finds Pets by status
* *
* @param string[] $status Status values that need to be considered for filter (required) * @param string[] $status Status values that need to be considered for filter (required) (deprecated)
* *
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
* @return \GuzzleHttp\Promise\PromiseInterface * @return \GuzzleHttp\Promise\PromiseInterface
@@ -721,7 +721,7 @@ class PetApi
* *
* Finds Pets by status * Finds Pets by status
* *
* @param string[] $status Status values that need to be considered for filter (required) * @param string[] $status Status values that need to be considered for filter (required) (deprecated)
* *
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
* @return \GuzzleHttp\Promise\PromiseInterface * @return \GuzzleHttp\Promise\PromiseInterface
@@ -767,7 +767,7 @@ class PetApi
/** /**
* Create request for operation 'findPetsByStatus' * Create request for operation 'findPetsByStatus'
* *
* @param string[] $status Status values that need to be considered for filter (required) * @param string[] $status Status values that need to be considered for filter (required) (deprecated)
* *
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
* @return \GuzzleHttp\Psr7\Request * @return \GuzzleHttp\Psr7\Request
@@ -870,6 +870,7 @@ class PetApi
* @throws \OpenAPI\Client\ApiException on non-2xx response * @throws \OpenAPI\Client\ApiException on non-2xx response
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
* @return \OpenAPI\Client\Model\Pet[] * @return \OpenAPI\Client\Model\Pet[]
* @deprecated
*/ */
public function findPetsByTags($tags) public function findPetsByTags($tags)
{ {
@@ -887,6 +888,7 @@ class PetApi
* @throws \OpenAPI\Client\ApiException on non-2xx response * @throws \OpenAPI\Client\ApiException on non-2xx response
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
* @return array of \OpenAPI\Client\Model\Pet[], HTTP status code, HTTP response headers (array of strings) * @return array of \OpenAPI\Client\Model\Pet[], HTTP status code, HTTP response headers (array of strings)
* @deprecated
*/ */
public function findPetsByTagsWithHttpInfo($tags) public function findPetsByTagsWithHttpInfo($tags)
{ {
@@ -972,6 +974,7 @@ class PetApi
* *
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
* @return \GuzzleHttp\Promise\PromiseInterface * @return \GuzzleHttp\Promise\PromiseInterface
* @deprecated
*/ */
public function findPetsByTagsAsync($tags) public function findPetsByTagsAsync($tags)
{ {
@@ -992,6 +995,7 @@ class PetApi
* *
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
* @return \GuzzleHttp\Promise\PromiseInterface * @return \GuzzleHttp\Promise\PromiseInterface
* @deprecated
*/ */
public function findPetsByTagsAsyncWithHttpInfo($tags) public function findPetsByTagsAsyncWithHttpInfo($tags)
{ {
@@ -1038,6 +1042,7 @@ class PetApi
* *
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
* @return \GuzzleHttp\Psr7\Request * @return \GuzzleHttp\Psr7\Request
* @deprecated
*/ */
public function findPetsByTagsRequest($tags) public function findPetsByTagsRequest($tags)
{ {

6
samples/client/petstore/php/OpenAPIClient-php/lib/Model/ObjectWithDeprecatedFields.php
View File

@@ -251,6 +251,7 @@ class ObjectWithDeprecatedFields implements ModelInterface, ArrayAccess, \JsonSe
* Gets id * Gets id
* *
* @return float|null * @return float|null
* @deprecated
*/ */
public function getId() public function getId()
{ {
@@ -263,6 +264,7 @@ class ObjectWithDeprecatedFields implements ModelInterface, ArrayAccess, \JsonSe
* @param float|null $id id * @param float|null $id id
* *
* @return self * @return self
* @deprecated
*/ */
public function setId($id) public function setId($id)
{ {
@@ -275,6 +277,7 @@ class ObjectWithDeprecatedFields implements ModelInterface, ArrayAccess, \JsonSe
* Gets deprecated_ref * Gets deprecated_ref
* *
* @return \OpenAPI\Client\Model\DeprecatedObject|null * @return \OpenAPI\Client\Model\DeprecatedObject|null
* @deprecated
*/ */
public function getDeprecatedRef() public function getDeprecatedRef()
{ {
@@ -287,6 +290,7 @@ class ObjectWithDeprecatedFields implements ModelInterface, ArrayAccess, \JsonSe
* @param \OpenAPI\Client\Model\DeprecatedObject|null $deprecated_ref deprecated_ref * @param \OpenAPI\Client\Model\DeprecatedObject|null $deprecated_ref deprecated_ref
* *
* @return self * @return self
* @deprecated
*/ */
public function setDeprecatedRef($deprecated_ref) public function setDeprecatedRef($deprecated_ref)
{ {
@@ -299,6 +303,7 @@ class ObjectWithDeprecatedFields implements ModelInterface, ArrayAccess, \JsonSe
* Gets bars * Gets bars
* *
* @return string[]|null * @return string[]|null
* @deprecated
*/ */
public function getBars() public function getBars()
{ {
@@ -311,6 +316,7 @@ class ObjectWithDeprecatedFields implements ModelInterface, ArrayAccess, \JsonSe
* @param string[]|null $bars bars * @param string[]|null $bars bars
* *
* @return self * @return self
* @deprecated
*/ */
public function setBars($bars) public function setBars($bars)
{ {

1
samples/server/petstore/php-laravel/lib/app/Http/Controllers/PetController.php
View File

@@ -130,6 +130,7 @@ class PetController extends Controller
* *
* *
* @return Http response * @return Http response
* @deprecated
*/ */
public function findPetsByTags() public function findPetsByTags()
{ {

3
samples/server/petstore/php-laravel/lib/app/Models/ObjectWithDeprecatedFields.php
View File

@@ -13,12 +13,15 @@ class ObjectWithDeprecatedFields {
private $uuid; private $uuid;
/** @var float $id */ /** @var float $id */
/** @deprecated */
private $id; private $id;
/** @var \app\Models\DeprecatedObject $deprecatedRef */ /** @var \app\Models\DeprecatedObject $deprecatedRef */
/** @deprecated */
private $deprecatedRef; private $deprecatedRef;
/** @var string[] $bars */ /** @var string[] $bars */
/** @deprecated */
private $bars; private $bars;
} }

1
samples/server/petstore/php-lumen/lib/app/Http/Controllers/PetApi.php
View File

@@ -126,6 +126,7 @@ class PetApi extends Controller
* *
* *
* @return Http response * @return Http response
* @deprecated
*/ */
public function findPetsByTags() public function findPetsByTags()
{ {

1
samples/server/petstore/php-mezzio-ph/src/App/Handler/PetFindByTags.php
View File

@@ -32,6 +32,7 @@ class PetFindByTags
* @throws PHException\HttpCode 501 if the method is not implemented * @throws PHException\HttpCode 501 if the method is not implemented
* *
* @return \App\DTO\Collection26 * @return \App\DTO\Collection26
* @deprecated
*/ */
public function findPetsByTags(ServerRequestInterface $request): \App\DTO\Collection26 public function findPetsByTags(ServerRequestInterface $request): \App\DTO\Collection26
{ {

1
samples/server/petstore/php-slim4/lib/Api/AbstractPetApi.php
View File

@@ -125,6 +125,7 @@ abstract class AbstractPetApi
* *
* @return ResponseInterface * @return ResponseInterface
* @throws HttpNotImplementedException to force implementation class to override this method * @throws HttpNotImplementedException to force implementation class to override this method
* @deprecated
*/ */
public function findPetsByTags(ServerRequestInterface $request, ResponseInterface $response, array $args) public function findPetsByTags(ServerRequestInterface $request, ResponseInterface $response, array $args)
{ {

11
samples/server/petstore/php-symfony/SymfonyBundle-php/Api/PetApiInterface.php
View File

@@ -80,7 +80,6 @@ interface PetApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return \OpenAPI\Server\Model\Pet * @return \OpenAPI\Server\Model\Pet
*
*/ */
public function addPet(Pet $pet, &$responseCode, array &$responseHeaders); public function addPet(Pet $pet, &$responseCode, array &$responseHeaders);
@@ -95,7 +94,6 @@ interface PetApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return void * @return void
*
*/ */
public function deletePet($petId, $apiKey = null, &$responseCode, array &$responseHeaders); public function deletePet($petId, $apiKey = null, &$responseCode, array &$responseHeaders);
@@ -104,12 +102,11 @@ interface PetApiInterface
* *
* Finds Pets by status * Finds Pets by status
* *
* @param \string[] $status Status values that need to be considered for filter (required) * @param \string[] $status Status values that need to be considered for filter (required) (deprecated)
* @param \int $responseCode The HTTP response code to return * @param \int $responseCode The HTTP response code to return
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return \OpenAPI\Server\Model\Pet[] * @return \OpenAPI\Server\Model\Pet[]
*
*/ */
public function findPetsByStatus(array $status, &$responseCode, array &$responseHeaders); public function findPetsByStatus(array $status, &$responseCode, array &$responseHeaders);
@@ -123,7 +120,7 @@ interface PetApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return \OpenAPI\Server\Model\Pet[] * @return \OpenAPI\Server\Model\Pet[]
* * @deprecated
*/ */
public function findPetsByTags(array $tags, &$responseCode, array &$responseHeaders); public function findPetsByTags(array $tags, &$responseCode, array &$responseHeaders);
@@ -137,7 +134,6 @@ interface PetApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return \OpenAPI\Server\Model\Pet * @return \OpenAPI\Server\Model\Pet
*
*/ */
public function getPetById($petId, &$responseCode, array &$responseHeaders); public function getPetById($petId, &$responseCode, array &$responseHeaders);
@@ -151,7 +147,6 @@ interface PetApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return \OpenAPI\Server\Model\Pet * @return \OpenAPI\Server\Model\Pet
*
*/ */
public function updatePet(Pet $pet, &$responseCode, array &$responseHeaders); public function updatePet(Pet $pet, &$responseCode, array &$responseHeaders);
@@ -167,7 +162,6 @@ interface PetApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return void * @return void
*
*/ */
public function updatePetWithForm($petId, $name = null, $status = null, &$responseCode, array &$responseHeaders); public function updatePetWithForm($petId, $name = null, $status = null, &$responseCode, array &$responseHeaders);
@@ -183,7 +177,6 @@ interface PetApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return \OpenAPI\Server\Model\ApiResponse * @return \OpenAPI\Server\Model\ApiResponse
*
*/ */
public function uploadFile($petId, $additionalMetadata = null, UploadedFile $file = null, &$responseCode, array &$responseHeaders); public function uploadFile($petId, $additionalMetadata = null, UploadedFile $file = null, &$responseCode, array &$responseHeaders);
} }

4
samples/server/petstore/php-symfony/SymfonyBundle-php/Api/StoreApiInterface.php
View File

@@ -61,7 +61,6 @@ interface StoreApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return void * @return void
*
*/ */
public function deleteOrder($orderId, &$responseCode, array &$responseHeaders); public function deleteOrder($orderId, &$responseCode, array &$responseHeaders);
@@ -74,7 +73,6 @@ interface StoreApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return \int * @return \int
*
*/ */
public function getInventory(&$responseCode, array &$responseHeaders); public function getInventory(&$responseCode, array &$responseHeaders);
@@ -88,7 +86,6 @@ interface StoreApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return \OpenAPI\Server\Model\Order * @return \OpenAPI\Server\Model\Order
*
*/ */
public function getOrderById($orderId, &$responseCode, array &$responseHeaders); public function getOrderById($orderId, &$responseCode, array &$responseHeaders);
@@ -102,7 +99,6 @@ interface StoreApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return \OpenAPI\Server\Model\Order * @return \OpenAPI\Server\Model\Order
*
*/ */
public function placeOrder(Order $order, &$responseCode, array &$responseHeaders); public function placeOrder(Order $order, &$responseCode, array &$responseHeaders);
} }

8
samples/server/petstore/php-symfony/SymfonyBundle-php/Api/UserApiInterface.php
View File

@@ -61,7 +61,6 @@ interface UserApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return void * @return void
*
*/ */
public function createUser(User $user, &$responseCode, array &$responseHeaders); public function createUser(User $user, &$responseCode, array &$responseHeaders);
@@ -75,7 +74,6 @@ interface UserApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return void * @return void
*
*/ */
public function createUsersWithArrayInput(array $user, &$responseCode, array &$responseHeaders); public function createUsersWithArrayInput(array $user, &$responseCode, array &$responseHeaders);
@@ -89,7 +87,6 @@ interface UserApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return void * @return void
*
*/ */
public function createUsersWithListInput(array $user, &$responseCode, array &$responseHeaders); public function createUsersWithListInput(array $user, &$responseCode, array &$responseHeaders);
@@ -103,7 +100,6 @@ interface UserApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return void * @return void
*
*/ */
public function deleteUser($username, &$responseCode, array &$responseHeaders); public function deleteUser($username, &$responseCode, array &$responseHeaders);
@@ -117,7 +113,6 @@ interface UserApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return \OpenAPI\Server\Model\User * @return \OpenAPI\Server\Model\User
*
*/ */
public function getUserByName($username, &$responseCode, array &$responseHeaders); public function getUserByName($username, &$responseCode, array &$responseHeaders);
@@ -132,7 +127,6 @@ interface UserApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return \string * @return \string
*
*/ */
public function loginUser($username, $password, &$responseCode, array &$responseHeaders); public function loginUser($username, $password, &$responseCode, array &$responseHeaders);
@@ -145,7 +139,6 @@ interface UserApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return void * @return void
*
*/ */
public function logoutUser(&$responseCode, array &$responseHeaders); public function logoutUser(&$responseCode, array &$responseHeaders);
@@ -160,7 +153,6 @@ interface UserApiInterface
* @param \array $responseHeaders Additional HTTP headers to return with the response () * @param \array $responseHeaders Additional HTTP headers to return with the response ()
* *
* @return void * @return void
*
*/ */
public function updateUser($username, User $user, &$responseCode, array &$responseHeaders); public function updateUser($username, User $user, &$responseCode, array &$responseHeaders);
} }

1
samples/server/petstore/php-symfony/SymfonyBundle-php/Controller/PetController.php
View File

@@ -324,6 +324,7 @@ class PetController extends Controller
* *
* @param Request $request The Symfony request to handle. * @param Request $request The Symfony request to handle.
* @return Response The Symfony response. * @return Response The Symfony response.
* @deprecated
*/ */
public function findPetsByTagsAction(Request $request) public function findPetsByTagsAction(Request $request)
{ {