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