Koha/api/v1/swagger/definitions/vendor.yaml
Tomas Cohen Arazi d6c67eddd3 Bug 29620: Move the OpenAPI spec to YAML format
This patch moves all the REST API spec pieces into YAML.

To test:
1. Run:
   $ kshell
  k$ prove t/db_dependent/api/v1/*
=> SUCCESS: Tests pass
2. Apply this patch
3. Repeat 1
=> SUCCESS: Tests still pass!
4. Sign off :-D

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Fridolin Somers <fridolin.somers@biblibre.com>
2021-12-07 12:33:35 -10:00

107 lines
2 KiB
YAML

---
type: object
properties:
id:
$ref: ../x-primitives.yaml#/vendor_id
name:
type:
- string
description: Vendor name
address1:
type:
- string
- "null"
description: Vendor physical address (line 1)
address2:
type:
- string
- "null"
description: Vendor physical address (line 2)
address3:
type:
- string
- "null"
description: Vendor physical address (line 3)
address4:
type:
- string
- "null"
description: Vendor physical address (line 4)
phone:
type:
- string
- "null"
description: Vendor phone number
fax:
type:
- string
- "null"
description: Vendor fax number
accountnumber:
type:
- string
- "null"
description: Vendor account number
notes:
type:
- string
- "null"
description: Vendor notes
postal:
type:
- string
- "null"
description: Vendor postal address
url:
type:
- string
- "null"
description: Vendor web address
active:
type:
- boolean
- "null"
description: Is this vendor active
list_currency:
type:
- string
- "null"
description: List prices currency
invoice_currency:
type:
- string
- "null"
description: Invoice prices currency
gst:
type:
- boolean
- "null"
description: Is the library taxed when buying from this vendor
list_includes_gst:
type:
- boolean
- "null"
description: List prices include taxes
invoice_includes_gst:
type:
- boolean
- "null"
description: Invoice prices include taxes
tax_rate:
type:
- number
- "null"
description: Default tax rate for items ordered from this vendor
discount:
type:
- number
- "null"
description: Default discount rate for items ordered from this vendor
deliverytime:
type:
- integer
- "null"
description: Expected delivery time (in days)
additionalProperties: false
required:
- name