1
0

hs-office-coopassets, no get API endpoints yet

This commit is contained in:
Michael Hoennig
2022-10-21 17:12:55 +02:00
parent 5ada0dae35
commit a39cf73cf0
18 changed files with 1314 additions and 1 deletions

View File

@ -12,6 +12,7 @@ map:
- type: array => java.util.List
- type: string:uuid => java.util.UUID
- type: string:format => java.lang.String
- type: number:currency => java.math.BigDecimal
paths:
/api/hs/office/partners/{partnerUUID}:

View File

@ -0,0 +1,63 @@
components:
schemas:
HsOfficeCoopAssetsTransactionType:
type: string
enum:
- ADJUSTMENT
- DEPOSIT
- DISBURSAL
- TRANSFER
- ADOPTION
- CLEARING
- LOSS
HsOfficeCoopAssetsTransaction:
type: object
properties:
uuid:
type: string
format: uuid
transactionType:
$ref: '#/components/schemas/HsOfficeCoopAssetsTransactionType'
assetValue:
type: number
format: currency
valueDate:
type: string
format: date
reference:
type: string
comment:
type: string
HsOfficeCoopAssetsTransactionInsert:
type: object
properties:
membershipUuid:
type: string
format: uuid
nullable: false
transactionType:
$ref: '#/components/schemas/HsOfficeCoopAssetsTransactionType'
assetValue:
type: number
format: currency
valueDate:
type: string
format: date
reference:
type: string
minLength: 6
maxLength: 48
comment:
type: string
required:
- membershipUuid
- transactionType
- assetValue
- valueDate
- reference
additionalProperties: false

View File

@ -0,0 +1,72 @@
get:
summary: Returns a list of (optionally filtered) cooperative asset transactions.
description: Returns the list of (optionally filtered) cooperative asset transactions which are visible to the current user or any of it's assumed roles.
tags:
- hs-office-coopAssets
operationId: listCoopAssets
parameters:
- $ref: './auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles'
- name: membershipUuid
in: query
required: false
schema:
type: string
format: uuid
description: Optional UUID of the related membership.
- name: fromValueDate
in: query
required: false
schema:
type: string
format: date
description: Optional value date range start (inclusive).
- name: toValueDate
in: query
required: false
schema:
type: string
format: date
description: Optional value date range end (inclusive).
responses:
"200":
description: OK
content:
'application/json':
schema:
type: array
items:
$ref: './hs-office-coopassets-schemas.yaml#/components/schemas/HsOfficeCoopAssetsTransaction'
"401":
$ref: './error-responses.yaml#/components/responses/Unauthorized'
"403":
$ref: './error-responses.yaml#/components/responses/Forbidden'
post:
summary: Adds a new cooperative asset transaction.
tags:
- hs-office-coopAssets
operationId: addCoopAssetsTransaction
parameters:
- $ref: './auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles'
requestBody:
description: A JSON object describing the new cooperative assets transaction.
required: true
content:
application/json:
schema:
$ref: '/hs-office-coopassets-schemas.yaml#/components/schemas/HsOfficeCoopAssetsTransactionInsert'
responses:
"201":
description: Created
content:
'application/json':
schema:
$ref: './hs-office-coopassets-schemas.yaml#/components/schemas/HsOfficeCoopAssetsTransaction'
"401":
$ref: './error-responses.yaml#/components/responses/Unauthorized'
"403":
$ref: './error-responses.yaml#/components/responses/Forbidden'
"409":
$ref: './error-responses.yaml#/components/responses/Conflict'

View File

@ -84,3 +84,9 @@ paths:
/api/hs/office/coopsharestransactions:
$ref: "./hs-office-coopshares.yaml"
# Coop Assets Transaction
/api/hs/office/coopassetstransactions:
$ref: "./hs-office-coopassets.yaml"