From 85892d77fe59cd30a8fbaaca44ff7aa567ca5ed9 Mon Sep 17 00:00:00 2001 From: Robert Zondervan Date: Mon, 13 Jan 2020 21:46:07 +0100 Subject: [PATCH] Value update --- api/helm/values.yaml | 8 ++- api/public/schema/openapi.yaml | 102 +++++++++++++++++++++++++++--- api/public/schema/publiccode.yaml | 2 +- 3 files changed, 99 insertions(+), 13 deletions(-) diff --git a/api/helm/values.yaml b/api/helm/values.yaml index fec37783..333d0ffe 100644 --- a/api/helm/values.yaml +++ b/api/helm/values.yaml @@ -6,7 +6,7 @@ settings: registryBase: docker.io/conduction projectName: bc name: bc - title: Proto Component + title: Betaal Service version: V.0.1 description: ''Naast deze JSON rest API is er ook een [graphql](/graphql) interface beschikbaar.'' repro: 'https://github.com/ConductionNL/Proto-component-commonground' @@ -14,9 +14,11 @@ settings: domains: - conduction.nl - zaakonline.nl - - huwelijksplanner.online + - larping.eu - common-ground.dev - domainsJson: ["conduction.nl","zaakonline.nl","huwelijksplanner.online","common-ground.dev"] + - trouwplanner.online + - huwelijksplanner.online + domainsJson: ["conduction.nl","zaakonline.nl","larping.eu","common-ground.dev","trouwplanner.online","huwelijksplanner.online"] organisationName: Conduction email: info@conduction.nl country: Netherlands diff --git a/api/public/schema/openapi.yaml b/api/public/schema/openapi.yaml index 4d21f4fc..d70583fc 100644 --- a/api/public/schema/openapi.yaml +++ b/api/public/schema/openapi.yaml @@ -1,10 +1,10 @@ openapi: 3.0.2 info: - title: 'Proto Component' + title: 'Betaal Service' version: V.0.1 description: | API Details - - Component: Proto Component + - Component: Betaal Service - Reference: bc - Enviroment: dev - Version: V.0.1 @@ -2297,33 +2297,57 @@ definitions: Invoice-read: properties: id: + description: 'The UUID identifier of this object' + type: string example: e2984465-190a-4562-829e-a8cca81aa35d format: uuid name: + description: 'The name of the invoice' + type: string example: 'My Invoice' maxLength: 255 description: + description: 'The description of the invoice' + type: string example: 'This is the best invoice ever' maxLength: 255 reference: + description: 'The human readable reference for this request, build as {gemeentecode}-{year}-{referenceId}. Where gemeentecode is a four digit number for gemeenten and a four letter abriviation for other organizations' + type: string example: 6666-2019-0000000012 maxLength: 255 targetOrganization: + description: 'The RSIN of the organization that ownes this proces' + type: string example: '002851234' maxLength: 255 price: + description: 'The price of this product' + type: string example: '50.00' priceCurrency: + description: 'The currency of this product in an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format' + type: string example: EUR tax: + description: 'The total tax over the invoice' + type: string example: '21.00' createdAt: + description: 'The moment this request was created by the submitter' + type: \DateTime example: '20190101' order: + description: 'The order of this invoice' + type: string example: 'https://www.example.org/order/1' maxLength: 255 - items: [] - payments: [] + items: + description: 'The items in this invoice' + type: \ArrayCollection + payments: + description: 'The payments of this Invoice' + type: \Payment required: - name - targetOrganization @@ -2331,25 +2355,43 @@ definitions: Invoice-write: properties: name: + description: 'The name of the invoice' + type: string example: 'My Invoice' maxLength: 255 description: + description: 'The description of the invoice' + type: string example: 'This is the best invoice ever' maxLength: 255 targetOrganization: + description: 'The RSIN of the organization that ownes this proces' + type: string example: '002851234' maxLength: 255 price: + description: 'The price of this product' + type: string example: '50.00' priceCurrency: + description: 'The currency of this product in an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format' + type: string example: EUR tax: + description: 'The total tax over the invoice' + type: string example: '21.00' order: + description: 'The order of this invoice' + type: string example: 'https://www.example.org/order/1' maxLength: 255 - items: [] - payments: [] + items: + description: 'The items in this invoice' + type: \ArrayCollection + payments: + description: 'The payments of this Invoice' + type: \Payment required: - name - targetOrganization @@ -2357,29 +2399,51 @@ definitions: InvoiceItem-read: properties: id: + description: '' + type: string example: e2984465-190a-4562-829e-a8cca81aa35d format: uuid name: + description: 'The name of the object' + type: string example: 'My InvoiceItem' maxLength: 255 description: + description: 'The description of the InvoiceItem' + type: string example: 'This is the best invoice item ever' maxLength: 255 offer: + description: 'The offer this item represents' + type: string example: 'http://example.org/offers/1' format: url product: + description: 'The product this item represents. DEPRECATED: REPLACED BY OFFER' + type: string maxLength: 255 quantity: + description: 'The quantity of the items that are ordered' + type: int example: '1' price: + description: 'The price of this product' + type: string example: '50.00' priceCurrency: + description: 'The currency of this product in an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format' + type: string example: EUR taxPercentage: + description: 'The tax percentage for this offer as an integer e.g. 9% makes 9' + type: int example: '9' - createdAt: [] - invoice: [] + createdAt: + description: 'The moment this request was created by the submitter' + type: \DateTime + invoice: + description: 'The invoice that contains this item' + type: \Invoice required: - name - offer @@ -2388,25 +2452,43 @@ definitions: InvoiceItem-write: properties: name: + description: 'The name of the object' + type: string example: 'My InvoiceItem' maxLength: 255 description: + description: 'The description of the InvoiceItem' + type: string example: 'This is the best invoice item ever' maxLength: 255 offer: + description: 'The offer this item represents' + type: string example: 'http://example.org/offers/1' format: url product: + description: 'The product this item represents. DEPRECATED: REPLACED BY OFFER' + type: string maxLength: 255 quantity: + description: 'The quantity of the items that are ordered' + type: int example: '1' price: + description: 'The price of this product' + type: string example: '50.00' priceCurrency: + description: 'The currency of this product in an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format' + type: string example: EUR taxPercentage: + description: 'The tax percentage for this offer as an integer e.g. 9% makes 9' + type: int example: '9' - invoice: [] + invoice: + description: 'The invoice that contains this item' + type: \Invoice required: - name - offer @@ -2415,6 +2497,8 @@ definitions: Payment-read: properties: id: + description: '' + type: string example: e2984465-190a-4562-829e-a8cca81aa35d format: uuid paymentProvider: diff --git a/api/public/schema/publiccode.yaml b/api/public/schema/publiccode.yaml index 36c7b97e..c06ab1ed 100644 --- a/api/public/schema/publiccode.yaml +++ b/api/public/schema/publiccode.yaml @@ -6,7 +6,7 @@ url: "https://github.com/ConductionNL/Proto-component-commonground" landingURL: "pc.zaakonline.nl" isBasedOn: "https://github.com/ConductionNL/Proto-component-commonground.git" softwareVersion: "V.0.1" -releaseDate: "2020-07-01" +releaseDate: "2020-13-01" logo: pc.zaakonline.nl monochromeLogo: img/logo-mono.svg