forked from zircote/swagger-php
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Added missing json-schema properties
- Loading branch information
Showing
18 changed files
with
1,836 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <?php | ||
|
|
||
| namespace PetstoreIO; | ||
|
|
||
| /** | ||
| * @SWG\Definition( | ||
| * @SWG\Xml(name="##default") | ||
| * ) | ||
| */ | ||
| class ApiResponse { | ||
|
|
||
| /** | ||
| * @SWG\Property(format="int32") | ||
| * @var int | ||
| */ | ||
| public $code; | ||
|
|
||
| /** | ||
| * @SWG\Property | ||
| * @var string | ||
| */ | ||
| public $type; | ||
|
|
||
| /** | ||
| * @SWG\Property | ||
| * @var string | ||
| */ | ||
| public $message; | ||
|
|
||
| } |
322 changes: 322 additions & 0 deletions
322
Examples/petstore.swagger.io/controllers/PetController.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,322 @@ | ||
| <?php | ||
|
|
||
| namespace PetstoreIO; | ||
|
|
||
| class PetController { | ||
|
|
||
| /** | ||
| * @SWG\Get( | ||
| * path="/pet/findByTags", | ||
| * summary="Finds Pets by tags", | ||
| * tags={"pet"}, | ||
| * description="Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.", | ||
| * operationId="findPetsByTags", | ||
| * consumes={"application/xml", "application/json"}, | ||
| * produces={"application/xml", "application/json"}, | ||
| * @SWG\Parameter( | ||
| * name="tags", | ||
| * in="query", | ||
| * description="Tags to filter by", | ||
| * required=false, | ||
| * type="array", | ||
| * @SWG\Items(type="string"), | ||
| * collectionFormat="multi" | ||
| * ), | ||
| * @SWG\Response( | ||
| * response=200, | ||
| * description="successful operation", | ||
| * @SWG\Schema( | ||
| * type="array", | ||
| * @SWG\Items(ref="#/definitions/Pet") | ||
| * ), | ||
| * ), | ||
| * @SWG\Response( | ||
| * response="400", | ||
| * description="Invalid tag value", | ||
| * ), | ||
| * security={ | ||
| * { | ||
| * "petstore_auth": {"write:pets", "read:pets"} | ||
| * } | ||
| * } | ||
| * ) | ||
| */ | ||
| function findByTags() { | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * @SWG\Get( | ||
| * path="/pet/findByStatus", | ||
| * summary="Finds Pets by status", | ||
| * description="Multiple status values can be provided with comma seperated strings", | ||
| * operationId="findPetsByStatus", | ||
| * consumes={"application/xml", "application/json"}, | ||
| * produces={"application/xml", "application/json"}, | ||
| * tags={"pet"}, | ||
| * @SWG\Parameter( | ||
| * name="status", | ||
| * in="query", | ||
| * description="Status values that need to be considered for filter", | ||
| * required=false, | ||
| * type="array", | ||
| * @SWG\Items(type="string"), | ||
| * collectionFormat="multi", | ||
| * default="available", | ||
| * enum={"available", "pending", "sold"} | ||
| * ), | ||
| * @SWG\Response( | ||
| * response=200, | ||
| * description="successful operation", | ||
| * @SWG\Schema( | ||
| * type="array", | ||
| * @SWG\Items(ref="#/definitions/Pet") | ||
| * ), | ||
| * ), | ||
| * @SWG\Response( | ||
| * response="400", | ||
| * description="Invalid status value", | ||
| * ), | ||
| * security={ | ||
| * {"petstore_auth": {"write:pets", "read:pets"}} | ||
| * } | ||
| * ) | ||
| */ | ||
| function findByStatus() { | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * @SWG\Get( | ||
| * path="/pet/{petId}", | ||
| * summary="Find pet by ID", | ||
| * description="Returns a single pet", | ||
| * operationId="getPetById", | ||
| * tags={"pet"}, | ||
| * consumes={ | ||
| * "application/xml", | ||
| * "application/json", | ||
| * "application/x-www-form-urlencoded" | ||
| * }, | ||
| * produces={"application/xml", "application/json"}, | ||
| * @SWG\Parameter( | ||
| * description="ID of pet to return", | ||
| * in="path", | ||
| * name="petId", | ||
| * required=true, | ||
| * type="integer", | ||
| * format="int64" | ||
| * ), | ||
| * @SWG\Response( | ||
| * response=200, | ||
| * description="successful operation", | ||
| * @SWG\Schema(ref="#/definitions/Pet") | ||
| * ), | ||
| * @SWG\Response( | ||
| * response="400", | ||
| * description="Invalid ID supplied" | ||
| * ), | ||
| * @SWG\Response( | ||
| * response="404", | ||
| * description="Pet not found" | ||
| * ), | ||
| * security={ | ||
| * {"api_key": {}}, | ||
| * {"petstore_auth": {"write:pets", "read:pets"}} | ||
| * } | ||
| * ) | ||
| */ | ||
| function getPetById() { | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * @SWG\Post( | ||
| * path="/pet", | ||
| * tags={"pet"}, | ||
| * operationId="addPet", | ||
| * summary="Add a new pet to the store", | ||
| * description="", | ||
| * consumes={"application/json", "application/xml"}, | ||
| * produces={"application/xml", "application/json"}, | ||
| * @SWG\Parameter( | ||
| * name="body", | ||
| * in="body", | ||
| * description="Pet object that needs to be added to the store", | ||
| * required=false, | ||
| * @SWG\Schema(ref="#/definitions/Pet"), | ||
| * ), | ||
| * @SWG\Response( | ||
| * response=405, | ||
| * description="Invalid input", | ||
| * ), | ||
| * security={{"petstore_auth":{"write:pets", "read:pets"}}} | ||
| * ) | ||
| */ | ||
| function addPet() { | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * @SWG\Put( | ||
| * path="/pet", | ||
| * tags={"pet"}, | ||
| * operationId="updatePet", | ||
| * summary="Update an existing pet", | ||
| * description="", | ||
| * consumes={"application/json", "application/xml"}, | ||
| * produces={"application/xml", "application/json"}, | ||
| * @SWG\Parameter( | ||
| * name="body", | ||
| * in="body", | ||
| * description="Pet object that needs to be added to the store", | ||
| * required=false, | ||
| * @SWG\Schema(ref="#/definitions/Pet"), | ||
| * ), | ||
| * @SWG\Response( | ||
| * response=400, | ||
| * description="Invalid ID supplied", | ||
| * ), | ||
| * @SWG\Response( | ||
| * response=404, | ||
| * description="Pet not found", | ||
| * ), | ||
| * @SWG\Response( | ||
| * response=405, | ||
| * description="Validation exception", | ||
| * ), | ||
| * security={{"petstore_auth":{"write:pets", "read:pets"}}} | ||
| * ) | ||
| */ | ||
| function updatePet() { | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * @SWG\Delete( | ||
| * path="/pet/{petId}", | ||
| * summary="Deletes a pet", | ||
| * description="", | ||
| * operationId="deletePet", | ||
| * consumes={"application/xml", "application/json", "multipart/form-data", "application/x-www-form-urlencoded"}, | ||
| * produces={"application/xml", "application/json"}, | ||
| * tags={"pet"}, | ||
| * @SWG\Parameter( | ||
| * description="Pet id to delete", | ||
| * in="path", | ||
| * name="petId", | ||
| * required=true, | ||
| * type="integer", | ||
| * format="int64" | ||
| * ), | ||
| * @SWG\Parameter( | ||
| * name="api_key", | ||
| * in="header", | ||
| * description="", | ||
| * required=false, | ||
| * type="string" | ||
| * ), | ||
| * @SWG\Response( | ||
| * response=400, | ||
| * description="Invalid pet value" | ||
| * ), | ||
| * security={{"petstore_auth":{"write:pets", "read:pets"}}} | ||
| * ) | ||
| */ | ||
| function deletePet() { | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * @SWG\Post( | ||
| * path="/pet/{petId}", | ||
| * tags={"pet"}, | ||
| * summary="Updates a pet in the store with form data", | ||
| * description="", | ||
| * operationId="updatePetWithForm", | ||
| * consumes={"application/x-www-form-urlencoded"}, | ||
| * produces={"application/xml", "application/json"}, | ||
| * @SWG\Parameter( | ||
| * name="petId", | ||
| * in="path", | ||
| * description="ID of pet that needs to be updated", | ||
| * required=true, | ||
| * type="string" | ||
| * ), | ||
| * @SWG\Parameter( | ||
| * name="name", | ||
| * in="formData", | ||
| * description="Updated name of the pet", | ||
| * required=false, | ||
| * type="string" | ||
| * ), | ||
| * @SWG\Parameter( | ||
| * name="status", | ||
| * in="formData", | ||
| * description="Updated status of the pet", | ||
| * required=false, | ||
| * type="string" | ||
| * ), | ||
| * @SWG\Response(response="405",description="Invalid input"), | ||
| * security={{ | ||
| * "petstore_auth": {"write:pets", "read:pets"} | ||
| * }} | ||
| * ) | ||
| */ | ||
| function updatePetWithForm() { | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * @SWG\Post( | ||
| * path="/pet/{petId}/uploadImage", | ||
| * consumes={"multipart/form-data"}, | ||
| * description="", | ||
| * operationId="uploadFile", | ||
| * @SWG\Parameter( | ||
| * description="Additional data to pass to server", | ||
| * in="formData", | ||
| * name="additionalMetadata", | ||
| * required=false, | ||
| * type="string" | ||
| * ), | ||
| * @SWG\Parameter( | ||
| * description="file to upload", | ||
| * in="formData", | ||
| * name="file", | ||
| * required=false, | ||
| * type="file" | ||
| * ), | ||
| * @SWG\Parameter( | ||
| * description="ID of pet to update", | ||
| * format="int64", | ||
| * in="path", | ||
| * name="petId", | ||
| * required=true, | ||
| * type="integer" | ||
| * ), | ||
| * produces={"application/json"}, | ||
| * @SWG\Response( | ||
| * response="200", | ||
| * description="successful operation", | ||
| * @SWG\Schema(ref="#/definitions/ApiResponse") | ||
| * ), | ||
| * security={ | ||
| * { | ||
| * "petstore_auth": { | ||
| * "read:pets", | ||
| * "write:pets" | ||
| * } | ||
| * } | ||
| * }, | ||
| * summary="uploads an image", | ||
| * tags={ | ||
| * "pet" | ||
| * } | ||
| * ) | ||
| * */ | ||
| function uploadFile() { | ||
|
|
||
| } | ||
|
|
||
| } |
Oops, something went wrong.