Version: 1.0.0
Title: Example OpenAPI Version 2 Specification
Description: Example OpenAPI Version 2 Specification
Host: api.example.com
BasePath: /api
Consumes: [application/json]
Produces: [application/json application/text]
/contacts: get
Get a list of contacts by ids
query parameters
- ids:
array
responses
- code:
200, type:services.ContactResponse- id:
string
- id:
- code:
400, type: ``- code:
integer - description:
string - status:
string
- code:
default, type:Error- code:
integer - status:
string
- code:
/contacts: post
Create a new contact request entity.
body parameter
- body:
services.ContactRequest- address:
object- city:
string - state:
string - street:
string - zipCode:
string
- city:
- eMail:
string, format:email - firstName:
string - id:
string - lastName:
string
- address:
responses
- code:
200, type:services.ContactResponse- id:
string
- id:
default, type:Error- code:
integer - status:
string
- code:
/contacts: delete
DeleteBulk contact by id
query parameters
- ids:
array
responses
default, type:Error- code:
integer - status:
string
- code:
/contacts/{id}: get
GetOne contact by id
id contact id
path parameters
- id:
integer
responses
- code:
200, type:services.ContactResponse- id:
string
- id:
default, type:Error- code:
integer - status:
string
- code:
/contacts/{id}: post
Update a contact entity with provided data.
path parameters
- id:
integer
body parameter
- body:
services.ContactRequest- address:
object- city:
string - state:
string - street:
string - zipCode:
string
- city:
- eMail:
string, format:email - firstName:
string - id:
string - lastName:
string
- address:
responses
- code:
200, type:services.ContactResponse- id:
string
- id:
default, type:Error- code:
integer - status:
string
- code:
/contacts/{id}: put
Replace a contact entity completely.
path parameters
- id:
integer
body parameter
- body:
services.ContactRequest- address:
object- city:
string - state:
string - street:
string - zipCode:
string
- city:
- eMail:
string, format:email - firstName:
string - id:
string - lastName:
string
- address:
responses
- code:
200, type:services.ContactResponse- id:
string
- id:
default, type:Error- code:
integer - status:
string
- code:
/contacts/{month}-{day}-{year}: get
Get contacts list by date
path parameters
- month:
string - day:
string - year:
string
responses
- code:
200, type:services.ContactResponse- id:
string
- id:
default, type:Error- code:
integer - status:
string
- code:
/doodads: post
Create a new doodad entity.
body parameter
- body:
models.ThingRequest- name:
string
- name:
responses
- code:
200, type:models.ThingResponse- bool:
boolean - createDate:
string, format:date-time,2006-01-02 - float32:
number, format:float - float64:
number, format:double - int:
integer - int16:
integer, format:int16 - int32:
integer, format:int32 - int64:
integer, format:int64 - int8:
integer, format:int8 - name:
string - uint:
integer - uint16:
integer, format:int16 - uint32:
integer, format:int32 - uint64:
integer, format:int64 - uint8:
integer, format:int8 - updateDate:
string, format:date-time
- bool:
default, type:Error- code:
integer - status:
string
- code:
/echo/{input}: get
Echo returns body with 'i's replaced with 'o's
path parameters
- input:
string
responses
- code:
200, type:EchoResponse- output:
string
- output:
default, type:Error- code:
integer - status:
string
- code:
/ping: post
Ping returns body with 'i's replaced with 'o's
body parameter
- body:
services.PingRequest- input:
string
- input:
responses
- code:
200, type:services.PingResponse- output:
string
- output:
default, type:Error- code:
integer - status:
string
- code:
/things: get
A short summary of this endpoint
path parameters
- notgood:
stringformat:eMail
query parameters
- from:
string, format:date-time,2006-01-02 - to:
string, format:date-time,2006-01-02
responses
- code:
200, type:ThingListResponse- things:
[]array- bool:
boolean - createDate:
string, format:date-time,2006-01-02 - float32:
number, format:float - float64:
number, format:double - int:
integer - int16:
integer, format:int16 - int32:
integer, format:int32 - int64:
integer, format:int64 - int8:
integer, format:int8 - name:
string - uint:
integer - uint16:
integer, format:int16 - uint32:
integer, format:int32 - uint64:
integer, format:int64 - uint8:
integer, format:int8 - updateDate:
string, format:date-time
- bool:
- things:
- code:
400, type: ``- code:
integer - description:
string - status:
string
- code:
- code:
404, type: ``- code:
integer - description:
string - status:
string
- code:
default, type:Error- code:
integer - status:
string
- code:
/things: post
Create thing
body parameter
- body:
models.ThingRequest- name:
string
- name:
responses
- code:
200, type:models.ThingResponse- bool:
boolean - createDate:
string, format:date-time,2006-01-02 - float32:
number, format:float - float64:
number, format:double - int:
integer - int16:
integer, format:int16 - int32:
integer, format:int32 - int64:
integer, format:int64 - int8:
integer, format:int8 - name:
string - uint:
integer - uint16:
integer, format:int16 - uint32:
integer, format:int32 - uint64:
integer, format:int64 - uint8:
integer, format:int8 - updateDate:
string, format:date-time
- bool:
default, type:Error- code:
integer - status:
string
- code:
/things/{category}: get
Get things by category and search query
path parameters
- category:
string
query parameters
- q:
string
responses
- code:
200, type:ThingListResponse- things:
[]array- bool:
boolean - createDate:
string, format:date-time,2006-01-02 - float32:
number, format:float - float64:
number, format:double - int:
integer - int16:
integer, format:int16 - int32:
integer, format:int32 - int64:
integer, format:int64 - int8:
integer, format:int8 - name:
string - uint:
integer - uint16:
integer, format:int16 - uint32:
integer, format:int32 - uint64:
integer, format:int64 - uint8:
integer, format:int8 - updateDate:
string, format:date-time
- bool:
- things:
default, type:Error- code:
integer - status:
string
- code:
/things/{id}: delete
Delete thing by id
path parameters
- id:
integer
responses
default, type:Error- code:
integer - status:
string
- code: