Browse Source

update api contracts

pull/1/head
Nicolas Massé 7 years ago
parent
commit
080e8e8364
  1. 1
      api-contracts/beer-catalog-1.0.yaml
  2. 107
      api-contracts/beer-catalog-2.0.yaml

1
api-contracts/beer-catalog-1.0.yaml

@ -10,6 +10,7 @@ info:
name: 'MIT License'
url: 'https://opensource.org/licenses/MIT'
version: '1.0'
basePath: /api
paths:
'/beer/{name}':
get:

107
api-contracts/beer-catalog-2.0.yaml

@ -0,0 +1,107 @@
swagger: '2.0'
info:
title: 'Beer Catalog API'
description: 'An API for querying beer catalog of Acme Inc.'
contact:
name: 'Laurent Broudoux'
url: 'http://github.com/lbroudoux'
email: laurent.broudoux@gmail.com
license:
name: 'MIT License'
url: 'https://opensource.org/licenses/MIT'
version: '2.0'
basePath: /api
paths:
'/beer/{name}':
get:
tags:
- beer
summary: 'Get beer having name'
description: 'Get beer having name'
operationId: GetBeer
responses:
'200':
description: 'Beer having requested name'
schema:
$ref: '#/definitions/Beer'
parameters:
- name: name
in: path
description: 'Name of beer to retrieve'
required: true
type: string
'/beer/findByStatus/{status}':
get:
tags:
- beer
summary: 'Get beers having status'
description: 'Get beers having status'
operationId: FindBeersByStatus
responses:
'200':
description: 'List of beers having requested status'
schema:
type: array
items:
$ref: '#/definitions/Beer'
parameters:
- name: status
in: path
description: 'Status of beers to retrieve'
required: true
type: string
- name: page
in: query
description: 'Number of page to retrieve'
type: number
/beer:
get:
tags:
- beer
summary: 'List beers within catalog'
description: 'List beers within catalog'
operationId: ListBeers
responses:
'200':
description: 'Array of beers'
schema:
type: array
items:
$ref: '#/definitions/Beer'
parameters:
- name: page
in: query
description: 'Number of page to retrieve'
type: number
tags:
- name: beer
description: 'Beer resource'
definitions:
Beer:
properties:
name:
description: 'Name of Beer'
type: string
country:
description: 'Origin country of Beer'
type: string
type:
description: 'Type of Beer'
type: string
rating:
description: 'Rating from customers'
type: number
status:
description: 'Stock status'
type: string
securityDefinitions:
oidc:
type: oauth2
flow: accessCode
authorizationUrl: https://filled-later.dummy/auth
tokenUrl: https://filled-later.dummy/token
scopes:
openid: Get an OpenID Connect token
security:
- oidc:
- openid
Loading…
Cancel
Save