Skip to content

Instantly share code, notes, and snippets.

@RaviH
Created November 16, 2018 21:30
Show Gist options
  • Save RaviH/a8b08734c6969868fdff6fe3a30357dc to your computer and use it in GitHub Desktop.
Save RaviH/a8b08734c6969868fdff6fe3a30357dc to your computer and use it in GitHub Desktop.
swagger.yml
openapi: 3.0.1
info:
title: swagger-server
description: My API
license:
name: Apache 2.0
version: "0.1"
paths:
/lineupcacheservice/cache/clear/{type}:
delete:
operationId: clearCache
parameters:
- name: type
in: path
required: true
schema:
type: string
nullable: false
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/HttpResponse<CacheResponse>'
/lineupcacheservice/networks/hello:
get:
operationId: hello
parameters: []
responses:
default:
content:
application/json:
schema:
type: string
/lineupcacheservice/networks:
get:
description: "Returns all the networks.\n \n Sample curls:\n curl -X GET \"\
http://127.0.0.1:8080/lineupcacheservice/network/networks?twctv=fooBar\""
operationId: getNetworks
parameters:
- name: twcTv
in: query
description: TWC TV
required: true
schema:
minLength: 1
type: string
nullable: false
responses:
default:
description: Lineups for the given division code
content:
application/json:
schema:
$ref: '#/components/schemas/NetworkMappingsResponse'
/lineupcacheservice/regions:
get:
description: "Returns all the regions.\n \n Sample curls:\n curl -X GET \"http://127.0.0.1:8080/lineupcacheservice/regions\""
operationId: getRegions
parameters: []
responses:
default:
description: regions
content:
application/json:
schema:
$ref: '#/components/schemas/RegionResponse'
components:
schemas:
Charset:
type: object
properties:
registered:
type: boolean
nullable: false
Locale:
type: object
properties:
language:
type: string
nullable: false
script:
type: string
nullable: false
country:
type: string
nullable: false
variant:
type: string
nullable: false
extensionKeys:
type: array
nullable: false
items:
type: array
items:
type: string
unicodeLocaleAttributes:
type: array
nullable: false
items:
type: array
items:
type: string
unicodeLocaleKeys:
type: array
nullable: false
items:
type: array
items:
type: string
ISO3Language:
type: string
nullable: false
ISO3Country:
type: string
nullable: false
displayLanguage:
type: string
nullable: false
displayScript:
type: string
nullable: false
displayCountry:
type: string
nullable: false
displayVariant:
type: string
nullable: false
displayName:
type: string
nullable: false
BigDecimal:
type: object
MediaType:
type: object
properties:
name:
type: string
nullable: false
type:
type: string
nullable: false
subtype:
type: string
nullable: false
extension:
type: string
nullable: false
parameters:
type: array
nullable: false
items:
type: array
items:
type: string
quality:
type: string
nullable: false
qualityAsNumber:
$ref: '#/components/schemas/BigDecimal'
version:
type: string
nullable: false
charset:
$ref: '#/components/schemas/Charset'
textBased:
type: boolean
nullable: false
HttpResponse<CacheResponse>:
type: object
properties:
characterEncoding:
$ref: '#/components/schemas/Charset'
locale:
$ref: '#/components/schemas/Locale'
contentLength:
type: integer
format: int64
nullable: false
contentType:
$ref: '#/components/schemas/MediaType'
NcsNetworkMappings:
type: object
properties:
twcTv:
type: string
nullable: false
logoName:
type: string
nullable: false
product:
type: string
nullable: false
provider:
type: string
nullable: false
networkName:
type: string
nullable: false
defaultCallSign:
type: string
nullable: false
starsId:
type: string
nullable: false
twcTvNetDisplay:
type: string
nullable: false
linearStarsId:
type: string
nullable: false
assetAvailability:
type: string
nullable: false
NetworkMappingsResponse:
type: object
properties:
networkList:
type: array
nullable: false
items:
$ref: '#/components/schemas/NcsNetworkMappings'
RegionDivision:
type: object
properties:
divisionCode:
type: string
nullable: false
name:
type: string
nullable: false
RegionDivisions:
type: object
properties:
name:
type: string
nullable: false
divisions:
type: array
nullable: false
items:
$ref: '#/components/schemas/RegionDivision'
RegionResponse:
type: object
properties:
region:
type: array
nullable: false
items:
$ref: '#/components/schemas/RegionDivisions'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment