mirror of
https://github.com/adidas/api-guidelines.git
synced 2025-10-24 15:19:17 +00:00
Replaced valid YAML file OAS example
This commit is contained in:
dediejes
@@ -1,365 +0,0 @@
|
||||
swagger: '2.0'
|
||||
info:
|
||||
version: '3.0.0'
|
||||
title: '[Demo] Orders API'
|
||||
contact:
|
||||
name: Z
|
||||
email: "z@goodapi.co"
|
||||
description: |
|
||||
Sample API conforming to [adidas API Guidelines](https://adidas.gitbook.io/api-guidelines/).
|
||||
|
||||
produces:
|
||||
- application/hal+json # Representation message format
|
||||
- application/problem+json # Error message format
|
||||
|
||||
schemes:
|
||||
- https
|
||||
|
||||
host: "example.com"
|
||||
|
||||
securityDefinitions:
|
||||
'API Key':
|
||||
type: apiKey
|
||||
in: header
|
||||
name: x-api-key
|
||||
|
||||
security:
|
||||
- "API Key": []
|
||||
|
||||
paths:
|
||||
/:
|
||||
x-summary: API Root
|
||||
|
||||
get:
|
||||
summary: Retrieve API Root
|
||||
description: The API Root contains the initial set of link relations.
|
||||
responses:
|
||||
200:
|
||||
description: The root of the API
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/definitions/supermodelIoAdidasApiHAL'
|
||||
example:
|
||||
_links:
|
||||
self:
|
||||
href: /
|
||||
orders:
|
||||
href: /orders
|
||||
|
||||
/orders:
|
||||
x-summary: List of Orders
|
||||
|
||||
get:
|
||||
summary: Retrieve List of Orders
|
||||
description: Retrieves a list of orders with pagination.
|
||||
parameters:
|
||||
- $ref: '#/parameters/offset'
|
||||
- $ref: '#/parameters/limit'
|
||||
responses:
|
||||
200:
|
||||
description: The list of Orders
|
||||
schema:
|
||||
$ref: '#/definitions/supermodelIoAdidasExamplesOrderApiOrders'
|
||||
|
||||
post:
|
||||
summary: Create a New Order
|
||||
description: Creates a new order.
|
||||
consumes:
|
||||
- application/json
|
||||
parameters:
|
||||
- name: Order
|
||||
in: body
|
||||
description: Order to be created
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/supermodelIoAdidasExamplesOrderOrder'
|
||||
responses:
|
||||
201:
|
||||
description: Newly created order
|
||||
schema:
|
||||
$ref: '#/definitions/supermodelIoAdidasExamplesOrderApiOrder'
|
||||
|
||||
/orders/{orderId}:
|
||||
x-summary: Order
|
||||
|
||||
parameters:
|
||||
- name: orderId
|
||||
in: path
|
||||
description: Id of the Order
|
||||
required: true
|
||||
type: string
|
||||
x-example: '1234'
|
||||
|
||||
get:
|
||||
summary: Retrieve Order
|
||||
description: Retrieves an order with specified fields.
|
||||
parameters:
|
||||
- $ref: '#/parameters/fields'
|
||||
responses:
|
||||
200:
|
||||
description: A particular Order
|
||||
schema:
|
||||
$ref: '#/definitions/supermodelIoAdidasExamplesOrderApiOrder'
|
||||
404:
|
||||
description: The request Order wasn't found
|
||||
headers:
|
||||
Content-Type:
|
||||
type: string
|
||||
default: application/problem+json
|
||||
schema:
|
||||
allOf:
|
||||
- $ref: '#/definitions/supermodelIoAdidasApiProblemDetail'
|
||||
example:
|
||||
title: 'Not Found'
|
||||
detail: 'Cannot find the requested order'
|
||||
status: 404
|
||||
instance: '/orders/1234'
|
||||
|
||||
patch:
|
||||
summary: Update Order
|
||||
description: Does a partial update of an order.
|
||||
consumes:
|
||||
- application/json
|
||||
parameters:
|
||||
- name: Order
|
||||
in: body
|
||||
description: Partial order update
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/supermodelIoAdidasExamplesOrderApiOrderPatch'
|
||||
responses:
|
||||
200:
|
||||
description: The Order was updated
|
||||
schema:
|
||||
$ref: '#/definitions/supermodelIoAdidasExamplesOrderApiOrder'
|
||||
|
||||
delete:
|
||||
summary: Delete Order
|
||||
description: Deletes an order without returning its instance.
|
||||
produces: []
|
||||
responses:
|
||||
204:
|
||||
description: The Order was deleted
|
||||
|
||||
parameters:
|
||||
# adidas API guidelines: Pagination
|
||||
offset:
|
||||
name: offset
|
||||
in: query
|
||||
description: Number of results to skip from the start of the list
|
||||
required: false
|
||||
type: string
|
||||
default: '0'
|
||||
x-example: '10'
|
||||
|
||||
# adidas API guidelines: Pagination
|
||||
limit:
|
||||
name: limit
|
||||
in: query
|
||||
description: The maximum number of reusults to return
|
||||
required: false
|
||||
type: string
|
||||
default: '10'
|
||||
x-example: '5'
|
||||
|
||||
# adidas API guidelines: Sparse fieldset
|
||||
fields:
|
||||
name: fields
|
||||
in: query
|
||||
description: Comma-separated list of fields to include in the response
|
||||
required: false
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
collectionFormat: csv
|
||||
x-example:
|
||||
- articleNumber
|
||||
- modelNumber
|
||||
|
||||
# adidas API guidelines: Sparse fieldset
|
||||
embedded:
|
||||
name: embedded
|
||||
in: query
|
||||
description: Comma-separated list of resource (relations) to embed in the response
|
||||
required: false
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
collectionFormat: csv
|
||||
x-example:
|
||||
- prices
|
||||
- assets
|
||||
|
||||
# DO NOT EDIT
|
||||
# This definitions section is automatically generated by supermodel.io
|
||||
#
|
||||
# http://supermodel.io
|
||||
# https://github.com/supermodel/supermodel-cli
|
||||
definitions:
|
||||
supermodelIoAdidasExamplesOrderApiOrder:
|
||||
title: Order HAL Representation
|
||||
type: object
|
||||
allOf:
|
||||
- $ref: '#/definitions/supermodelIoAdidasApiHAL'
|
||||
- $ref: '#/definitions/supermodelIoAdidasExamplesOrderOrder'
|
||||
example:
|
||||
_links:
|
||||
self:
|
||||
href: /orders/1234
|
||||
edit:
|
||||
href: /orders/1234
|
||||
delete:
|
||||
href: /orders/1234
|
||||
profile:
|
||||
href: 'https://adidas-group.com/gdm/OMS'
|
||||
orderNumber: 1234
|
||||
itemCount: 42
|
||||
status: pending
|
||||
supermodelIoAdidasExamplesOrderApiOrderPatch:
|
||||
title: OrderPatch
|
||||
description: OrderPatch model description
|
||||
type: object
|
||||
allOf:
|
||||
- $ref: '#/definitions/supermodelIoAdidasExamplesOrderOrder'
|
||||
example:
|
||||
status: cancelled
|
||||
orderNumber: 1
|
||||
itemCount: 2
|
||||
supermodelIoAdidasExamplesOrderApiOrders:
|
||||
title: Collection of Orders HAL Representation
|
||||
type: object
|
||||
allOf:
|
||||
- $ref: '#/definitions/supermodelIoAdidasApiHAL'
|
||||
example:
|
||||
_links:
|
||||
self:
|
||||
href: /orders
|
||||
create:
|
||||
href: /orders
|
||||
next:
|
||||
href: /orders?offset=5&limit=5
|
||||
first:
|
||||
href: /orders?offset=0&limit=5
|
||||
last:
|
||||
href: /orders?offset=40&limit=5
|
||||
_embedded:
|
||||
order:
|
||||
- _links:
|
||||
self:
|
||||
href: /orders/1234
|
||||
edit:
|
||||
href: /orders/1234
|
||||
delete:
|
||||
href: /orders/1234
|
||||
profile:
|
||||
href: 'https://adidas-group.com/gdm/OMS'
|
||||
orderNumber: 1234
|
||||
itemCount: 42
|
||||
status: pending
|
||||
supermodelIoAdidasExamplesOrderApiProblemDetail:
|
||||
title: Problem Detail
|
||||
type: object
|
||||
allOf:
|
||||
- $ref: '#/definitions/supermodelIoAdidasApiProblemDetail'
|
||||
supermodelIoAdidasApiHAL:
|
||||
title: HAL
|
||||
description: >-
|
||||
JSON Hypertext Application Language. Definition of [HAL message
|
||||
format](https://tools.ietf.org/html/draft-kelly-json-hal-08)
|
||||
type: object
|
||||
properties:
|
||||
_links:
|
||||
type: object
|
||||
additionalProperties:
|
||||
allOf:
|
||||
- $ref: '#/definitions/supermodelIoAdidasApiHALDefinitionsHalLinkObject'
|
||||
- type: array
|
||||
items:
|
||||
$ref: '#/definitions/supermodelIoAdidasApiHALDefinitionsHalLinkObject'
|
||||
properties:
|
||||
curies:
|
||||
allOf:
|
||||
- $ref: '#/definitions/supermodelIoAdidasApiHALDefinitionsHalCuriesLink'
|
||||
- type: array
|
||||
items:
|
||||
$ref: >-
|
||||
#/definitions/supermodelIoAdidasApiHALDefinitionsHalCuriesLink
|
||||
_embedded:
|
||||
type: object
|
||||
additionalProperties:
|
||||
allOf:
|
||||
- $ref: '#/definitions/supermodelIoAdidasApiHAL'
|
||||
- type: array
|
||||
items:
|
||||
$ref: '#/definitions/supermodelIoAdidasApiHAL'
|
||||
supermodelIoAdidasApiHALDefinitionsHalLinkObject:
|
||||
title: HAL Link Object
|
||||
type: object
|
||||
properties:
|
||||
href:
|
||||
type: string
|
||||
templated:
|
||||
type: boolean
|
||||
type:
|
||||
type: string
|
||||
deprecation:
|
||||
type: string
|
||||
name:
|
||||
type: string
|
||||
profile:
|
||||
type: string
|
||||
title:
|
||||
type: string
|
||||
hreflang:
|
||||
type: string
|
||||
required:
|
||||
- href
|
||||
supermodelIoAdidasApiHALDefinitionsHalCuriesLink:
|
||||
title: HAL Curies Link
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
templated:
|
||||
enum:
|
||||
- true
|
||||
required:
|
||||
- templated
|
||||
- $ref: '#/definitions/supermodelIoAdidasApiHALDefinitionsHalLinkObject'
|
||||
supermodelIoAdidasExamplesOrderOrder:
|
||||
title: Order
|
||||
type: object
|
||||
description: Order model description
|
||||
properties:
|
||||
orderNumber:
|
||||
type: number
|
||||
itemCount:
|
||||
type: number
|
||||
status:
|
||||
type: string
|
||||
required:
|
||||
- orderNumber
|
||||
- itemCount
|
||||
example:
|
||||
orderNumber: 42
|
||||
itemCount: 3
|
||||
status: pending
|
||||
supermodelIoAdidasApiProblemDetail:
|
||||
title: Problem Details for HTTP APIs
|
||||
description: >-
|
||||
Definition of [RFC7807](https://tools.ietf.org/html/rfc7807) problem
|
||||
detail
|
||||
type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
title:
|
||||
type: string
|
||||
status:
|
||||
type: number
|
||||
detail:
|
||||
type: string
|
||||
instance:
|
||||
type: string
|
||||
required:
|
||||
- title
|
||||
- detail
|
||||
@@ -1,158 +1,164 @@
|
||||
openapi: "3.0.0"
|
||||
info:
|
||||
version: 1.0.0
|
||||
title: Swagger Petstore
|
||||
description: A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification
|
||||
termsOfService: http://swagger.io/terms/
|
||||
contact:
|
||||
name: Swagger API Team
|
||||
email: apiteam@swagger.io
|
||||
url: http://swagger.io
|
||||
license:
|
||||
name: Apache 2.0
|
||||
url: https://www.apache.org/licenses/LICENSE-2.0.html
|
||||
servers:
|
||||
- url: http://petstore.swagger.io/api
|
||||
paths:
|
||||
/pets:
|
||||
get:
|
||||
description: |
|
||||
Returns all pets from the system that the user has access to
|
||||
Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
|
||||
|
||||
Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
|
||||
operationId: findPets
|
||||
parameters:
|
||||
- name: tags
|
||||
in: query
|
||||
description: tags to filter by
|
||||
required: false
|
||||
style: form
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
- name: limit
|
||||
in: query
|
||||
description: maximum number of results to return
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
format: int32
|
||||
responses:
|
||||
'200':
|
||||
description: pet response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
default:
|
||||
description: unexpected error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
post:
|
||||
description: Creates a new pet in the store. Duplicates are allowed
|
||||
operationId: addPet
|
||||
requestBody:
|
||||
description: Pet to add to the store
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NewPet'
|
||||
responses:
|
||||
'200':
|
||||
description: pet response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
default:
|
||||
description: unexpected error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
/pets/{id}:
|
||||
get:
|
||||
description: Returns a user based on a single ID, if the user does not have access to the pet
|
||||
operationId: find pet by id
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: ID of pet to fetch
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
responses:
|
||||
'200':
|
||||
description: pet response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
default:
|
||||
description: unexpected error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
delete:
|
||||
description: deletes a single pet based on the ID supplied
|
||||
operationId: deletePet
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: ID of pet to delete
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
responses:
|
||||
'204':
|
||||
description: pet deleted
|
||||
default:
|
||||
description: unexpected error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
components:
|
||||
schemas:
|
||||
Pet:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/NewPet'
|
||||
- type: object
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
|
||||
NewPet:
|
||||
type: object
|
||||
required:
|
||||
- name
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
tag:
|
||||
type: string
|
||||
|
||||
Error:
|
||||
type: object
|
||||
required:
|
||||
- code
|
||||
- message
|
||||
properties:
|
||||
code:
|
||||
type: integer
|
||||
format: int32
|
||||
message:
|
||||
type: string
|
||||
openapi: "3.0.0"
|
||||
info:
|
||||
version: 1.0.0
|
||||
title: Swagger Petstore
|
||||
description: A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification
|
||||
termsOfService: http://swagger.io/terms/
|
||||
contact:
|
||||
name: Swagger API Team
|
||||
email: apiteam@swagger.io
|
||||
url: http://swagger.io
|
||||
license:
|
||||
name: Apache 2.0
|
||||
url: https://www.apache.org/licenses/LICENSE-2.0.html
|
||||
servers:
|
||||
- url: http://petstore.swagger.io/api
|
||||
paths:
|
||||
/pets:
|
||||
get:
|
||||
tags: []
|
||||
description: |
|
||||
Returns all pets from the system that the user has access to
|
||||
Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
|
||||
|
||||
Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
|
||||
operationId: findPets
|
||||
parameters:
|
||||
- name: tags
|
||||
in: query
|
||||
description: tags to filter by
|
||||
required: false
|
||||
style: form
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
- name: limit
|
||||
in: query
|
||||
description: maximum number of results to return
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
format: int32
|
||||
responses:
|
||||
'200':
|
||||
description: pet response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
default:
|
||||
description: unexpected error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
post:
|
||||
tags: []
|
||||
description: Creates a new pet in the store. Duplicates are allowed
|
||||
operationId: addPet
|
||||
requestBody:
|
||||
description: Pet to add to the store
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/NewPet'
|
||||
responses:
|
||||
'200':
|
||||
description: pet response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
default:
|
||||
description: unexpected error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
/pets/{id}:
|
||||
get:
|
||||
tags: []
|
||||
description: Returns a user based on a single ID, if the user does not have access to the pet
|
||||
operationId: getPetById
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: ID of pet to fetch
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
responses:
|
||||
'200':
|
||||
description: pet response
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
default:
|
||||
description: unexpected error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
delete:
|
||||
tags: []
|
||||
description: deletes a single pet based on the ID supplied
|
||||
operationId: deletePet
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: ID of pet to delete
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
responses:
|
||||
'204':
|
||||
description: pet deleted
|
||||
default:
|
||||
description: unexpected error
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
components:
|
||||
schemas:
|
||||
Pet:
|
||||
allOf:
|
||||
- $ref: '#/components/schemas/NewPet'
|
||||
- type: object
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
|
||||
NewPet:
|
||||
type: object
|
||||
required:
|
||||
- name
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
tag:
|
||||
type: string
|
||||
|
||||
Error:
|
||||
type: object
|
||||
required:
|
||||
- code
|
||||
- message
|
||||
properties:
|
||||
code:
|
||||
type: integer
|
||||
format: int32
|
||||
message:
|
||||
type: string
|
||||
tags:
|
||||
- name: test
|
||||
Reference in New Issue
Block a user