OVPAY-1518 - Processed review remarks from data architect.
This commit is contained in:
parent
8b41cbd7c8
commit
36a2ccb03c
@ -581,17 +581,17 @@ paths:
|
||||
example: Dagkaart
|
||||
description: The description of the booking.
|
||||
- in: query
|
||||
name: element1
|
||||
name: department
|
||||
schema:
|
||||
type: string
|
||||
example: 900
|
||||
description: The first element of the booking.
|
||||
description: The department of the booking.
|
||||
- in: query
|
||||
name: element2
|
||||
name: costType
|
||||
schema:
|
||||
type: string
|
||||
example: 84956
|
||||
description: The second element of the booking.
|
||||
description: The cost type of the booking.
|
||||
- in: query
|
||||
name: documentCode
|
||||
schema:
|
||||
@ -799,11 +799,11 @@ paths:
|
||||
example: Dakaart - BUS
|
||||
description: The name of the booking line metadata.
|
||||
- in: query
|
||||
name: incomingName
|
||||
name: sourceMetadataId
|
||||
schema:
|
||||
type: string
|
||||
example: Webshop
|
||||
description: The incoming name of the booking line metadata.
|
||||
example: 9b371ab4-2c47-4aa5-bcf8-6642385278ac
|
||||
description: The source of the booking line metadata.
|
||||
- in: query
|
||||
name: identifyingFieldValue
|
||||
schema:
|
||||
@ -811,12 +811,12 @@ paths:
|
||||
example: 1737
|
||||
description: The identifying field value.
|
||||
- in: query
|
||||
name: concessionName
|
||||
name: concessionId
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: [BUS, RAIL]
|
||||
type: integer
|
||||
example: [1, 2]
|
||||
explode: false
|
||||
description: The name of the concession.
|
||||
- in: query
|
||||
@ -838,17 +838,17 @@ paths:
|
||||
explode: false
|
||||
description: The sense of the line.
|
||||
- in: query
|
||||
name: element3
|
||||
name: costCenter
|
||||
schema:
|
||||
type: string
|
||||
example: 603031
|
||||
description: The element 3 of the booking line metadata.
|
||||
description: The cost center of the booking line metadata.
|
||||
- in: query
|
||||
name: element4
|
||||
name: artcleName
|
||||
schema:
|
||||
type: string
|
||||
example: Dagkaart
|
||||
description: The element 4 of the booking line metadata.
|
||||
description: The article name of the booking line metadata.
|
||||
- in: query
|
||||
name: extRef1
|
||||
schema:
|
||||
@ -1067,12 +1067,6 @@ paths:
|
||||
type: string
|
||||
example: api.htm.nl/v2/account/12345/msgs/abc
|
||||
description: The rejection info of the source.
|
||||
- in: query
|
||||
name: validAt
|
||||
schema:
|
||||
type: string
|
||||
example: 2024-01-01T00:00:00.000
|
||||
description: Timestamp that the metadata is valid.
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
@ -1220,12 +1214,12 @@ paths:
|
||||
example: 37a8095b-19db-498f-9349-5f37d21c5bdf
|
||||
description: The id of the concession metadata.
|
||||
- in: query
|
||||
name: name
|
||||
name: concessionId
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: [BUS, RAIL]
|
||||
type: integer
|
||||
example: [1, 2]
|
||||
explode: false
|
||||
description: The name of the concession.
|
||||
- in: query
|
||||
@ -1407,6 +1401,19 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/MetadataAuditTrailsPostResponseBody"
|
||||
/concessions:
|
||||
get:
|
||||
summary: Get all concessions.
|
||||
description: Get all concessions.
|
||||
tags:
|
||||
- References v2
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ConcessionsGetResponseBody"
|
||||
components:
|
||||
securitySchemes:
|
||||
bearerToken:
|
||||
@ -2048,10 +2055,10 @@ components:
|
||||
description:
|
||||
type: string
|
||||
example: Dagkaart
|
||||
element1:
|
||||
department:
|
||||
type: string
|
||||
example: 900
|
||||
element2:
|
||||
costType:
|
||||
type: string
|
||||
example: 84956
|
||||
documentCode:
|
||||
@ -2082,8 +2089,8 @@ components:
|
||||
- bookingMetadataId
|
||||
- bookingProcessId
|
||||
- description
|
||||
- element1
|
||||
- element2
|
||||
- department
|
||||
- costType
|
||||
- documentCode
|
||||
- hasSeparateTaxLine
|
||||
- hasLinePerIdentifyingField
|
||||
@ -2102,10 +2109,10 @@ components:
|
||||
description:
|
||||
type: string
|
||||
example: Dagkaart
|
||||
element1:
|
||||
department:
|
||||
type: string
|
||||
example: 900
|
||||
element2:
|
||||
costType:
|
||||
type: string
|
||||
example: 84956
|
||||
documentCode:
|
||||
@ -2134,8 +2141,8 @@ components:
|
||||
example: null
|
||||
required:
|
||||
- description
|
||||
- element1
|
||||
- element2
|
||||
- department
|
||||
- costType
|
||||
- documentCode
|
||||
- hasSeparateTaxLine
|
||||
- hasLinePerIdentifyingField
|
||||
@ -2158,11 +2165,11 @@ components:
|
||||
type: string
|
||||
nullable: true
|
||||
example: Dagkaart
|
||||
element1:
|
||||
department:
|
||||
type: string
|
||||
nullable: true
|
||||
example: 900
|
||||
element2:
|
||||
costType:
|
||||
type: string
|
||||
nullable: true
|
||||
example: 84956
|
||||
@ -2257,17 +2264,18 @@ components:
|
||||
name:
|
||||
type: string
|
||||
example: Dagkaart - BUS
|
||||
incomingName:
|
||||
sourceMetadataId:
|
||||
type: string
|
||||
format: uuid
|
||||
example: null
|
||||
nullable: true
|
||||
identifyingFieldValue:
|
||||
type: string
|
||||
example: null
|
||||
nullable: true
|
||||
concessionName:
|
||||
type: string
|
||||
example: RAIL
|
||||
concessionId:
|
||||
type: integer
|
||||
example: 1
|
||||
nullable: true
|
||||
lineType:
|
||||
type: string
|
||||
@ -2282,11 +2290,11 @@ components:
|
||||
- debit
|
||||
- credit
|
||||
example: credit
|
||||
element3:
|
||||
costCenter:
|
||||
type: string
|
||||
example: 603031
|
||||
nullable: true
|
||||
element4:
|
||||
articleName:
|
||||
type: string
|
||||
example: dagkaart
|
||||
nullable: true
|
||||
@ -2346,20 +2354,16 @@ components:
|
||||
name:
|
||||
type: string
|
||||
example: Dagkaart - BUS
|
||||
incomingName:
|
||||
type: string
|
||||
example: null
|
||||
nullable: true
|
||||
sourceMetadata:
|
||||
type: object
|
||||
$ref: '#/components/schemas/SourceMetadata'
|
||||
identifyingFieldValue:
|
||||
type: string
|
||||
example: null
|
||||
nullable: true
|
||||
concessionName:
|
||||
type: string
|
||||
enum:
|
||||
- RAIL
|
||||
- BUS
|
||||
example: RAIL
|
||||
concession:
|
||||
type: object
|
||||
$ref: '#/components/schemas/Concession'
|
||||
lineType:
|
||||
type: string
|
||||
enum:
|
||||
@ -2373,11 +2377,11 @@ components:
|
||||
- debit
|
||||
- credit
|
||||
example: credit
|
||||
element3:
|
||||
costCenter:
|
||||
type: string
|
||||
example: 603031
|
||||
nullable: true
|
||||
element4:
|
||||
articleName:
|
||||
type: string
|
||||
example: dagkaart
|
||||
nullable: true
|
||||
@ -2424,21 +2428,19 @@ components:
|
||||
type: string
|
||||
nullable: true
|
||||
example: Dagkaart - BUS
|
||||
incomingName:
|
||||
sourceMetadataId:
|
||||
type: string
|
||||
format: uuid
|
||||
nullable: true
|
||||
example: null
|
||||
identifyingFieldValue:
|
||||
type: string
|
||||
nullable: true
|
||||
example: null
|
||||
concessionName:
|
||||
type: string
|
||||
concessionId:
|
||||
type: integer
|
||||
nullable: true
|
||||
enum:
|
||||
- RAIL
|
||||
- BUS
|
||||
example: RAIL
|
||||
example: 1
|
||||
lineType:
|
||||
type: string
|
||||
nullable: true
|
||||
@ -2454,11 +2456,11 @@ components:
|
||||
- debit
|
||||
- credit
|
||||
example: credit
|
||||
element3:
|
||||
costCenter:
|
||||
type: string
|
||||
nullable: true
|
||||
example: 603031
|
||||
element4:
|
||||
articleName:
|
||||
type: string
|
||||
nullable: true
|
||||
example: dagkaart
|
||||
@ -2759,15 +2761,6 @@ components:
|
||||
rejectionInfo:
|
||||
type: string
|
||||
example: api.htm.nl/v2/account/12345/msgs/abc
|
||||
validFrom:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2024-01-01T00:00:00.000
|
||||
validUntil:
|
||||
type: string
|
||||
format: date-time
|
||||
nullable: true
|
||||
example: null
|
||||
required:
|
||||
- sourceMetadataId
|
||||
- incomingName
|
||||
@ -2776,7 +2769,6 @@ components:
|
||||
- businessOwner
|
||||
- rejectionProcessing
|
||||
- rejectionInfo
|
||||
- validFrom
|
||||
SourceMetadataPostResponseBody:
|
||||
type: object
|
||||
properties:
|
||||
@ -2807,15 +2799,6 @@ components:
|
||||
rejectionInfo:
|
||||
type: string
|
||||
example: api.htm.nl/v2/account/12345/msgs/abc
|
||||
validFrom:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2024-01-01T00:00:00.000
|
||||
validUntil:
|
||||
type: string
|
||||
format: date-time
|
||||
nullable: true
|
||||
example: null
|
||||
SourceMetadataPatchResponseBody:
|
||||
type: object
|
||||
properties:
|
||||
@ -2903,12 +2886,9 @@ components:
|
||||
type: string
|
||||
format: en
|
||||
example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb
|
||||
name:
|
||||
type: string
|
||||
enum:
|
||||
- RAIL
|
||||
- BUS
|
||||
example: RAIL
|
||||
concession:
|
||||
type: object
|
||||
$ref: "#/components/schemas/Concession"
|
||||
percentage:
|
||||
type: number
|
||||
example: 84.021
|
||||
@ -2934,12 +2914,9 @@ components:
|
||||
ConcessionMetadataPostRequestBody:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
enum:
|
||||
- RAIL
|
||||
- BUS
|
||||
example: RAIL
|
||||
concessionId:
|
||||
type: integer
|
||||
example: 1
|
||||
percentage:
|
||||
type: number
|
||||
example: 84.021
|
||||
@ -2953,7 +2930,7 @@ components:
|
||||
nullable: true
|
||||
example: null
|
||||
required:
|
||||
- name
|
||||
- concessionId
|
||||
- percentage
|
||||
- validFrom
|
||||
ConcessionMetadataPostResponseBody:
|
||||
@ -2968,12 +2945,9 @@ components:
|
||||
ConcessionMetadataPatchRequestBody:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
enum:
|
||||
- RAIL
|
||||
- BUS
|
||||
example: RAIL
|
||||
concessionId:
|
||||
type: integer
|
||||
example: 1
|
||||
percentage:
|
||||
type: number
|
||||
example: 84.021
|
||||
@ -2995,6 +2969,30 @@ components:
|
||||
example: e0af8c8f-d421-4567-a14e-48e2a1bb86fb
|
||||
required:
|
||||
- concessionMetadataId
|
||||
ConcessionsGetResponseBody:
|
||||
type: object
|
||||
properties:
|
||||
concessions:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Concession'
|
||||
href:
|
||||
type: string
|
||||
nullable: true
|
||||
description: URI for pagination.
|
||||
example: null
|
||||
Concession:
|
||||
type: object
|
||||
properties:
|
||||
concessionId:
|
||||
type: integer
|
||||
example: 1
|
||||
name:
|
||||
type: string
|
||||
example: BUS
|
||||
required:
|
||||
- concessionId
|
||||
- name
|
||||
SourceMetadata:
|
||||
type: object
|
||||
properties:
|
||||
@ -3020,15 +3018,6 @@ components:
|
||||
rejectionInfo:
|
||||
type: string
|
||||
example: api.htm.nl/v2/account/12345/msgs/abc
|
||||
validFrom:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2024-01-01T00:00:00.000
|
||||
validUntil:
|
||||
type: string
|
||||
format: date-time
|
||||
nullable: true
|
||||
example: null
|
||||
required:
|
||||
- sourceMetadataId
|
||||
- incomingName
|
||||
|
||||
Loading…
Reference in New Issue
Block a user