base.product-base.yml Maven / Gradle / Ivy
The newest version!
openapi: 3.1.0
info:
title: Product Base Definitions
version: 0.0.1
description: |
This component represents the Open API interface of the accounting service.
contact:
name: JEAF Development Team
url: 'https://www.anaptecs.de/jeaf'
email: [email protected]
license:
name: Apache 2.0
url: 'https://www.apache.org/licenses/LICENSE-2.0.html'
servers:
- url: https://accounting.jeaf.de
- url: http://localhost:8080/test
paths:
# OpenAPI standard requires to define at least 1 operation. This API however seems to be a pure type definition.
# So we define NOP operation here as workaround.
/nop:
get:
operationId: noOperation
responses:
'200':
description: Nothing is the result of nop ;-)
components:
securitySchemes:
MyOAuthSecuritySchema:
type: oauth2
flows:
authorizationCode:
authorizationUrl: 'https://example.com/api/oauth/dialog'
tokenUrl: 'https://example.com/api/oauth/dialog'
refreshUrl: 'https://example.com/api/oauth/dialog'
scopes:
read:pets: Read pets data
write:pets: Modify pets
implicit:
authorizationUrl: 'https://example.com/api/oauth/dialog'
tokenUrl: 'TODO Please add required token URL'
refreshUrl: 'https://example.com/api/oauth/dialog'
scopes:
read:pets: Read pets data
write:pets: Modify pets
parameters:
# com.anaptecs.spring.base.ParentBeanParamType.code
code:
name: code
in: header
schema:
type: number
format: double
examples:
- BOOKING_ID_999
nullable: false
required: true
# com.anaptecs.spring.base.ParentBeanParamType.novaKey
novaKey:
name: novaKey
in: header
schema:
type: string
nullable: false
examples:
- 4711-0815
required: true
# com.anaptecs.spring.base.ParentBeanParamType.tkID
tkID:
name: tkID
in: header
schema:
type: string
nullable: false
required: true
responses:
# com.anaptecs.spring.base.ErrorResponse
ErrorResponse:
description: |
Generic error response type that is used in all cases.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
schemas:
# com.anaptecs.spring.base.ExtensibleEnum
ExtensibleEnum:
type: string
x-extensible-enum:
- RED
- GREEN
- BLUE
# com.anaptecs.spring.base.EnumTest
EnumTest:
type: object
additionalProperties: false
required:
- property
- enumRef
properties:
property:
$ref: '#/components/schemas/ExtensibleEnum'
enumRef:
$ref: '#/components/schemas/ExtensibleEnum'
# com.anaptecs.spring.base.BooleanCodeType
BooleanCodeType:
type: boolean
nullable: false
# com.anaptecs.spring.base.StringCodeType
StringCodeType:
type: string
nullable: false
# com.anaptecs.spring.base.ByteCodeType
ByteCodeType:
type: integer
format: int32
nullable: false
# com.anaptecs.spring.base.ShortCodeType
ShortCodeType:
type: integer
format: int32
nullable: false
# com.anaptecs.spring.base.IntegerCodeType
IntegerCodeType:
type: integer
format: int32
nullable: false
# com.anaptecs.spring.base.LongCodeType
LongCodeType:
type: integer
format: int64
nullable: false
# com.anaptecs.spring.base.FloatCodeType
FloatCodeType:
type: number
format: float
nullable: false
# com.anaptecs.spring.base.DoubleCodeType
DoubleCodeType:
type: number
format: double
nullable: false
# com.anaptecs.spring.base.AbstractWithCustomImpl
AbstractWithCustomImpl:
type: object
additionalProperties: false
required:
- justAProperty
properties:
justAProperty:
type: integer
format: int32
nullable: false
# com.anaptecs.spring.base.BidirectA
BidirectA:
type: object
additionalProperties: false
required:
- parent
properties:
parent:
$ref: '#/components/schemas/BidirectA'
# com.anaptecs.spring.base.BidirectB
BidirectB:
type: object
additionalProperties: false
required:
- a
properties:
a:
$ref: '#/components/schemas/BidirectA'
# com.anaptecs.spring.base.Booking
Booking:
type: object
additionalProperties: false
required:
- bookingID
- customerName
properties:
bookingID:
type: string
nullable: false
customerName:
type: string
nullable: false
inventories:
type: array
items:
$ref: '#/components/schemas/InventoryType'
# com.anaptecs.spring.base.CHStopPlace
CHStopPlace:
allOf:
- $ref: '#/components/schemas/StopPlaceRef'
- type: object
additionalProperties: false
# com.anaptecs.spring.base.Channel
Channel:
type: object
additionalProperties: false
required:
- channelType
- channelCode
- code
- selfServiceChannel
properties:
channelType:
$ref: '#/components/schemas/ChannelType'
channelCode:
description: |
The business code of the channel
type: string
default: 'WEBSHOP'
examples:
- MOBILE_APP
nullable: false
code:
type: integer
format: int32
nullable: false
selfServiceChannel:
type: boolean
deprecated: true
nullable: false
default: true
# com.anaptecs.spring.base.ChannelType
ChannelType:
description: |
Valid Values:
- COUNTER
- CALL_CENTER
- MOBILE
- TVM
- WEB
- @Deprecated LEGACY_POS
type: string
enum:
- COUNTER
- CALL_CENTER
- MOBILE
- TVM
- WEB
- LEGACY_POS
default: MOBILE
# com.anaptecs.spring.base.CharacterCodeType
CharacterCodeType:
type: string
nullable: false
# com.anaptecs.spring.base.ChildA
ChildA:
description: |
single line class comment
allOf:
- $ref: '#/components/schemas/ParentClass'
- type: object
additionalProperties: false
required:
- childAAttribute
properties:
childAAttribute:
type: integer
format: int32
nullable: false
# com.anaptecs.spring.base.ChildAA
ChildAA:
deprecated: true
allOf:
- $ref: '#/components/schemas/ChildA'
- type: object
additionalProperties: false
required:
- childAAAttribute
- requiredArray
properties:
childAAAttribute:
description: |
Multi
line
docs
type: integer
format: int32
nullable: false
sizedArray:
type: array
items:
type:
- integer
- "null"
format: int32
minItems: 10
maxItems: 100
requiredArray:
type: array
items:
type:
- string
minItems: 1
# com.anaptecs.spring.base.ChildB
ChildB:
description: |
Multi
line
class
comment
allOf:
- $ref: '#/components/schemas/ParentClass'
- type: object
additionalProperties: false
properties:
childBAttribute:
description: |
A child attribute
type: array
items:
type:
- boolean
- "null"
minItems: 11
maxItems: 42
composition:
description: |
the composition
type: array
items:
$ref: '#/components/schemas/ParentClass'
# com.anaptecs.spring.base.ChildBB
ChildBB:
allOf:
- $ref: '#/components/schemas/ChildB'
- type: object
additionalProperties: false
required:
- childBBAttribute
- deprecatedAttribute
properties:
childBBAttribute:
type: integer
format: int64
nullable: false
deprecatedAttribute:
type: integer
format: int32
deprecated: true
nullable: false
deprecatedBs:
deprecated: true
type: array
items:
$ref: '#/components/schemas/ChildB'
deprecatedParent:
# Property "deprecatedParent" is marked as deprecated. However OpenAPI does not support to mark references to complex types as deprecated.
$ref: '#/components/schemas/ParentClass'
deprecatedArray:
type: string
format: byte
maxLength: 4711
# com.anaptecs.spring.base.CodeTypeUsageTest
CodeTypeUsageTest:
type: object
additionalProperties: false
required:
- booleanCode
- shortCodeTypeAssociation
- stringCode
properties:
booleanCode:
$ref: '#/components/schemas/BooleanCodeType'
booleanCodeAssociation:
type: array
items:
$ref: '#/components/schemas/BooleanCodeType'
shortCodeTypeAssociation:
type: array
items:
$ref: '#/components/schemas/ShortCodeType'
minItems: 1
stringCode:
$ref: '#/components/schemas/StringCodeType'
characterCode:
description: |
Just a character
type: string
# com.anaptecs.spring.base.Company
Company:
allOf:
- $ref: '#/components/schemas/Partner'
- type: object
additionalProperties: false
required:
- name
properties:
name:
type: string
nullable: false
# com.anaptecs.spring.base.ComplexBookingType
ComplexBookingType:
type: string
x-extensible-enum:
- COMPLEX
- VERY_COMPLEX
# com.anaptecs.spring.base.DataUnit
DataUnit:
type: string
x-extensible-enum:
- COUPON
# com.anaptecs.spring.base.DateObject
DateObject:
type: object
additionalProperties: false
required:
- localTime
- localDate
- localDateTime
- calendar
- sqlDate
- utilDate
properties:
localTime:
type: string
format: time
nullable: false
examples:
- 12:07
localDate:
type: string
format: date
nullable: false
localDateTime:
type: string
format: date-time
nullable: false
calendar:
type: string
format: date-time
nullable: false
sqlDate:
type: string
format: date
nullable: false
utilDate:
type: string
format: date-time
nullable: false
# com.anaptecs.spring.base.DeprecatedEnum
DeprecatedEnum:
type: string
deprecated: true
enum:
- ONE
- TWO
- THREE
# com.anaptecs.spring.base.DirectedEdge
DirectedEdge:
type: object
additionalProperties: false
required:
- end
- previousName
properties:
start:
$ref: '#/components/schemas/Stop'
end:
$ref: '#/components/schemas/Stop'
previousName:
description: |
Java Property Name: 'link'
type: string
nullable: false
# com.anaptecs.spring.base.Duration
Duration:
type: object
additionalProperties: false
description: |
Type represents a duration.
NOVA 14 Mapping
* nova-base.xsd.Dauer
required:
- value
- timeUnit
properties:
value:
type: integer
format: int32
nullable: false
timeUnit:
$ref: '#/components/schemas/TimeUnit'
# com.anaptecs.spring.base.DynamicEnum
DynamicEnum:
type: string
enum:
- STATIC_LITERAL
# com.anaptecs.spring.base.DynamicExtensibleEnum
DynamicExtensibleEnum:
type: string
x-extensible-enum:
- STATIC_LITERAL
# com.anaptecs.spring.base.Entity
Entity:
type: string
x-extensible-enum:
- DISCOUNT_CAMPAIGN
- DISCOUNT_OFFER
# com.anaptecs.spring.base.GeoPosition
GeoPosition:
allOf:
- $ref: '#/components/schemas/PlaceRef'
- type: object
additionalProperties: false
required:
- longitude
- latitude
properties:
longitude:
type: integer
format: int32
nullable: false
latitude:
type: integer
format: int32
nullable: false
# com.anaptecs.spring.base.InventoryType
InventoryType:
type: string
enum:
- SBB
- SNCF
- DB
# com.anaptecs.spring.base.Leg
Leg:
type: object
additionalProperties: false
required:
- start
- stop
properties:
start:
$ref: '#/components/schemas/PlaceRef'
stop:
$ref: '#/components/schemas/PlaceRef'
stopovers:
type: array
items:
$ref: '#/components/schemas/PlaceRef'
# com.anaptecs.spring.base.LinkObject
LinkObject:
type: object
additionalProperties: false
required:
- href
properties:
href:
type: string
nullable: false
# com.anaptecs.spring.base.MoneyAmount
MoneyAmount:
type: object
additionalProperties: false
description: |
Type represents an amount of money.
NOVA 14 Mapping
* nova-base.xsd.GeldBetrag
required:
- amount
- currencyCode
properties:
amount:
description: |
The amount of money. Attribute is always set.
type: number
format: double
nullable: false
currencyCode:
description: |
ISO 4217 currency code.
type: string
default: 'CHF'
minLength: 3
maxLength: 3
examples:
- CHF
nullable: false
# com.anaptecs.spring.base.MyType
MyType:
type: string
enum:
- FOO
- BAR
- FOO-BAR
- UIC_STOP_PLACE
- GEO_POSITION
- SWIIS_GEO_POSITION
# com.anaptecs.spring.base.NoSubTypesChild
NoSubTypesChild:
allOf:
- $ref: '#/components/schemas/NoSubTypesParent'
- type: object
additionalProperties: false
required:
- myProperty
properties:
myProperty:
description: |
Hello World!
:koala:
| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |
Let's have an additional discussion about how much sense it makes to add :koala: to your documentation.
So far I think it is at least funny.
type: string
nullable: false
# com.anaptecs.spring.base.NoSubTypesParent
NoSubTypesParent:
type: object
additionalProperties: false
description: |
Hello World!
:koala:
| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |
discriminator:
propertyName: objectType
required:
- objectType
properties:
objectType:
description: Attribute is used as discriminator for inheritance between data types.
type: string
# com.anaptecs.spring.base.OpenAPITestObject
OpenAPITestObject:
type: object
additionalProperties: false
required:
- readOnlyAttribute
- readWriteAttribute
- writeOnlyAttribute
- nullableAttribute
- notNullableAttribute
- readOnlyArray
- readWriteArray
- writeOnlyArray
- nullableArray
- notNullableArray
properties:
readOnlyAttribute:
type: string
readWriteAttribute:
type: string
writeOnlyAttribute:
type: integer
format: int32
writeOnly: true
nullableAttribute:
type: boolean
notNullableAttribute:
type: number
format: double
nullable: false
readOnlyArray:
type: string
readWriteArray:
type: string
writeOnlyArray:
type: integer
format: int32
writeOnly: true
nullableArray:
type: number
format: double
notNullableArray:
type: number
format: double
nullable: false
# com.anaptecs.spring.base.POI
POI:
allOf:
- $ref: '#/components/schemas/Stop'
- type: object
additionalProperties: false
required:
- description
properties:
description:
type: string
nullable: false
# com.anaptecs.spring.base.ParentClass
ParentClass:
type: object
additionalProperties: false
discriminator:
propertyName: objectType
required:
- objectType
- parentAttribute
properties:
objectType:
description: Attribute is used as discriminator for inheritance between data types.
type: string
parentAttribute:
type: string
nullable: false
# com.anaptecs.spring.base.Partner
Partner:
type: object
additionalProperties: false
discriminator:
propertyName: objectType
required:
- objectType
properties:
objectType:
description: Attribute is used as discriminator for inheritance between data types.
type: string
postalAddresses:
type: array
items:
$ref: '#/components/schemas/PostalAddress'
# com.anaptecs.spring.base.PartnerContainer
PartnerContainer:
type: object
additionalProperties: false
properties:
partners:
type: array
items:
$ref: '#/components/schemas/Partner'
# com.anaptecs.spring.base.Person
Person:
allOf:
- $ref: '#/components/schemas/Partner'
- type: object
additionalProperties: false
required:
- surname
- firstName
properties:
surname:
type: string
nullable: false
firstName:
type: string
nullable: false
# com.anaptecs.spring.base.PlaceRef
PlaceRef:
type: object
additionalProperties: false
discriminator:
propertyName: type
mapping:
PlaceRef: '#/components/schemas/PlaceRef'
FOO: '#/components/schemas/CHStopPlace'
GeoPosition: '#/components/schemas/GeoPosition'
SwissGeoPosition: '#/components/schemas/SwissGeoPosition'
FOO-BAR: '#/components/schemas/TopoRef'
UICStopPlace: '#/components/schemas/UICStopPlace'
required:
- name
- type
properties:
name:
type: string
nullable: false
type:
$ref: '#/components/schemas/MyType'
# com.anaptecs.spring.base.PostalAddress
PostalAddress:
type: object
additionalProperties: false
required:
- street
- houseNumber
- city
- postalCode
- country
properties:
street:
type: string
nullable: false
houseNumber:
type: string
nullable: false
city:
type: string
nullable: false
postalCode:
type: integer
format: int32
nullable: false
country:
type: string
nullable: false
default: Germany
# com.anaptecs.spring.base.PrimitiveArraysObject
PrimitiveArraysObject:
type: object
additionalProperties: false
required:
- cStringArray
properties:
aBooleanArray:
type: array
items:
type:
- boolean
- "null"
bBooleanArray:
type: array
items:
type:
- boolean
- "null"
cBooleanArray:
type: array
items:
type:
- boolean
- "null"
aByteArray:
type: string
format: byte
bByteArray:
type: string
format: byte
aShortArray:
type: array
items:
type:
- integer
- "null"
format: int32
bShortArray:
type: array
items:
type:
- integer
- "null"
format: int32
aIntegerArray:
type: array
items:
type:
- integer
- "null"
format: int32
bIntegerArray:
type: array
items:
type:
- integer
- "null"
format: int32
cIntegerArray:
type: array
items:
type:
- integer
- "null"
format: int32
aLongArray:
type: array
items:
type:
- integer
- "null"
format: int64
bLongArray:
type: array
items:
type:
- integer
- "null"
format: int64
aBigIntegerArray:
type: array
items:
type:
- integer
- "null"
format: int64
aCharacterArray:
type: array
items:
type:
- string
- "null"
bCharacterArray:
type: array
items:
type:
- string
- "null"
aFloatArray:
type: array
items:
type:
- number
- "null"
format: float
bFloatArray:
type: array
items:
type:
- number
- "null"
format: float
aDoubleArray:
type: array
items:
type:
- number
- "null"
format: double
bDoubleArray:
type: array
items:
type:
- number
- "null"
format: double
aBigDecimalArray:
type: array
items:
type:
- number
- "null"
format: double
aStringArray:
type: array
items:
type:
- string
- "null"
bStringArray:
type: array
items:
type:
- string
- "null"
cStringArray:
type: array
items:
type:
- string
minItems: 1
# com.anaptecs.spring.base.PrimitiveArraysObjectWithRestrictions
PrimitiveArraysObjectWithRestrictions:
type: object
additionalProperties: false
required:
- aLongArray
properties:
aBooleanArray:
type: array
items:
type:
- boolean
- "null"
bBooleanArray:
type: array
items:
type:
- boolean
- "null"
cBooleanArray:
type: array
items:
type:
- boolean
- "null"
aByteArray:
type: string
format: byte
maxLength: 32768
bByteArray:
type: string
format: byte
aShortArray:
type: array
items:
type:
- integer
- "null"
format: int32
bShortArray:
type: array
items:
type:
- integer
- "null"
format: int32
aIntegerArray:
type: array
items:
type:
- integer
- "null"
format: int32
bIntegerArray:
type: array
items:
type:
- integer
- "null"
format: int32
cIntegerArray:
type: array
items:
type:
- integer
- "null"
format: int32
aLongArray:
type: array
items:
type:
- integer
- "null"
format: int64
minItems: 1
bLongArray:
type: array
items:
type:
- integer
- "null"
format: int64
aBigIntegerArray:
type: array
items:
type:
- integer
- "null"
format: int64
aCharacterArray:
type: array
items:
type:
- string
- "null"
bCharacterArray:
type: array
items:
type:
- string
- "null"
aFloatArray:
type: array
items:
type:
- number
- "null"
format: float
bFloatArray:
type: array
items:
type:
- number
- "null"
format: float
aDoubleArray:
type: array
items:
type:
- number
- "null"
format: double
minItems: 4
maxItems: 12
bDoubleArray:
type: array
items:
type:
- number
- "null"
format: double
aBigDecimalArray:
type: array
items:
type:
- number
- "null"
format: double
aStringArray:
type: array
items:
type:
- string
- "null"
bStringArray:
type: array
items:
type:
- string
- "null"
# com.anaptecs.spring.base.PrimitiveObject
PrimitiveObject:
type: object
additionalProperties: false
required:
- aBoolean
- bBoolean
- cBoolean
- aByte
- bByte
- aShort
- bShort
- aInteger
- bInteger
- cInteger
- aLong
- bLong
- aBigInteger
- aCharacter
- bCharacter
- aFloat
- bFloat
- aDouble
- bDouble
- aBigDecimal
- aString
- bString
properties:
aBoolean:
type: boolean
nullable: false
bBoolean:
type: boolean
nullable: false
cBoolean:
type: boolean
nullable: false
aByte:
type: integer
format: int32
nullable: false
bByte:
type: integer
format: int32
nullable: false
aShort:
type: integer
format: int32
nullable: false
bShort:
type: integer
format: int32
nullable: false
aInteger:
type: integer
format: int32
nullable: false
bInteger:
type: integer
format: int32
nullable: false
cInteger:
type: integer
format: int32
nullable: false
aLong:
type: integer
format: int64
nullable: false
bLong:
type: integer
format: int64
nullable: false
aBigInteger:
type: integer
format: int64
nullable: false
aCharacter:
type: string
nullable: false
bCharacter:
type: string
nullable: false
aFloat:
type: number
format: float
nullable: false
bFloat:
type: number
format: float
nullable: false
aDouble:
type: number
format: double
nullable: false
bDouble:
type: number
format: double
nullable: false
aBigDecimal:
type: number
format: double
nullable: false
aString:
type: string
nullable: false
bString:
type: string
nullable: false
# com.anaptecs.spring.base.PrimitiveObjectWithRestrictions
PrimitiveObjectWithRestrictions:
type: object
additionalProperties: false
required:
- aBoolean
- bBoolean
- cBoolean
- aByte
- bByte
- aShort
- bShort
- aInteger
- bInteger
- cInteger
- aLong
- bLong
- aBigInteger
- aCharacter
- bCharacter
- aFloat
- bFloat
- aDouble
- bDouble
- aBigDecimal
- aString
- bString
properties:
aBoolean:
type: boolean
nullable: false
default: true
bBoolean:
type: boolean
nullable: false
cBoolean:
type: boolean
nullable: false
aByte:
type: integer
format: int32
exclusiveMaximum: 0
nullable: false
bByte:
type: integer
format: int32
maximum: 0
nullable: false
aShort:
type: integer
format: int32
minimum: -237
nullable: false
bShort:
type: integer
format: int32
exclusiveMinimum: 0
nullable: false
aInteger:
type: integer
format: int32
minimum: 0
nullable: false
bInteger:
type: integer
format: int32
minimum: 4711
nullable: false
cInteger:
type: integer
format: int32
minimum: 100
maximum: 1000
nullable: false
aLong:
type: integer
format: int64
nullable: false
bLong:
type: integer
format: int64
exclusiveMaximum: 299792458
nullable: false
aBigInteger:
type: integer
format: int64
maximum: 3.14159265359
minimum: -3.14159265359
nullable: false
aCharacter:
type: string
nullable: false
bCharacter:
type: string
nullable: false
aFloat:
type: number
format: float
nullable: false
bFloat:
type: number
format: float
nullable: false
aDouble:
type: number
format: double
nullable: false
default: 42.0
bDouble:
type: number
format: double
nullable: false
aBigDecimal:
type: number
format: double
minimum: 4711.0815
nullable: false
aString:
type: string
minLength: 8
maxLength: 32
nullable: false
default: 'Hello OpenAPI'
bString:
type: string
minLength: 1
maxLength: 128
nullable: false
# com.anaptecs.spring.base.Problem
Problem:
type: object
additionalProperties: false
required:
- title
- status
- type
- detail
- instance
properties:
title:
type: string
nullable: false
status:
type: integer
format: int32
nullable: false
type:
type: string
nullable: false
detail:
type: string
nullable: false
instance:
type: string
nullable: false
# com.anaptecs.spring.base.Product
Product:
type: object
additionalProperties: false
description: |
Data type represents a product definition
required:
- name
- link
- productID
- supportedCurrencies
- productCodes
- description
- uri
properties:
resellers:
type: array
items:
$ref: '#/components/schemas/Reseller'
name:
type: string
minLength: 12
nullable: false
image:
description: |
Image describing the product.
type: string
format: byte
minLength: 1024
maxLength: 32768
link:
type: string
nullable: false
examples:
- https://www.company.com/products/1345-345
productID:
type: string
nullable: false
supportedCurrencies:
description: |
ISO 4217 currency code.
type: array
items:
type: string
default: 'CHF'
minLength: 3
maxLength: 3
examples:
- CHF
minItems: 7
maxItems: 42
nullable: false
productCodes:
type: array
items:
$ref: '#/components/schemas/ProductCode'
minItems: 1
description:
type: string
deprecated: true
nullable: false
examples:
- 1st line 1st comment
2nd line 1st comment
- 1st line 2nd comment
2nd line 2nd comment
uri:
type: string
format: uri
nullable: false
default: 'https://products.anaptecs.de/123456789'
# com.anaptecs.spring.base.ProductCode
ProductCode:
type: integer
format: int32
exclusiveMinimum: 0
nullable: false
# com.anaptecs.spring.base.Reseller
Reseller:
type: object
additionalProperties: false
required:
- channels
- name
- language
properties:
channels:
type: array
items:
$ref: '#/components/schemas/Channel'
minItems: 1
name:
type: string
minLength: 1
maxLength: 32
nullable: false
language:
type: string
nullable: false
# com.anaptecs.spring.base.backward.SimpleAssociationBackwardCompatibility
SimpleAssociationBackwardCompatibility:
type: object
additionalProperties: false
properties:
deprecatedLinks:
description: |
Deprecated: Wrong type. Switch to `newLink` instead. (since: 2.0, removed with: 3.0)
deprecated: true
type: array
items:
$ref: '#/components/schemas/SimpleBackwardCompatibility'
newLinks:
type: array
items:
$ref: '#/components/schemas/SimpleBackwardCompatibility'
oldSingleLink:
# Property "oldSingleLink" is marked as deprecated. However OpenAPI does not support to mark references to complex types as deprecated.
$ref: '#/components/schemas/SimpleBackwardCompatibility'
newSingleLink:
$ref: '#/components/schemas/SimpleBackwardCompatibility'
# com.anaptecs.spring.base.backward.SimpleBackwardCompatibility
SimpleBackwardCompatibility:
type: object
additionalProperties: false
required:
- deprecatedProperty
- successorProperty
properties:
deprecatedProperty:
description: |
a comment
type: string
deprecated: true
nullable: false
successorProperty:
type: string
nullable: false
# com.anaptecs.spring.base.Sortiment
Sortiment:
type: object
additionalProperties: false
properties:
products:
type: array
items:
$ref: '#/components/schemas/Product'
# com.anaptecs.spring.base.Stop
Stop:
type: object
additionalProperties: false
discriminator:
propertyName: objectType
required:
- objectType
- name
properties:
objectType:
description: Attribute is used as discriminator for inheritance between data types.
type: string
name:
type: string
nullable: false
_links:
description: |
Java Property Name: 'links'
type: array
items:
$ref: '#/components/schemas/LinkObject'
# com.anaptecs.spring.base.StopPlaceRef
StopPlaceRef:
allOf:
- $ref: '#/components/schemas/PlaceRef'
- type: object
additionalProperties: false
# com.anaptecs.spring.base.SwissGeoPosition
SwissGeoPosition:
allOf:
- $ref: '#/components/schemas/GeoPosition'
- type: object
additionalProperties: false
# com.anaptecs.spring.base.TimeUnit
TimeUnit:
description: |
Enumeration represents time units.
NOVA 14 Mapping
* nova-base.xsd.ZeitEinheit
Valid Values:
- MINUTE: Literal represents time unit "minutes".
- HOUR
- DAY
- WEEK: Literal represents time unit "weeks".
This is the comments second line ;-)
- MONTH
- YEAR
type: string
enum:
- MINUTE
- HOUR
- DAY
- WEEK
- MONTH
- YEAR
# com.anaptecs.spring.base.TopoRef
TopoRef:
allOf:
- $ref: '#/components/schemas/PlaceRef'
- type: object
additionalProperties: false
# com.anaptecs.spring.base.UICStop
UICStop:
allOf:
- $ref: '#/components/schemas/Stop'
- type: object
additionalProperties: false
required:
- uicCode
properties:
uicCode:
type: string
nullable: false
# com.anaptecs.spring.base.UICStopPlace
UICStopPlace:
allOf:
- $ref: '#/components/schemas/StopPlaceRef'
- type: object
additionalProperties: false
# com.anaptecs.spring.base.WeirdBooking
WeirdBooking:
type: object
additionalProperties: false
required:
- booking
properties:
booking:
type: string
nullable: false
additionalBookings:
type: array
items:
type: string