Skip to content
This repository was archived by the owner on Sep 16, 2024. It is now read-only.

Commit 7c4cef1

Browse files
committed
docs: Fix incorrect po match type enum
1 parent 2260b70 commit 7c4cef1

File tree

2 files changed

+17
-13
lines changed

2 files changed

+17
-13
lines changed

CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
- Add `acceptedAt` to `#/components/schemas/Payment`.
1111
- Add `acceptedAt` to `#/components/schemas/Credit`.
12+
- Fix incorrect documentation for PO Match types.
13+
- `FOUR_WAY` renamed to `four_way`
14+
- `THREE_WAY` renamed to `three_way`
15+
- `TWO_WAY` renamed to `two_way`
1216

1317
## v0.21.0
1418

vic.api.v0.yaml

+13-13
Original file line numberDiff line numberDiff line change
@@ -3186,12 +3186,12 @@ components:
31863186
- $ref: '#/components/schemas/UnitOfMeasure'
31873187
- type: 'null'
31883188
quantityAccepted:
3189-
description: The quantity accepted. Required when `matchingType` set to `FOUR_WAY`.
3189+
description: The quantity accepted. Required when `matchingType` set to `four_way`.
31903190
type: string
31913191
format: decimal
31923192
example: '1.0'
31933193
quantityReceived:
3194-
description: The quantity received. Required when `matchingType` set to `THREE_WAY` (default) or `FOUR_WAY`.
3194+
description: The quantity received. Required when `matchingType` set to `three_way` (default) or `four_way`.
31953195
type: string
31963196
format: decimal
31973197
example: '12.3'
@@ -3246,12 +3246,12 @@ components:
32463246
- $ref: '#/components/schemas/UnitOfMeasure'
32473247
- type: 'null'
32483248
quantityAccepted:
3249-
description: The quantity accepted. Required when `matchingType` set to `FOUR_WAY`.
3249+
description: The quantity accepted. Required when `matchingType` set to `four_way`.
32503250
type: string
32513251
format: decimal
32523252
example: '1.0'
32533253
quantityReceived:
3254-
description: The quantity received. Required when `matchingType` set to `THREE_WAY` (default) or `FOUR_WAY`.
3254+
description: The quantity received. Required when `matchingType` set to `three_way` (default) or `four_way`.
32553255
type: string
32563256
format: decimal
32573257
example: '12.3'
@@ -3297,12 +3297,12 @@ components:
32973297
- $ref: '#/components/schemas/UnitOfMeasure'
32983298
- type: 'null'
32993299
quantityAccepted:
3300-
description: The quantity accepted. Required when `matchingType` set to `FOUR_WAY`.
3300+
description: The quantity accepted. Required when `matchingType` set to `four_way`.
33013301
type: string
33023302
format: decimal
33033303
example: '1.0'
33043304
quantityReceived:
3305-
description: The quantity received. Required when `matchingType` set to `THREE_WAY` (default) or `FOUR_WAY`.
3305+
description: The quantity received. Required when `matchingType` set to `three_way` (default) or `four_way`.
33063306
type: string
33073307
format: decimal
33083308
example: '12.3'
@@ -3523,11 +3523,11 @@ components:
35233523
type: string
35243524
description: |
35253525
The type of matching that should be done on the line item. Determines which quantity fields are required.
3526-
`TWO_WAY` - Only the `quantityRequested` field is required.
3527-
`THREE_WAY` (default) - The `quantityRequested` and `quantityReceived` fields are required.
3528-
`FOUR_WAY` - The `quantityRequested`, `quantityReceived`, and `quantityAccepted` fields are required.
3529-
enum: [TWO_WAY, THREE_WAY, FOUR_WAY]
3530-
default: THREE_WAY
3526+
`two_way` - Only the `quantityRequested` field is required.
3527+
`three_way` (default) - The `quantityRequested` and `quantityReceived` fields are required.
3528+
`four_way` - The `quantityRequested`, `quantityReceived`, and `quantityAccepted` fields are required.
3529+
enum: [two_way, three_way, four_way]
3530+
default: three_way
35313531
PurchaseOrderLineItem:
35323532
type: object
35333533
required: [internalId]
@@ -3548,7 +3548,7 @@ components:
35483548
- $ref: '#/components/schemas/UnitOfMeasure'
35493549
- type: 'null'
35503550
quantityAccepted:
3551-
description: The quantity accepted. Required when `matchingType` set to `FOUR_WAY`.
3551+
description: The quantity accepted. Required when `matchingType` set to `four_way`.
35523552
type: string
35533553
format: decimal
35543554
example: '1.0'
@@ -3558,7 +3558,7 @@ components:
35583558
format: decimal
35593559
example: '1.0'
35603560
quantityReceived:
3561-
description: The quantity received. Required when `matchingType` set to `THREE_WAY` (default) or `FOUR_WAY`.
3561+
description: The quantity received. Required when `matchingType` set to `three_way` (default) or `four_way`.
35623562
type: string
35633563
format: decimal
35643564
example: '1.0'

0 commit comments

Comments
 (0)