hostsharing/hs.hsadmin.ng
6
0
Fork 0
Code Pull Requests 2 Activity

upgrade io.openapiprocessor:openapi-processor-spring to 2024.2 (#42)

Browse Source 
Co-authored-by: Michael Hoennig <michael@hoennig.de>
Reviewed-on: #42
Reviewed-by: Marc Sandlus <marc.sandlus@hostsharing.net>
This commit is contained in:
Michael Hoennig 2024-04-16 10:08:00 +02:00
parent 8d8c5df0b6
commit f0eb76ee61
34 changed files with 342 additions and 342 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
build.gradle
View File

@ -115,7 +115,7 @@ tasks.named('test') {
openapiProcessor { openapiProcessor {
springRoot { springRoot {
processorName 'spring' processorName 'spring'
processor 'io.openapiprocessor:openapi-processor-spring:2022.5' processor 'io.openapiprocessor:openapi-processor-spring:2024.2'
apiPath "$projectDir/src/main/resources/api-definition.yaml" apiPath "$projectDir/src/main/resources/api-definition.yaml"
mapping "$projectDir/src/main/resources/api-mappings.yaml" mapping "$projectDir/src/main/resources/api-mappings.yaml"
targetDir "$buildDir/generated/sources/openapi-javax" targetDir "$buildDir/generated/sources/openapi-javax"
@ -124,7 +124,7 @@ openapiProcessor {
} }
springRbac { springRbac {
processorName 'spring' processorName 'spring'
processor 'io.openapiprocessor:openapi-processor-spring:2022.5' processor 'io.openapiprocessor:openapi-processor-spring:2024.2'
apiPath "$projectDir/src/main/resources/api-definition/rbac/rbac.yaml" apiPath "$projectDir/src/main/resources/api-definition/rbac/rbac.yaml"
mapping "$projectDir/src/main/resources/api-definition/rbac/api-mappings.yaml" mapping "$projectDir/src/main/resources/api-definition/rbac/api-mappings.yaml"
targetDir "$buildDir/generated/sources/openapi-javax" targetDir "$buildDir/generated/sources/openapi-javax"
@ -133,7 +133,7 @@ openapiProcessor {
} }
springTest { springTest {
processorName 'spring' processorName 'spring'
processor 'io.openapiprocessor:openapi-processor-spring:2022.5' processor 'io.openapiprocessor:openapi-processor-spring:2024.2'
apiPath "$projectDir/src/main/resources/api-definition/test/test.yaml" apiPath "$projectDir/src/main/resources/api-definition/test/test.yaml"
mapping "$projectDir/src/main/resources/api-definition/test/api-mappings.yaml" mapping "$projectDir/src/main/resources/api-definition/test/api-mappings.yaml"
targetDir "$buildDir/generated/sources/openapi-javax" targetDir "$buildDir/generated/sources/openapi-javax"
@ -142,7 +142,7 @@ openapiProcessor {
} }
springHs { springHs {
processorName 'spring' processorName 'spring'
processor 'io.openapiprocessor:openapi-processor-spring:2022.5' processor 'io.openapiprocessor:openapi-processor-spring:2024.2'
apiPath "$projectDir/src/main/resources/api-definition/hs-office/hs-office.yaml" apiPath "$projectDir/src/main/resources/api-definition/hs-office/hs-office.yaml"
mapping "$projectDir/src/main/resources/api-definition/hs-office/api-mappings.yaml" mapping "$projectDir/src/main/resources/api-definition/hs-office/api-mappings.yaml"
targetDir "$buildDir/generated/sources/openapi-javax" targetDir "$buildDir/generated/sources/openapi-javax"

20
src/main/resources/api-definition/hs-office/hs-office-bankaccounts-with-uuid.yaml
View File

@ -4,8 +4,8 @@ get:
description: 'Fetch a single bank account by its uuid, if visible for the current subject.' description: 'Fetch a single bank account by its uuid, if visible for the current subject.'
operationId: getBankAccountByUuid operationId: getBankAccountByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: bankAccountUUID - name: bankAccountUUID
in: path in: path
required: true required: true
@ -19,11 +19,11 @@ get:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-bankaccount-schemas.yaml#/components/schemas/HsOfficeBankAccount' $ref: 'hs-office-bankaccount-schemas.yaml#/components/schemas/HsOfficeBankAccount'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
delete: delete:
tags: tags:
@ -31,8 +31,8 @@ delete:
description: 'Delete a single bank account by its uuid, if permitted for the current subject.' description: 'Delete a single bank account by its uuid, if permitted for the current subject.'
operationId: deleteBankAccountByUuid operationId: deleteBankAccountByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: bankAccountUUID - name: bankAccountUUID
in: path in: path
required: true required: true
@ -44,8 +44,8 @@ delete:
"204": "204":
description: No Content description: No Content
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"404": "404":
$ref: './error-responses.yaml#/components/responses/NotFound' $ref: 'error-responses.yaml#/components/responses/NotFound'

24
src/main/resources/api-definition/hs-office/hs-office-bankaccounts.yaml
View File

@ -5,8 +5,8 @@ get:
- hs-office-bank-accounts - hs-office-bank-accounts
operationId: listBankAccounts operationId: listBankAccounts
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: holder - name: holder
in: query in: query
required: false required: false
@ -21,11 +21,11 @@ get:
schema: schema:
type: array type: array
items: items:
$ref: './hs-office-bankaccount-schemas.yaml#/components/schemas/HsOfficeBankAccount' $ref: 'hs-office-bankaccount-schemas.yaml#/components/schemas/HsOfficeBankAccount'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
post: post:
summary: Adds a new bank account. summary: Adds a new bank account.
@ -33,13 +33,13 @@ post:
- hs-office-bank-accounts - hs-office-bank-accounts
operationId: addBankAccount operationId: addBankAccount
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
requestBody: requestBody:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-bankaccount-schemas.yaml#/components/schemas/HsOfficeBankAccountInsert' $ref: 'hs-office-bankaccount-schemas.yaml#/components/schemas/HsOfficeBankAccountInsert'
required: true required: true
responses: responses:
"201": "201":
@ -47,10 +47,10 @@ post:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-bankaccount-schemas.yaml#/components/schemas/HsOfficeBankAccount' $ref: 'hs-office-bankaccount-schemas.yaml#/components/schemas/HsOfficeBankAccount'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"409": "409":
$ref: './error-responses.yaml#/components/responses/Conflict' $ref: 'error-responses.yaml#/components/responses/Conflict'

32
src/main/resources/api-definition/hs-office/hs-office-contacts-with-uuid.yaml
View File

@ -4,8 +4,8 @@ get:
description: 'Fetch a single business contact by its uuid, if visible for the current subject.' description: 'Fetch a single business contact by its uuid, if visible for the current subject.'
operationId: getContactByUuid operationId: getContactByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: contactUUID - name: contactUUID
in: path in: path
required: true required: true
@ -19,12 +19,12 @@ get:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-contact-schemas.yaml#/components/schemas/HsOfficeContact' $ref: 'hs-office-contact-schemas.yaml#/components/schemas/HsOfficeContact'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
patch: patch:
tags: tags:
@ -32,8 +32,8 @@ patch:
description: 'Updates a single contact by its uuid, if permitted for the current subject.' description: 'Updates a single contact by its uuid, if permitted for the current subject.'
operationId: patchContact operationId: patchContact
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: contactUUID - name: contactUUID
in: path in: path
required: true required: true
@ -44,18 +44,18 @@ patch:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-contact-schemas.yaml#/components/schemas/HsOfficeContactPatch' $ref: 'hs-office-contact-schemas.yaml#/components/schemas/HsOfficeContactPatch'
responses: responses:
"200": "200":
description: OK description: OK
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-contact-schemas.yaml#/components/schemas/HsOfficeContact' $ref: 'hs-office-contact-schemas.yaml#/components/schemas/HsOfficeContact'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
delete: delete:
tags: tags:
@ -63,8 +63,8 @@ delete:
description: 'Delete a single business contact by its uuid, if permitted for the current subject.' description: 'Delete a single business contact by its uuid, if permitted for the current subject.'
operationId: deleteContactByUuid operationId: deleteContactByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: contactUUID - name: contactUUID
in: path in: path
required: true required: true
@ -76,8 +76,8 @@ delete:
"204": "204":
description: No Content description: No Content
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"404": "404":
$ref: './error-responses.yaml#/components/responses/NotFound' $ref: 'error-responses.yaml#/components/responses/NotFound'

24
src/main/resources/api-definition/hs-office/hs-office-contacts.yaml
View File

@ -5,8 +5,8 @@ get:
- hs-office-contacts - hs-office-contacts
operationId: listContacts operationId: listContacts
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: name - name: name
in: query in: query
required: false required: false
@ -21,11 +21,11 @@ get:
schema: schema:
type: array type: array
items: items:
$ref: './hs-office-contact-schemas.yaml#/components/schemas/HsOfficeContact' $ref: 'hs-office-contact-schemas.yaml#/components/schemas/HsOfficeContact'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
post: post:
summary: Adds a new contact. summary: Adds a new contact.
@ -33,13 +33,13 @@ post:
- hs-office-contacts - hs-office-contacts
operationId: addContact operationId: addContact
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
requestBody: requestBody:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-contact-schemas.yaml#/components/schemas/HsOfficeContactInsert' $ref: 'hs-office-contact-schemas.yaml#/components/schemas/HsOfficeContactInsert'
required: true required: true
responses: responses:
"201": "201":
@ -47,10 +47,10 @@ post:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-contact-schemas.yaml#/components/schemas/HsOfficeContact' $ref: 'hs-office-contact-schemas.yaml#/components/schemas/HsOfficeContact'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"409": "409":
$ref: './error-responses.yaml#/components/responses/Conflict' $ref: 'error-responses.yaml#/components/responses/Conflict'

10
src/main/resources/api-definition/hs-office/hs-office-coopassets-with-uuid.yaml
View File

@ -4,8 +4,8 @@ get:
description: 'Fetch a single asset transaction by its uuid, if visible for the current subject.' description: 'Fetch a single asset transaction by its uuid, if visible for the current subject.'
operationId: getCoopAssetTransactionByUuid operationId: getCoopAssetTransactionByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: assetTransactionUUID - name: assetTransactionUUID
in: path in: path
required: true required: true
@ -19,9 +19,9 @@ get:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-coopassets-schemas.yaml#/components/schemas/HsOfficeCoopAssetsTransaction' $ref: 'hs-office-coopassets-schemas.yaml#/components/schemas/HsOfficeCoopAssetsTransaction'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'

24
src/main/resources/api-definition/hs-office/hs-office-coopassets.yaml
View File

@ -5,8 +5,8 @@ get:
- hs-office-coopAssets - hs-office-coopAssets
operationId: listCoopAssets operationId: listCoopAssets
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: membershipUuid - name: membershipUuid
in: query in: query
required: false required: false
@ -36,11 +36,11 @@ get:
schema: schema:
type: array type: array
items: items:
$ref: './hs-office-coopassets-schemas.yaml#/components/schemas/HsOfficeCoopAssetsTransaction' $ref: 'hs-office-coopassets-schemas.yaml#/components/schemas/HsOfficeCoopAssetsTransaction'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
post: post:
summary: Adds a new cooperative asset transaction. summary: Adds a new cooperative asset transaction.
@ -48,25 +48,25 @@ post:
- hs-office-coopAssets - hs-office-coopAssets
operationId: addCoopAssetsTransaction operationId: addCoopAssetsTransaction
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
requestBody: requestBody:
description: A JSON object describing the new cooperative assets transaction. description: A JSON object describing the new cooperative assets transaction.
required: true required: true
content: content:
application/json: application/json:
schema: schema:
$ref: '/hs-office-coopassets-schemas.yaml#/components/schemas/HsOfficeCoopAssetsTransactionInsert' $ref: 'hs-office-coopassets-schemas.yaml#/components/schemas/HsOfficeCoopAssetsTransactionInsert'
responses: responses:
"201": "201":
description: Created description: Created
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-coopassets-schemas.yaml#/components/schemas/HsOfficeCoopAssetsTransaction' $ref: 'hs-office-coopassets-schemas.yaml#/components/schemas/HsOfficeCoopAssetsTransaction'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"409": "409":
$ref: './error-responses.yaml#/components/responses/Conflict' $ref: 'error-responses.yaml#/components/responses/Conflict'

10
src/main/resources/api-definition/hs-office/hs-office-coopshares-with-uuid.yaml
View File

@ -4,8 +4,8 @@ get:
description: 'Fetch a single share transaction by its uuid, if visible for the current subject.' description: 'Fetch a single share transaction by its uuid, if visible for the current subject.'
operationId: getCoopShareTransactionByUuid operationId: getCoopShareTransactionByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: shareTransactionUUID - name: shareTransactionUUID
in: path in: path
required: true required: true
@ -19,9 +19,9 @@ get:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-coopshares-schemas.yaml#/components/schemas/HsOfficeCoopSharesTransaction' $ref: 'hs-office-coopshares-schemas.yaml#/components/schemas/HsOfficeCoopSharesTransaction'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'

24
src/main/resources/api-definition/hs-office/hs-office-coopshares.yaml
View File

@ -5,8 +5,8 @@ get:
- hs-office-coopShares - hs-office-coopShares
operationId: listCoopShares operationId: listCoopShares
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: membershipUuid - name: membershipUuid
in: query in: query
required: false required: false
@ -36,11 +36,11 @@ get:
schema: schema:
type: array type: array
items: items:
$ref: './hs-office-coopshares-schemas.yaml#/components/schemas/HsOfficeCoopSharesTransaction' $ref: 'hs-office-coopshares-schemas.yaml#/components/schemas/HsOfficeCoopSharesTransaction'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
post: post:
summary: Adds a new cooperative share transaction. summary: Adds a new cooperative share transaction.
@ -48,25 +48,25 @@ post:
- hs-office-coopShares - hs-office-coopShares
operationId: addCoopSharesTransaction operationId: addCoopSharesTransaction
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
requestBody: requestBody:
description: A JSON object describing the new cooperative shares transaction. description: A JSON object describing the new cooperative shares transaction.
required: true required: true
content: content:
application/json: application/json:
schema: schema:
$ref: '/hs-office-coopshares-schemas.yaml#/components/schemas/HsOfficeCoopSharesTransactionInsert' $ref: 'hs-office-coopshares-schemas.yaml#/components/schemas/HsOfficeCoopSharesTransactionInsert'
responses: responses:
"201": "201":
description: Created description: Created
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-coopshares-schemas.yaml#/components/schemas/HsOfficeCoopSharesTransaction' $ref: 'hs-office-coopshares-schemas.yaml#/components/schemas/HsOfficeCoopSharesTransaction'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"409": "409":
$ref: './error-responses.yaml#/components/responses/Conflict' $ref: 'error-responses.yaml#/components/responses/Conflict'

8
src/main/resources/api-definition/hs-office/hs-office-debitor-schemas.yaml
View File

@ -10,7 +10,7 @@ components:
type: string type: string
format: uuid format: uuid
debitorRel: debitorRel:
$ref: './hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation' $ref: 'hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation'
debitorNumber: debitorNumber:
type: integer type: integer
format: int32 format: int32
@ -22,7 +22,7 @@ components:
minimum: 00 minimum: 00
maximum: 99 maximum: 99
partner: partner:
$ref: './hs-office-partner-schemas.yaml#/components/schemas/HsOfficePartner' $ref: 'hs-office-partner-schemas.yaml#/components/schemas/HsOfficePartner'
billable: billable:
type: boolean type: boolean
vatId: vatId:
@ -35,7 +35,7 @@ components:
vatReverseCharge: vatReverseCharge:
type: boolean type: boolean
refundBankAccount: refundBankAccount:
$ref: './hs-office-bankaccount-schemas.yaml#/components/schemas/HsOfficeBankAccount' $ref: 'hs-office-bankaccount-schemas.yaml#/components/schemas/HsOfficeBankAccount'
defaultPrefix: defaultPrefix:
type: string type: string
pattern: '^[a-z0-9]{3}$' pattern: '^[a-z0-9]{3}$'
@ -76,7 +76,7 @@ components:
type: object type: object
properties: properties:
debitorRel: debitorRel:
$ref: './hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelationInsert' $ref: 'hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelationInsert'
debitorRelUuid: debitorRelUuid:
type: string type: string
format: uuid format: uuid

32
src/main/resources/api-definition/hs-office/hs-office-debitors-with-uuid.yaml
View File

@ -4,8 +4,8 @@ get:
description: 'Fetch a single debitor by its uuid, if visible for the current subject.' description: 'Fetch a single debitor by its uuid, if visible for the current subject.'
operationId: getDebitorByUuid operationId: getDebitorByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: debitorUUID - name: debitorUUID
in: path in: path
required: true required: true
@ -19,12 +19,12 @@ get:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor' $ref: 'hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
patch: patch:
tags: tags:
@ -32,8 +32,8 @@ patch:
description: 'Updates a single debitor by its uuid, if permitted for the current subject.' description: 'Updates a single debitor by its uuid, if permitted for the current subject.'
operationId: patchDebitor operationId: patchDebitor
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: debitorUUID - name: debitorUUID
in: path in: path
required: true required: true
@ -44,18 +44,18 @@ patch:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitorPatch' $ref: 'hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitorPatch'
responses: responses:
"200": "200":
description: OK description: OK
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor' $ref: 'hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
delete: delete:
tags: tags:
@ -63,8 +63,8 @@ delete:
description: 'Delete a single debitor by its uuid, if permitted for the current subject.' description: 'Delete a single debitor by its uuid, if permitted for the current subject.'
operationId: deleteDebitorByUuid operationId: deleteDebitorByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: debitorUUID - name: debitorUUID
in: path in: path
required: true required: true
@ -76,8 +76,8 @@ delete:
"204": "204":
description: No Content description: No Content
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"404": "404":
$ref: './error-responses.yaml#/components/responses/NotFound' $ref: 'error-responses.yaml#/components/responses/NotFound'

24
src/main/resources/api-definition/hs-office/hs-office-debitors.yaml
View File

@ -5,8 +5,8 @@ get:
- hs-office-debitors - hs-office-debitors
operationId: listDebitors operationId: listDebitors
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: name - name: name
in: query in: query
required: false required: false
@ -27,11 +27,11 @@ get:
schema: schema:
type: array type: array
items: items:
$ref: './hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor' $ref: 'hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
post: post:
summary: Adds a new debitor. summary: Adds a new debitor.
@ -39,13 +39,13 @@ post:
- hs-office-debitors - hs-office-debitors
operationId: addDebitor operationId: addDebitor
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
requestBody: requestBody:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitorInsert' $ref: 'hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitorInsert'
required: true required: true
responses: responses:
"201": "201":
@ -53,10 +53,10 @@ post:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor' $ref: 'hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"409": "409":
$ref: './error-responses.yaml#/components/responses/Conflict' $ref: 'error-responses.yaml#/components/responses/Conflict'

4
src/main/resources/api-definition/hs-office/hs-office-membership-schemas.yaml
View File

@ -22,9 +22,9 @@ components:
type: string type: string
format: uuid format: uuid
partner: partner:
$ref: './hs-office-partner-schemas.yaml#/components/schemas/HsOfficePartner' $ref: 'hs-office-partner-schemas.yaml#/components/schemas/HsOfficePartner'
mainDebitor: mainDebitor:
$ref: './hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor' $ref: 'hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor'
memberNumber: memberNumber:
type: integer type: integer
minimum: 1000000 minimum: 1000000

32
src/main/resources/api-definition/hs-office/hs-office-memberships-with-uuid.yaml
View File

@ -4,8 +4,8 @@ get:
description: 'Fetch a single membership by its uuid, if visible for the current subject.' description: 'Fetch a single membership by its uuid, if visible for the current subject.'
operationId: getMembershipByUuid operationId: getMembershipByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: membershipUUID - name: membershipUUID
in: path in: path
required: true required: true
@ -19,12 +19,12 @@ get:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-membership-schemas.yaml#/components/schemas/HsOfficeMembership' $ref: 'hs-office-membership-schemas.yaml#/components/schemas/HsOfficeMembership'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
patch: patch:
tags: tags:
@ -32,8 +32,8 @@ patch:
description: 'Updates a single membership by its uuid, if permitted for the current subject.' description: 'Updates a single membership by its uuid, if permitted for the current subject.'
operationId: patchMembership operationId: patchMembership
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: membershipUUID - name: membershipUUID
in: path in: path
required: true required: true
@ -44,18 +44,18 @@ patch:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-membership-schemas.yaml#/components/schemas/HsOfficeMembershipPatch' $ref: 'hs-office-membership-schemas.yaml#/components/schemas/HsOfficeMembershipPatch'
responses: responses:
"200": "200":
description: OK description: OK
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-membership-schemas.yaml#/components/schemas/HsOfficeMembership' $ref: 'hs-office-membership-schemas.yaml#/components/schemas/HsOfficeMembership'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
delete: delete:
tags: tags:
@ -63,8 +63,8 @@ delete:
description: 'Delete a single membership by its uuid, if permitted for the current subject.' description: 'Delete a single membership by its uuid, if permitted for the current subject.'
operationId: deleteMembershipByUuid operationId: deleteMembershipByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: membershipUUID - name: membershipUUID
in: path in: path
required: true required: true
@ -76,8 +76,8 @@ delete:
"204": "204":
description: No Content description: No Content
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"404": "404":
$ref: './error-responses.yaml#/components/responses/NotFound' $ref: 'error-responses.yaml#/components/responses/NotFound'

24
src/main/resources/api-definition/hs-office/hs-office-memberships.yaml
View File

@ -6,8 +6,8 @@ get:
- hs-office-memberships - hs-office-memberships
operationId: listMemberships operationId: listMemberships
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: partnerUuid - name: partnerUuid
in: query in: query
required: false required: false
@ -29,11 +29,11 @@ get:
schema: schema:
type: array type: array
items: items:
$ref: './hs-office-membership-schemas.yaml#/components/schemas/HsOfficeMembership' $ref: 'hs-office-membership-schemas.yaml#/components/schemas/HsOfficeMembership'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
post: post:
summary: Adds a new membership. summary: Adds a new membership.
@ -41,25 +41,25 @@ post:
- hs-office-memberships - hs-office-memberships
operationId: addMembership operationId: addMembership
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
requestBody: requestBody:
description: A JSON object describing the new membership. description: A JSON object describing the new membership.
required: true required: true
content: content:
application/json: application/json:
schema: schema:
$ref: '/hs-office-membership-schemas.yaml#/components/schemas/HsOfficeMembershipInsert' $ref: 'hs-office-membership-schemas.yaml#/components/schemas/HsOfficeMembershipInsert'
responses: responses:
"201": "201":
description: Created description: Created
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-membership-schemas.yaml#/components/schemas/HsOfficeMembership' $ref: 'hs-office-membership-schemas.yaml#/components/schemas/HsOfficeMembership'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"409": "409":
$ref: './error-responses.yaml#/components/responses/Conflict' $ref: 'error-responses.yaml#/components/responses/Conflict'

2
src/main/resources/api-definition/hs-office/hs-office-partner-schemas.yaml
View File

@ -15,7 +15,7 @@ components:
minimum: 10000 minimum: 10000
maximum: 99999 maximum: 99999
partnerRel: partnerRel:
$ref: './hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation' $ref: 'hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation'
details: details:
$ref: '#/components/schemas/HsOfficePartnerDetails' $ref: '#/components/schemas/HsOfficePartnerDetails'

32
src/main/resources/api-definition/hs-office/hs-office-partners-with-uuid.yaml
View File

@ -4,8 +4,8 @@ get:
description: 'Fetch a single business partner by its uuid, if visible for the current subject.' description: 'Fetch a single business partner by its uuid, if visible for the current subject.'
operationId: getPartnerByUuid operationId: getPartnerByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: partnerUUID - name: partnerUUID
in: path in: path
required: true required: true
@ -19,12 +19,12 @@ get:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-partner-schemas.yaml#/components/schemas/HsOfficePartner' $ref: 'hs-office-partner-schemas.yaml#/components/schemas/HsOfficePartner'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
patch: patch:
tags: tags:
@ -32,8 +32,8 @@ patch:
description: 'Updates a single business partner by its uuid, if permitted for the current subject.' description: 'Updates a single business partner by its uuid, if permitted for the current subject.'
operationId: patchPartner operationId: patchPartner
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: partnerUUID - name: partnerUUID
in: path in: path
required: true required: true
@ -44,18 +44,18 @@ patch:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-partner-schemas.yaml#/components/schemas/HsOfficePartnerPatch' $ref: 'hs-office-partner-schemas.yaml#/components/schemas/HsOfficePartnerPatch'
responses: responses:
"200": "200":
description: OK description: OK
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-partner-schemas.yaml#/components/schemas/HsOfficePartner' $ref: 'hs-office-partner-schemas.yaml#/components/schemas/HsOfficePartner'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
delete: delete:
tags: tags:
@ -63,8 +63,8 @@ delete:
description: 'Delete a single business partner by its uuid, if permitted for the current subject.' description: 'Delete a single business partner by its uuid, if permitted for the current subject.'
operationId: deletePartnerByUuid operationId: deletePartnerByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: partnerUUID - name: partnerUUID
in: path in: path
required: true required: true
@ -76,8 +76,8 @@ delete:
"204": "204":
description: No Content description: No Content
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"404": "404":
$ref: './error-responses.yaml#/components/responses/NotFound' $ref: 'error-responses.yaml#/components/responses/NotFound'

24
src/main/resources/api-definition/hs-office/hs-office-partners.yaml
View File

@ -5,8 +5,8 @@ get:
- hs-office-partners - hs-office-partners
operationId: listPartners operationId: listPartners
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: name - name: name
in: query in: query
required: false required: false
@ -21,11 +21,11 @@ get:
schema: schema:
type: array type: array
items: items:
$ref: './hs-office-partner-schemas.yaml#/components/schemas/HsOfficePartner' $ref: 'hs-office-partner-schemas.yaml#/components/schemas/HsOfficePartner'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
post: post:
summary: Adds a new business partner. summary: Adds a new business partner.
@ -33,13 +33,13 @@ post:
- hs-office-partners - hs-office-partners
operationId: addPartner operationId: addPartner
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
requestBody: requestBody:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-partner-schemas.yaml#/components/schemas/HsOfficePartnerInsert' $ref: 'hs-office-partner-schemas.yaml#/components/schemas/HsOfficePartnerInsert'
required: true required: true
responses: responses:
"201": "201":
@ -47,10 +47,10 @@ post:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-partner-schemas.yaml#/components/schemas/HsOfficePartner' $ref: 'hs-office-partner-schemas.yaml#/components/schemas/HsOfficePartner'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"409": "409":
$ref: './error-responses.yaml#/components/responses/Conflict' $ref: 'error-responses.yaml#/components/responses/Conflict'

32
src/main/resources/api-definition/hs-office/hs-office-persons-with-uuid.yaml
View File

@ -4,8 +4,8 @@ get:
description: 'Fetch a single business person by its uuid, if visible for the current subject.' description: 'Fetch a single business person by its uuid, if visible for the current subject.'
operationId: getPersonByUuid operationId: getPersonByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: personUUID - name: personUUID
in: path in: path
required: true required: true
@ -19,12 +19,12 @@ get:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-person-schemas.yaml#/components/schemas/HsOfficePerson' $ref: 'hs-office-person-schemas.yaml#/components/schemas/HsOfficePerson'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
patch: patch:
tags: tags:
@ -32,8 +32,8 @@ patch:
description: 'Updates a single person by its uuid, if permitted for the current subject.' description: 'Updates a single person by its uuid, if permitted for the current subject.'
operationId: patchPerson operationId: patchPerson
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: personUUID - name: personUUID
in: path in: path
required: true required: true
@ -44,18 +44,18 @@ patch:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-person-schemas.yaml#/components/schemas/HsOfficePersonPatch' $ref: 'hs-office-person-schemas.yaml#/components/schemas/HsOfficePersonPatch'
responses: responses:
"200": "200":
description: OK description: OK
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-person-schemas.yaml#/components/schemas/HsOfficePerson' $ref: 'hs-office-person-schemas.yaml#/components/schemas/HsOfficePerson'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
delete: delete:
tags: tags:
@ -63,8 +63,8 @@ delete:
description: 'Delete a single business person by its uuid, if permitted for the current subject.' description: 'Delete a single business person by its uuid, if permitted for the current subject.'
operationId: deletePersonByUuid operationId: deletePersonByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: personUUID - name: personUUID
in: path in: path
required: true required: true
@ -76,8 +76,8 @@ delete:
"204": "204":
description: No Content description: No Content
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"404": "404":
$ref: './error-responses.yaml#/components/responses/NotFound' $ref: 'error-responses.yaml#/components/responses/NotFound'

24
src/main/resources/api-definition/hs-office/hs-office-persons.yaml
View File

@ -5,8 +5,8 @@ get:
- hs-office-persons - hs-office-persons
operationId: listPersons operationId: listPersons
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: name - name: name
in: query in: query
required: false required: false
@ -21,11 +21,11 @@ get:
schema: schema:
type: array type: array
items: items:
$ref: './hs-office-person-schemas.yaml#/components/schemas/HsOfficePerson' $ref: 'hs-office-person-schemas.yaml#/components/schemas/HsOfficePerson'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
post: post:
summary: Adds a new person. summary: Adds a new person.
@ -33,13 +33,13 @@ post:
- hs-office-persons - hs-office-persons
operationId: addPerson operationId: addPerson
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
requestBody: requestBody:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-person-schemas.yaml#/components/schemas/HsOfficePersonInsert' $ref: 'hs-office-person-schemas.yaml#/components/schemas/HsOfficePersonInsert'
required: true required: true
responses: responses:
"201": "201":
@ -47,10 +47,10 @@ post:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-person-schemas.yaml#/components/schemas/HsOfficePerson' $ref: 'hs-office-person-schemas.yaml#/components/schemas/HsOfficePerson'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"409": "409":
$ref: './error-responses.yaml#/components/responses/Conflict' $ref: 'error-responses.yaml#/components/responses/Conflict'

6
src/main/resources/api-definition/hs-office/hs-office-relation-schemas.yaml
View File

@ -22,16 +22,16 @@ components:
type: string type: string
format: uuid format: uuid
anchor: anchor:
$ref: './hs-office-person-schemas.yaml#/components/schemas/HsOfficePerson' $ref: 'hs-office-person-schemas.yaml#/components/schemas/HsOfficePerson'
holder: holder:
$ref: './hs-office-person-schemas.yaml#/components/schemas/HsOfficePerson' $ref: 'hs-office-person-schemas.yaml#/components/schemas/HsOfficePerson'
type: type:
type: string type: string
mark: mark:
type: string type: string
nullable: true nullable: true
contact: contact:
$ref: './hs-office-contact-schemas.yaml#/components/schemas/HsOfficeContact' $ref: 'hs-office-contact-schemas.yaml#/components/schemas/HsOfficeContact'
HsOfficeRelationPatch: HsOfficeRelationPatch:
type: object type: object

32
src/main/resources/api-definition/hs-office/hs-office-relations-with-uuid.yaml
View File

@ -4,8 +4,8 @@ get:
description: 'Fetch a single person relation by its uuid, if visible for the current subject.' description: 'Fetch a single person relation by its uuid, if visible for the current subject.'
operationId: getRelationByUuid operationId: getRelationByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: relationUUID - name: relationUUID
in: path in: path
required: true required: true
@ -19,12 +19,12 @@ get:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation' $ref: 'hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
patch: patch:
tags: tags:
@ -32,8 +32,8 @@ patch:
description: 'Updates a single person relation by its uuid, if permitted for the current subject.' description: 'Updates a single person relation by its uuid, if permitted for the current subject.'
operationId: patchRelation operationId: patchRelation
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: relationUUID - name: relationUUID
in: path in: path
required: true required: true
@ -44,18 +44,18 @@ patch:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelationPatch' $ref: 'hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelationPatch'
responses: responses:
"200": "200":
description: OK description: OK
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation' $ref: 'hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
delete: delete:
tags: tags:
@ -63,8 +63,8 @@ delete:
description: 'Delete a single person relation by its uuid, if permitted for the current subject.' description: 'Delete a single person relation by its uuid, if permitted for the current subject.'
operationId: deleteRelationByUuid operationId: deleteRelationByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: relationUUID - name: relationUUID
in: path in: path
required: true required: true
@ -76,8 +76,8 @@ delete:
"204": "204":
description: No Content description: No Content
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"404": "404":
$ref: './error-responses.yaml#/components/responses/NotFound' $ref: 'error-responses.yaml#/components/responses/NotFound'

26
src/main/resources/api-definition/hs-office/hs-office-relations.yaml
View File

@ -5,8 +5,8 @@ get:
- hs-office-relations - hs-office-relations
operationId: listRelations operationId: listRelations
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: personUuid - name: personUuid
in: query in: query
required: true required: true
@ -18,7 +18,7 @@ get:
in: query in: query
required: false required: false
schema: schema:
$ref: './hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelationType' $ref: 'hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelationType'
description: Prefix of name properties from holder or contact to filter the results. description: Prefix of name properties from holder or contact to filter the results.
responses: responses:
"200": "200":
@ -28,11 +28,11 @@ get:
schema: schema:
type: array type: array
items: items:
$ref: './hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation' $ref: 'hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
post: post:
summary: Adds a new person relation. summary: Adds a new person relation.
@ -40,13 +40,13 @@ post:
- hs-office-relations - hs-office-relations
operationId: addRelation operationId: addRelation
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
requestBody: requestBody:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelationInsert' $ref: 'hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelationInsert'
required: true required: true
responses: responses:
"201": "201":
@ -54,10 +54,10 @@ post:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation' $ref: 'hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"409": "409":
$ref: './error-responses.yaml#/components/responses/Conflict' $ref: 'error-responses.yaml#/components/responses/Conflict'

4
src/main/resources/api-definition/hs-office/hs-office-sepamandate-schemas.yaml
View File

@ -10,9 +10,9 @@ components:
type: string type: string
format: uuid format: uuid
debitor: debitor:
$ref: './hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor' $ref: 'hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor'
bankAccount: bankAccount:
$ref: './hs-office-bankaccount-schemas.yaml#/components/schemas/HsOfficeBankAccount' $ref: 'hs-office-bankaccount-schemas.yaml#/components/schemas/HsOfficeBankAccount'
reference: reference:
type: string type: string
agreement: agreement:

32
src/main/resources/api-definition/hs-office/hs-office-sepamandates-with-uuid.yaml
View File

@ -4,8 +4,8 @@ get:
description: 'Fetch a single SEPA Mandate by its uuid, if visible for the current subject.' description: 'Fetch a single SEPA Mandate by its uuid, if visible for the current subject.'
operationId: getSepaMandateByUuid operationId: getSepaMandateByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: sepaMandateUUID - name: sepaMandateUUID
in: path in: path
required: true required: true
@ -19,12 +19,12 @@ get:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-sepamandate-schemas.yaml#/components/schemas/HsOfficeSepaMandate' $ref: 'hs-office-sepamandate-schemas.yaml#/components/schemas/HsOfficeSepaMandate'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
patch: patch:
tags: tags:
@ -32,8 +32,8 @@ patch:
description: 'Updates a single SEPA Mandate by its uuid, if permitted for the current subject.' description: 'Updates a single SEPA Mandate by its uuid, if permitted for the current subject.'
operationId: patchSepaMandate operationId: patchSepaMandate
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: sepaMandateUUID - name: sepaMandateUUID
in: path in: path
required: true required: true
@ -44,18 +44,18 @@ patch:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-sepamandate-schemas.yaml#/components/schemas/HsOfficeSepaMandatePatch' $ref: 'hs-office-sepamandate-schemas.yaml#/components/schemas/HsOfficeSepaMandatePatch'
responses: responses:
"200": "200":
description: OK description: OK
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-sepamandate-schemas.yaml#/components/schemas/HsOfficeSepaMandate' $ref: 'hs-office-sepamandate-schemas.yaml#/components/schemas/HsOfficeSepaMandate'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
delete: delete:
tags: tags:
@ -63,8 +63,8 @@ delete:
description: 'Delete a single SEPA Mandate by its uuid, if permitted for the current subject.' description: 'Delete a single SEPA Mandate by its uuid, if permitted for the current subject.'
operationId: deleteSepaMandateByUuid operationId: deleteSepaMandateByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: sepaMandateUUID - name: sepaMandateUUID
in: path in: path
required: true required: true
@ -76,8 +76,8 @@ delete:
"204": "204":
description: No Content description: No Content
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"404": "404":
$ref: './error-responses.yaml#/components/responses/NotFound' $ref: 'error-responses.yaml#/components/responses/NotFound'

24
src/main/resources/api-definition/hs-office/hs-office-sepamandates.yaml
View File

@ -5,8 +5,8 @@ get:
- hs-office-sepaMandates - hs-office-sepaMandates
operationId: listSepaMandatesByIBAN operationId: listSepaMandatesByIBAN
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: name - name: name
in: query in: query
required: false required: false
@ -21,11 +21,11 @@ get:
schema: schema:
type: array type: array
items: items:
$ref: './hs-office-sepamandate-schemas.yaml#/components/schemas/HsOfficeSepaMandate' $ref: 'hs-office-sepamandate-schemas.yaml#/components/schemas/HsOfficeSepaMandate'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
post: post:
summary: Adds a new SEPA Mandate. summary: Adds a new SEPA Mandate.
@ -33,25 +33,25 @@ post:
- hs-office-sepaMandates - hs-office-sepaMandates
operationId: addSepaMandate operationId: addSepaMandate
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
requestBody: requestBody:
description: A JSON object describing the new SEPA-Mandate. description: A JSON object describing the new SEPA-Mandate.
required: true required: true
content: content:
application/json: application/json:
schema: schema:
$ref: '/hs-office-sepamandate-schemas.yaml#/components/schemas/HsOfficeSepaMandateInsert' $ref: 'hs-office-sepamandate-schemas.yaml#/components/schemas/HsOfficeSepaMandateInsert'
responses: responses:
"201": "201":
description: Created description: Created
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './hs-office-sepamandate-schemas.yaml#/components/schemas/HsOfficeSepaMandate' $ref: 'hs-office-sepamandate-schemas.yaml#/components/schemas/HsOfficeSepaMandate'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"409": "409":
$ref: './error-responses.yaml#/components/responses/Conflict' $ref: 'error-responses.yaml#/components/responses/Conflict'

40
src/main/resources/api-definition/hs-office/hs-office.yaml
View File

@ -11,87 +11,87 @@ paths:
# Partners # Partners
/api/hs/office/partners: /api/hs/office/partners:
$ref: "./hs-office-partners.yaml" $ref: "hs-office-partners.yaml"
/api/hs/office/partners/{partnerUUID}: /api/hs/office/partners/{partnerUUID}:
$ref: "./hs-office-partners-with-uuid.yaml" $ref: "hs-office-partners-with-uuid.yaml"
# Contacts # Contacts
/api/hs/office/contacts: /api/hs/office/contacts:
$ref: "./hs-office-contacts.yaml" $ref: "hs-office-contacts.yaml"
/api/hs/office/contacts/{contactUUID}: /api/hs/office/contacts/{contactUUID}:
$ref: "./hs-office-contacts-with-uuid.yaml" $ref: "hs-office-contacts-with-uuid.yaml"
# Persons # Persons
/api/hs/office/persons: /api/hs/office/persons:
$ref: "./hs-office-persons.yaml" $ref: "hs-office-persons.yaml"
/api/hs/office/persons/{personUUID}: /api/hs/office/persons/{personUUID}:
$ref: "./hs-office-persons-with-uuid.yaml" $ref: "hs-office-persons-with-uuid.yaml"
# Relations # Relations
/api/hs/office/relations: /api/hs/office/relations:
$ref: "./hs-office-relations.yaml" $ref: "hs-office-relations.yaml"
/api/hs/office/relations/{relationUUID}: /api/hs/office/relations/{relationUUID}:
$ref: "./hs-office-relations-with-uuid.yaml" $ref: "hs-office-relations-with-uuid.yaml"
# BankAccounts # BankAccounts
/api/hs/office/bankaccounts: /api/hs/office/bankaccounts:
$ref: "./hs-office-bankaccounts.yaml" $ref: "hs-office-bankaccounts.yaml"
/api/hs/office/bankaccounts/{bankAccountUUID}: /api/hs/office/bankaccounts/{bankAccountUUID}:
$ref: "./hs-office-bankaccounts-with-uuid.yaml" $ref: "hs-office-bankaccounts-with-uuid.yaml"
# Debitors # Debitors
/api/hs/office/debitors: /api/hs/office/debitors:
$ref: "./hs-office-debitors.yaml" $ref: "hs-office-debitors.yaml"
/api/hs/office/debitors/{debitorUUID}: /api/hs/office/debitors/{debitorUUID}:
$ref: "./hs-office-debitors-with-uuid.yaml" $ref: "hs-office-debitors-with-uuid.yaml"
# SepaMandates # SepaMandates
/api/hs/office/sepamandates: /api/hs/office/sepamandates:
$ref: "./hs-office-sepamandates.yaml" $ref: "hs-office-sepamandates.yaml"
/api/hs/office/sepamandates/{sepaMandateUUID}: /api/hs/office/sepamandates/{sepaMandateUUID}:
$ref: "./hs-office-sepamandates-with-uuid.yaml" $ref: "hs-office-sepamandates-with-uuid.yaml"
# Membership # Membership
/api/hs/office/memberships: /api/hs/office/memberships:
$ref: "./hs-office-memberships.yaml" $ref: "hs-office-memberships.yaml"
/api/hs/office/memberships/{membershipUUID}: /api/hs/office/memberships/{membershipUUID}:
$ref: "./hs-office-memberships-with-uuid.yaml" $ref: "hs-office-memberships-with-uuid.yaml"
# Coop Shares Transaction # Coop Shares Transaction
/api/hs/office/coopsharestransactions: /api/hs/office/coopsharestransactions:
$ref: "./hs-office-coopshares.yaml" $ref: "hs-office-coopshares.yaml"
/api/hs/office/coopsharestransactions/{shareTransactionUUID}: /api/hs/office/coopsharestransactions/{shareTransactionUUID}:
$ref: "./hs-office-coopshares-with-uuid.yaml" $ref: "hs-office-coopshares-with-uuid.yaml"
# Coop Assets Transaction # Coop Assets Transaction
/api/hs/office/coopassetstransactions: /api/hs/office/coopassetstransactions:
$ref: "./hs-office-coopassets.yaml" $ref: "hs-office-coopassets.yaml"
/api/hs/office/coopassetstransactions/{assetTransactionUUID}: /api/hs/office/coopassetstransactions/{assetTransactionUUID}:
$ref: "./hs-office-coopassets-with-uuid.yaml" $ref: "hs-office-coopassets-with-uuid.yaml"

22
src/main/resources/api-definition/rbac/rbac-grants-with-id.yaml
View File

@ -3,8 +3,8 @@ get:
- rbac-grants - rbac-grants
operationId: getGrantById operationId: getGrantById
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: grantedRoleUuid - name: grantedRoleUuid
in: path in: path
required: true required: true
@ -25,21 +25,21 @@ get:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './rbac-grant-schemas.yaml#/components/schemas/RbacGrant' $ref: 'rbac-grant-schemas.yaml#/components/schemas/RbacGrant'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"404": "404":
$ref: './error-responses.yaml#/components/responses/NotFound' $ref: 'error-responses.yaml#/components/responses/NotFound'
delete: delete:
tags: tags:
- rbac-grants - rbac-grants
operationId: revokeRoleFromUser operationId: revokeRoleFromUser
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: grantedRoleUuid - name: grantedRoleUuid
in: path in: path
required: true required: true
@ -58,8 +58,8 @@ delete:
"204": "204":
description: No Content description: No Content
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"404": "404":
$ref: './error-responses.yaml#/components/responses/NotFound' $ref: 'error-responses.yaml#/components/responses/NotFound'

20
src/main/resources/api-definition/rbac/rbac-grants.yaml
View File

@ -3,8 +3,8 @@ get:
- rbac-grants - rbac-grants
operationId: listUserGrants operationId: listUserGrants
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
responses: responses:
"200": "200":
description: OK description: OK
@ -13,31 +13,31 @@ get:
schema: schema:
type: array type: array
items: items:
$ref: './rbac-grant-schemas.yaml#/components/schemas/RbacGrant' $ref: 'rbac-grant-schemas.yaml#/components/schemas/RbacGrant'
post: post:
tags: tags:
- rbac-grants - rbac-grants
operationId: grantRoleToUser operationId: grantRoleToUser
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
requestBody: requestBody:
required: true required: true
content: content:
application/json: application/json:
schema: schema:
$ref: './rbac-grant-schemas.yaml#/components/schemas/RbacGrant' $ref: 'rbac-grant-schemas.yaml#/components/schemas/RbacGrant'
responses: responses:
"201": "201":
description: OK description: OK
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './rbac-grant-schemas.yaml#/components/schemas/RbacGrant' $ref: 'rbac-grant-schemas.yaml#/components/schemas/RbacGrant'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"409": "409":
$ref: './error-responses.yaml#/components/responses/Conflict' $ref: 'error-responses.yaml#/components/responses/Conflict'

6
src/main/resources/api-definition/rbac/rbac-roles.yaml
View File

@ -3,8 +3,8 @@ get:
- rbac-roles - rbac-roles
operationId: listRoles operationId: listRoles
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
responses: responses:
"200": "200":
description: OK description: OK
@ -13,4 +13,4 @@ get:
schema: schema:
type: array type: array
items: items:
$ref: './rbac-role-schemas.yaml#/components/schemas/RbacRole' $ref: 'rbac-role-schemas.yaml#/components/schemas/RbacRole'

10
src/main/resources/api-definition/rbac/rbac-users-with-id-permissions.yaml
View File

@ -4,8 +4,8 @@ get:
description: 'List all visible permissions granted to the given user; reduced ' description: 'List all visible permissions granted to the given user; reduced '
operationId: listUserPermissions operationId: listUserPermissions
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: userUuid - name: userUuid
in: path in: path
required: true required: true
@ -20,9 +20,9 @@ get:
schema: schema:
type: array type: array
items: items:
$ref: './rbac-user-schemas.yaml#/components/schemas/RbacUserPermission' $ref: 'rbac-user-schemas.yaml#/components/schemas/RbacUserPermission'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'

20
src/main/resources/api-definition/rbac/rbac-users-with-uuid.yaml
View File

@ -4,8 +4,8 @@ get:
description: 'Fetch a single user by its id, if visible for the current subject.' description: 'Fetch a single user by its id, if visible for the current subject.'
operationId: getUserById operationId: getUserById
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: userUuid - name: userUuid
in: path in: path
required: true required: true
@ -18,12 +18,12 @@ get:
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './rbac-user-schemas.yaml#/components/schemas/RbacUser' $ref: 'rbac-user-schemas.yaml#/components/schemas/RbacUser'
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
delete: delete:
@ -31,8 +31,8 @@ delete:
- rbac-users - rbac-users
operationId: deleteUserByUuid operationId: deleteUserByUuid
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: userUuid - name: userUuid
in: path in: path
required: true required: true
@ -44,8 +44,8 @@ delete:
"204": "204":
description: No Content description: No Content
"401": "401":
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
"403": "403":
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
"404": "404":
$ref: './error-responses.yaml#/components/responses/NotFound' $ref: 'error-responses.yaml#/components/responses/NotFound'

16
src/main/resources/api-definition/rbac/rbac-users.yaml
View File

@ -4,8 +4,8 @@ get:
description: List accessible RBAC users with optional filter by name. description: List accessible RBAC users with optional filter by name.
operationId: listUsers operationId: listUsers
parameters: parameters:
- $ref: './auth.yaml#/components/parameters/currentUser' - $ref: 'auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles' - $ref: 'auth.yaml#/components/parameters/assumedRoles'
- name: name - name: name
in: query in: query
required: false required: false
@ -19,11 +19,11 @@ get:
schema: schema:
type: array type: array
items: items:
$ref: './rbac-user-schemas.yaml#/components/schemas/RbacUser' $ref: 'rbac-user-schemas.yaml#/components/schemas/RbacUser'
'401': '401':
$ref: './error-responses.yaml#/components/responses/Unauthorized' $ref: 'error-responses.yaml#/components/responses/Unauthorized'
'403': '403':
$ref: './error-responses.yaml#/components/responses/Forbidden' $ref: 'error-responses.yaml#/components/responses/Forbidden'
post: post:
tags: tags:
@ -35,14 +35,14 @@ post:
content: content:
application/json: application/json:
schema: schema:
$ref: './rbac-user-schemas.yaml#/components/schemas/RbacUser' $ref: 'rbac-user-schemas.yaml#/components/schemas/RbacUser'
responses: responses:
'201': '201':
description: Created description: Created
content: content:
'application/json': 'application/json':
schema: schema:
$ref: './rbac-user-schemas.yaml#/components/schemas/RbacUser' $ref: 'rbac-user-schemas.yaml#/components/schemas/RbacUser'
'409': '409':
$ref: './error-responses.yaml#/components/responses/Conflict' $ref: 'error-responses.yaml#/components/responses/Conflict'

12
src/main/resources/api-definition/rbac/rbac.yaml
View File

@ -9,20 +9,20 @@ servers:
paths: paths:
/api/rbac/users: /api/rbac/users:
$ref: './rbac-users.yaml' $ref: 'rbac-users.yaml'
/api/rbac/users/{userUuid}/permissions: /api/rbac/users/{userUuid}/permissions:
$ref: './rbac-users-with-id-permissions.yaml' $ref: 'rbac-users-with-id-permissions.yaml'
/api/rbac/users/{userUuid}: /api/rbac/users/{userUuid}:
$ref: './rbac-users-with-uuid.yaml' $ref: 'rbac-users-with-uuid.yaml'
/api/rbac/roles: /api/rbac/roles:
$ref: './rbac-roles.yaml' $ref: 'rbac-roles.yaml'
/api/rbac/grants: /api/rbac/grants:
$ref: './rbac-grants.yaml' $ref: 'rbac-grants.yaml'
/api/rbac/grants/{grantedRoleUuid}/{granteeUserUuid}: /api/rbac/grants/{grantedRoleUuid}/{granteeUserUuid}:
$ref: './rbac-grants-with-id.yaml' $ref: 'rbac-grants-with-id.yaml'