loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-12-19 22:27:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

switch to oas3 spec for php-symfony samples (#9248)

Browse Source
This commit is contained in:
William Cheng
2021-04-14 10:36:48 +08:00
committed by GitHub
parent 1b63822501
commit c285f393b0
12 changed files with 215 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
samples/server/petstore/php-symfony/SymfonyBundle-php/Resources/docs/Api/PetApiInterface.md
View File

@@ -27,7 +27,7 @@ services:
```
## **addPet**
> addPet($body)
> OpenAPI\Server\Model\Pet addPet($pet)
Add a new pet to the store
@@ -56,7 +56,7 @@ class PetApi implements PetApiInterface
/**
* Implementation of PetApiInterface#addPet
*/
public function addPet(Pet $body)
public function addPet(Pet $pet)
{
// Implement the operation ...
}
@@ -69,11 +69,11 @@ class PetApi implements PetApiInterface
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**OpenAPI\Server\Model\Pet**](../Model/Pet.md)| Pet object that needs to be added to the store |
**pet** | [**OpenAPI\Server\Model\Pet**](../Model/Pet.md)| Pet object that needs to be added to the store |
### Return type
void (empty response body)
[**OpenAPI\Server\Model\Pet**](../Model/Pet.md)
### Authorization
@@ -82,7 +82,7 @@ void (empty response body)
### HTTP request headers
- **Content-Type**: application/json, application/xml
- **Accept**: Not defined
- **Accept**: application/xml, application/json
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
@@ -334,7 +334,7 @@ Name | Type | Description | Notes
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
## **updatePet**
> updatePet($body)
> OpenAPI\Server\Model\Pet updatePet($pet)
Update an existing pet
@@ -363,7 +363,7 @@ class PetApi implements PetApiInterface
/**
* Implementation of PetApiInterface#updatePet
*/
public function updatePet(Pet $body)
public function updatePet(Pet $pet)
{
// Implement the operation ...
}
@@ -376,11 +376,11 @@ class PetApi implements PetApiInterface
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**OpenAPI\Server\Model\Pet**](../Model/Pet.md)| Pet object that needs to be added to the store |
**pet** | [**OpenAPI\Server\Model\Pet**](../Model/Pet.md)| Pet object that needs to be added to the store |
### Return type
void (empty response body)
[**OpenAPI\Server\Model\Pet**](../Model/Pet.md)
### Authorization
@@ -389,7 +389,7 @@ void (empty response body)
### HTTP request headers
- **Content-Type**: application/json, application/xml
- **Accept**: Not defined
- **Accept**: application/xml, application/json
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)

8
samples/server/petstore/php-symfony/SymfonyBundle-php/Resources/docs/Api/StoreApiInterface.md
View File

@@ -190,7 +190,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
## **placeOrder**
> OpenAPI\Server\Model\Order placeOrder($body)
> OpenAPI\Server\Model\Order placeOrder($order)
Place an order for a pet
@@ -211,7 +211,7 @@ class StoreApi implements StoreApiInterface
/**
* Implementation of StoreApiInterface#placeOrder
*/
public function placeOrder(Order $body)
public function placeOrder(Order $order)
{
// Implement the operation ...
}
@@ -224,7 +224,7 @@ class StoreApi implements StoreApiInterface
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**OpenAPI\Server\Model\Order**](../Model/Order.md)| order placed for purchasing the pet |
**order** | [**OpenAPI\Server\Model\Order**](../Model/Order.md)| order placed for purchasing the pet |
### Return type
@@ -236,7 +236,7 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: application/xml, application/json
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)

92
samples/server/petstore/php-symfony/SymfonyBundle-php/Resources/docs/Api/UserApiInterface.md
View File

@@ -27,7 +27,7 @@ services:
```
## **createUser**
> createUser($body)
> createUser($user)
Create user
@@ -45,12 +45,20 @@ use OpenAPI\Server\Api\UserApiInterface;
class UserApi implements UserApiInterface
{
/**
* Configure API key authorization: api_key
*/
public function setapi_key($apiKey)
{
// Retrieve logged in user from $apiKey ...
}
// ...
/**
* Implementation of UserApiInterface#createUser
*/
public function createUser(User $body)
public function createUser(User $user)
{
// Implement the operation ...
}
@@ -63,7 +71,7 @@ class UserApi implements UserApiInterface
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**OpenAPI\Server\Model\User**](../Model/User.md)| Created user object |
**user** | [**OpenAPI\Server\Model\User**](../Model/User.md)| Created user object |
### Return type
@@ -71,17 +79,17 @@ void (empty response body)
### Authorization
No authorization required
[api_key](../../README.md#api_key)
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
## **createUsersWithArrayInput**
> createUsersWithArrayInput($body)
> createUsersWithArrayInput($user)
Creates list of users with given input array
@@ -97,12 +105,20 @@ use OpenAPI\Server\Api\UserApiInterface;
class UserApi implements UserApiInterface
{
/**
* Configure API key authorization: api_key
*/
public function setapi_key($apiKey)
{
// Retrieve logged in user from $apiKey ...
}
// ...
/**
* Implementation of UserApiInterface#createUsersWithArrayInput
*/
public function createUsersWithArrayInput(array $body)
public function createUsersWithArrayInput(array $user)
{
// Implement the operation ...
}
@@ -115,7 +131,7 @@ class UserApi implements UserApiInterface
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**OpenAPI\Server\Model\User**](../Model/User.md)| List of user object |
**user** | [**OpenAPI\Server\Model\User**](../Model/User.md)| List of user object |
### Return type
@@ -123,17 +139,17 @@ void (empty response body)
### Authorization
No authorization required
[api_key](../../README.md#api_key)
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
## **createUsersWithListInput**
> createUsersWithListInput($body)
> createUsersWithListInput($user)
Creates list of users with given input array
@@ -149,12 +165,20 @@ use OpenAPI\Server\Api\UserApiInterface;
class UserApi implements UserApiInterface
{
/**
* Configure API key authorization: api_key
*/
public function setapi_key($apiKey)
{
// Retrieve logged in user from $apiKey ...
}
// ...
/**
* Implementation of UserApiInterface#createUsersWithListInput
*/
public function createUsersWithListInput(array $body)
public function createUsersWithListInput(array $user)
{
// Implement the operation ...
}
@@ -167,7 +191,7 @@ class UserApi implements UserApiInterface
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**OpenAPI\Server\Model\User**](../Model/User.md)| List of user object |
**user** | [**OpenAPI\Server\Model\User**](../Model/User.md)| List of user object |
### Return type
@@ -175,11 +199,11 @@ void (empty response body)
### Authorization
No authorization required
[api_key](../../README.md#api_key)
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
@@ -203,6 +227,14 @@ use OpenAPI\Server\Api\UserApiInterface;
class UserApi implements UserApiInterface
{
/**
* Configure API key authorization: api_key
*/
public function setapi_key($apiKey)
{
// Retrieve logged in user from $apiKey ...
}
// ...
/**
@@ -229,7 +261,7 @@ void (empty response body)
### Authorization
No authorization required
[api_key](../../README.md#api_key)
### HTTP request headers
@@ -360,6 +392,14 @@ use OpenAPI\Server\Api\UserApiInterface;
class UserApi implements UserApiInterface
{
/**
* Configure API key authorization: api_key
*/
public function setapi_key($apiKey)
{
// Retrieve logged in user from $apiKey ...
}
// ...
/**
@@ -383,7 +423,7 @@ void (empty response body)
### Authorization
No authorization required
[api_key](../../README.md#api_key)
### HTTP request headers
@@ -393,7 +433,7 @@ No authorization required
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
## **updateUser**
> updateUser($username, $body)
> updateUser($username, $user)
Updated user
@@ -411,12 +451,20 @@ use OpenAPI\Server\Api\UserApiInterface;
class UserApi implements UserApiInterface
{
/**
* Configure API key authorization: api_key
*/
public function setapi_key($apiKey)
{
// Retrieve logged in user from $apiKey ...
}
// ...
/**
* Implementation of UserApiInterface#updateUser
*/
public function updateUser($username, User $body)
public function updateUser($username, User $user)
{
// Implement the operation ...
}
@@ -430,7 +478,7 @@ class UserApi implements UserApiInterface
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **string**| name that need to be deleted |
**body** | [**OpenAPI\Server\Model\User**](../Model/User.md)| Updated user object |
**user** | [**OpenAPI\Server\Model\User**](../Model/User.md)| Updated user object |
### Return type
@@ -438,11 +486,11 @@ void (empty response body)
### Authorization
No authorization required
[api_key](../../README.md#api_key)
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)