From ee8cdfc660bd1d72c49d4cd648976bc0f547c215 Mon Sep 17 00:00:00 2001 From: Max Martens Date: Thu, 5 Dec 2024 15:23:37 +0100 Subject: [PATCH] Remove _templates, add self under _links, add some new links and attributes --- src/openapi/customers/SE-customers.yaml | 207 +++++++++++------------- 1 file changed, 90 insertions(+), 117 deletions(-) diff --git a/src/openapi/customers/SE-customers.yaml b/src/openapi/customers/SE-customers.yaml index c396c34..7238481 100644 --- a/src/openapi/customers/SE-customers.yaml +++ b/src/openapi/customers/SE-customers.yaml @@ -30,11 +30,21 @@ paths: schema: type: integer example: 1000001 + - name: customerStatusId + in: query + schema: + type: integer + example: 1 - name: debtorNumber in: query schema: type: integer example: 100001 + - name: debtorStatusId + in: query + schema: + type: integer + example: 1 - name: birthname in: query schema: @@ -221,6 +231,10 @@ paths: "orderLineId": "38B17EF-36C4-4039-B92C-4817969B464E", "contractId": "56B17EF-C436-9043-B76C-481797WEB464F", "_links": { + "self": { + "href": "https://api.integratielaag.nl/abt/serviceengine/x.x/customers/tokens/1/productinstances/1", + "method": "GET" + }, "get_order": { "href": "https://api.integratielaag.nl/abt/serviceengine/x.x/orders/501B17EF-36C4-4039-B92C-6517969B464E", "method": "GET" @@ -244,9 +258,6 @@ components: customerNumber: type: integer example: 1000001 - debtorNumber: - type: string - example: DB100001 customerStatus: type: object properties: @@ -256,6 +267,18 @@ components: name: type: string example: Active + debtorNumber: + type: string + example: DB100001 + debtorStatus: + type: object + properties: + debtorStatusId: + type: integer + example: 1 + name: + type: string + example: Active person: type: object properties: @@ -320,7 +343,16 @@ components: _links: type: object properties: - delete: + self: + type: object + properties: + href: + type: string + example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/addresses/1 + method: + type: string + example: GET + delete_address: type: object properties: href: @@ -358,7 +390,16 @@ components: _links: type: object properties: - delete: + self: + type: object + properties: + href: + type: string + example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/phones/1 + method: + type: string + example: GET + delete_phone: type: object properties: href: @@ -370,6 +411,25 @@ components: _links: type: object properties: + self: + type: object + properties: + href: + type: string + example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers + method: + type: string + example: GET + create_customer_status: + type: object + description: ONLY ALLOWED FOR SMP - Create a new customer status + properties: + href: + type: string + example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/statuses + method: + type: string + example: POST partial_edit: type: object properties: @@ -379,9 +439,6 @@ components: method: type: string example: PATCH - templated: - type: boolean - example: true get_tokens: type: object properties: @@ -391,9 +448,6 @@ components: method: type: string example: GET - templated: - type: boolean - example: true create_token: type: object properties: @@ -402,66 +456,7 @@ components: example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/tokens method: type: string - example: POST - templated: - type: boolean - example: true - _templates: - type: object - properties: - partial_edit: - type: object - properties: - method: - type: string - example: PATCH - properties: - example: - [ - { name: person, required: true, properties: [ - { name: prefix, required: false, type: string }, - { name: birthname, required: false, type: string }, - { name: surname, required: false, type: string }, - { name: suffix, required: false, type: string }, - { name: dateOfBirth, required: false, type: string }, - { name: emailAddress, required: false, type: string }, - { name: addresses, required: false, multi: true, properties: [ - { name: addressId, required: false, type: integer }, - { name: isPreferred, required: false, type: boolean }, - { name: addressTypeId, required: false, type: integer }, - { name: street, required: false, type: string }, - { name: houseNumber, required: false, type: integer }, - { name: houseNumberSuffix, required: false, type: string }, - { name: postalCode, required: false, type: string }, - { name: city, required: false, type: string }, - { name: country, required: false, type: string } - ]}, - { name: phones, required: false, multi: true, properties: [ - { name: phoneId, required: false, type: integer }, - { name: isPreferred, required: false, type: boolean }, - { name: phoneTypeId, required: false, type: integer }, - { name: number, required: false, type: string }, - { name: countryCode, required: false, type: string } - ]} - ] } - ] - create_token: - type: object - properties: - method: - type: string - example: POST - properties: - example: - [ - { name: ovPayToken, required: true, properties: [ - { name: tokenTypeId, required: true, type: integer }, - { name: alias, required: true, type: string }, - { name: serviceReferenceId, required: false, type: string }, - { name: amount, required: false, type: integer }, - ]} - ] - + example: POST OvPayTokensResponse: type: object required: @@ -506,8 +501,18 @@ components: _links: type: object properties: - partial_edit: + self: type: object + properties: + href: + type: string + example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/tokens/1 + method: + type: string + example: GET + partial_edit: + type: object + description: External touchpoints are only allowed to change alias - SMP can also change tokenStatus properties: href: type: string @@ -515,10 +520,7 @@ components: method: type: string example: PATCH - templated: - type: boolean - example: true - replace: + replace_token: type: object properties: href: @@ -527,10 +529,7 @@ components: method: type: string example: POST - templated: - type: boolean - example: true - delete: + delete_token: type: object properties: href: @@ -539,7 +538,7 @@ components: method: type: string example: DELETE - productInstances: + get_productinstances: type: object properties: href: @@ -548,7 +547,7 @@ components: method: type: string example: GET - trips: + get_trips: type: object properties: href: @@ -557,41 +556,6 @@ components: method: type: string example: GET - _templates: - type: object - properties: - partial_edit: - type: object - properties: - method: - type: string - example: PATCH - properties: - example: - [ - { name: ovPayToken, required: true, properties: [ - { name: alias, required: false, type: string } - ]} - ] - replace: - type: object - properties: - method: - type: string - example: POST - properties: - example: - [ - { name: ovPayToken, required: true, properties: [ - { name: newTokenId, required: false, type: integer }, - { name: tokenTypeId, required: false, type: integer }, - { name: alias, required: false, type: string }, - { name: serviceReferenceId, required: false, type: string }, - { name: amount, required: false, type: integer }, - ]} - ] - - OvPayTokenProductInstancesResponse: type: object properties: @@ -649,6 +613,15 @@ components: _links: type: object properties: + self: + type: object + properties: + href: + type: string + example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/tokens/1/productinstances + method: + type: string + example: GET get_order: type: object properties: