loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/samples/documentation/markdown/Apis/PetApi.md
Samuel Hoffstaetter de2753dfc7
[markdown] Fix broken links when generating markdown (#5569) 
* [markdown] Fix broken links when generating markdown

The `api.mustache` file generates links to the markdown model files.
These links were previously brokeen.

Additionally, the defaultPackage for markdown is "/Models", so this
looked pretty in the heading for model files. So this prefix has been
stripped from the header in `model.mustache`.

* Re-generate Petstore samples for markdown
2020-03-11 01:30:00 +08:00

5.4 KiB
Raw Blame History

PetApi

All URIs are relative to http://petstore.swagger.io/v2

Method HTTP request Description
addPet POST /pet Add a new pet to the store
deletePet DELETE /pet/{petId} Deletes a pet
findPetsByStatus GET /pet/findByStatus Finds Pets by status
findPetsByTags GET /pet/findByTags Finds Pets by tags
getPetById GET /pet/{petId} Find pet by ID
updatePet PUT /pet Update an existing pet
updatePetWithForm POST /pet/{petId} Updates a pet in the store with form data
uploadFile POST /pet/{petId}/uploadImage uploads an image

addPet

addPet(body)

Add a new pet to the store

Parameters

Name Type Description Notes
body Pet Pet object that needs to be added to the store

Return type

null (empty response body)

Authorization

petstore_auth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: Not defined

deletePet

deletePet(petId, apiKey)

Deletes a pet

Parameters

Name Type Description Notes
petId Long Pet id to delete [default to null]
apiKey String [optional] [default to null]

Return type

null (empty response body)

Authorization

petstore_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

findPetsByStatus

List findPetsByStatus(status)

Finds Pets by status

Multiple status values can be provided with comma separated strings

Parameters

Name Type Description Notes
status List Status values that need to be considered for filter [default to null] [enum: available, pending, sold]

Return type

List

Authorization

petstore_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

findPetsByTags

List findPetsByTags(tags)

Finds Pets by tags

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Parameters

Name Type Description Notes
tags List Tags to filter by [default to null]

Return type

List

Authorization

petstore_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

getPetById

Pet getPetById(petId)

Find pet by ID

Returns a single pet

Parameters

Name Type Description Notes
petId Long ID of pet to return [default to null]

Return type

Pet

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

updatePet

updatePet(body)

Update an existing pet

Parameters

Name Type Description Notes
body Pet Pet object that needs to be added to the store

Return type

null (empty response body)

Authorization

petstore_auth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: Not defined

updatePetWithForm

updatePetWithForm(petId, name, status)

Updates a pet in the store with form data

Parameters

Name Type Description Notes
petId Long ID of pet that needs to be updated [default to null]
name String Updated name of the pet [optional] [default to null]
status String Updated status of the pet [optional] [default to null]

Return type

null (empty response body)

Authorization

petstore_auth

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: Not defined

uploadFile

ApiResponse uploadFile(petId, additionalMetadata, file)

uploads an image

Parameters

Name Type Description Notes
petId Long ID of pet to update [default to null]
additionalMetadata String Additional data to pass to server [optional] [default to null]
file File file to upload [optional] [default to null]

Return type

ApiResponse

Authorization

petstore_auth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json