Added required fields in schema definition for GET products list and details response

This commit is contained in:
Max Martens 2024-10-03 17:12:42 +02:00
parent 8685fddd69
commit 3281ac004a

View File

@ -1878,6 +1878,10 @@ components:
schemas:
TaxMetadataResponse:
type: object
required:
- taxMetadataId
- taxCode
- taxPercentageAmount
properties:
taxMetadataId:
type: string
@ -1894,6 +1898,8 @@ components:
example: BTW VERKOOP LAAG 9%
ProductTranslationResponse:
type: object
required:
- language
properties:
language:
type: string
@ -1908,6 +1914,14 @@ components:
pilot!
SellingPriceResponse:
type: object
required:
- sellingPriceId
- amountExclTax
- taxMetadata
- amountInclTax
- fromInclusive
- toInclusive
- internalPrice
properties:
sellingPriceId:
type: integer
@ -1933,6 +1947,13 @@ components:
example: 908.1234
PurchasePriceResponse:
type: object
required:
- purchasePriceId
- amountExclTax
- taxMetadata
- amountInclTax
- fromInclusive
- toInclusive
properties:
purchasePriceId:
type: integer
@ -1955,6 +1976,11 @@ components:
example: '2022-06-01T00:00:00.000+00:00'
SalesTouchpointResponse:
type: object
required:
- salesTouchpointId
- name
- isActive
- retailer
properties:
salesTouchpointId:
type: integer
@ -1967,6 +1993,9 @@ components:
example: true
retailer:
type: object
required:
- retailerId
- name
properties:
retailerId:
type: integer
@ -2007,11 +2036,15 @@ components:
example: https://htm.azure.net/abt/retailers/htm.svg
ProductPayloadListResponse:
type: object
required:
- Entries
properties:
Entries:
type: array
items:
type: object
required:
- productId
properties:
productId:
type: integer
@ -2058,6 +2091,13 @@ components:
example: https://api.htm.nl/products?page=2
ProductPayloadResponse:
type: object
required:
- productId
- productOwner
- isRenewable
- isSellableAtHtm
- needsSolvencyCheckConsumer
- needsSolvencyCheckBusiness
properties:
productId:
type: integer
@ -2076,6 +2116,17 @@ components:
example: 1234AB
productGroupMetadata:
type: object
required:
- productGroupMetadataId
- productGroupCode
- department
- costCenter
- costType
- description
- documentCode
- user
- timestampUpdated
- validFrom
properties:
productGroupMetadataId:
type: string
@ -2122,6 +2173,10 @@ components:
example: Reis met 90% korting gedurende de eerste F&F pilot!
validityPeriod:
type: object
required:
- validityPeriodId
- fromInclusive
- toInclusive
properties:
validityPeriodId:
type: integer
@ -2140,6 +2195,9 @@ components:
$ref: '#/components/schemas/ProductTranslationResponse'
productOwner:
type: object
required:
- productOwnerId
- name
properties:
productOwnerId:
type: integer
@ -2154,6 +2212,9 @@ components:
type: array
items:
type: object
required:
- marketSegmentId
- name
properties:
marketSegmentId:
type: integer
@ -2165,6 +2226,9 @@ components:
type: array
items:
type: object
required:
- customerSegmentId
- name
properties:
customerSegmentId:
type: integer
@ -2174,6 +2238,10 @@ components:
example: Kind (4-11)
productCategory:
type: object
required:
- productCategoryId
- name
- isTravelProduct
properties:
productCategoryId:
type: integer
@ -2186,6 +2254,9 @@ components:
example: true
requiredCustomerLevel:
type: object
required:
- requiredCustomerLevelId
- name
properties:
requiredCustomerLevelId:
type: integer
@ -2197,6 +2268,9 @@ components:
type: array
items:
type: object
required:
- requiredProductId
- productName
properties:
requiredProductId:
type: integer
@ -2212,6 +2286,9 @@ components:
type: array
items:
type: object
required:
- incompatibleProductId
- productName
properties:
incompatibleProductId:
type: integer
@ -2229,6 +2306,9 @@ components:
type: array
items:
type: object
required:
- mandatoryCustomerDataItemId
- customerDataItem
properties:
mandatoryCustomerDataItemId:
type: integer
@ -2244,6 +2324,9 @@ components:
the selected gboPackageTemplateId (if any)
items:
type: object
required:
- requiredGboPersonalAttributeId
- name
properties:
requiredGboPersonalAttributeId:
type: integer
@ -2255,6 +2338,9 @@ components:
type: array
items:
type: object
required:
- tokenTypeId
- name
properties:
tokenTypeId:
type: integer
@ -2264,6 +2350,9 @@ components:
example: EMV
paymentMoment:
type: object
required:
- paymentMomentId
- name
properties:
paymentMomentId:
type: integer
@ -2275,6 +2364,9 @@ components:
type: array
items:
type: object
required:
- serviceOptionId
- action
properties:
serviceOptionId:
type: integer
@ -2287,9 +2379,11 @@ components:
example: Per termijn vooruit opzegbaar
validityDuration:
type: string
format: duration
example: P1M
maxStartInFutureDuration:
type: string
format: duration
example: P6W
isRenewable:
type: boolean
@ -2322,6 +2416,11 @@ components:
type: array
items:
type: object
required:
- sellingPeriodId
- fromInclusive
- toInclusive
- salesTouchpoint
properties:
sellingPeriodId:
type: integer
@ -2340,6 +2439,9 @@ components:
type: array
items:
type: object
required:
- forbiddenPaymentMethodId
- name
properties:
forbiddenPaymentMethodId:
type: integer
@ -2362,6 +2464,11 @@ components:
type: array
items:
type: object
required:
- auditTrailId
- action
- user
- timestamp
properties:
auditTrailId:
type: integer