feature/prefixes-for-partner-member-debitor-in-api (#122)

Co-authored-by: Michael Hoennig <michael@hoennig.de>
Reviewed-on: https://dev.hostsharing.net/hostsharing/hs.hsadmin.ng/pulls/122
Reviewed-by: Timotheus Pokorra <timotheus.pokorra@hostsharing.net>

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

@@ -12,10 +12,10 @@ components:
                 debitorRel:
                     $ref: 'hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation'
                 debitorNumber:
-                    type: integer
-                    format: int32
-                    minimum: 1000000
-                    maximum: 9999999
+                    type: string
+                    minLength: 9
+                    maxLength: 9
+                    pattern: 'D-[0-9]{7}'
                 debitorNumberSuffix:
                     type: string
                     pattern: '^[0-9][0-9]$'

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

@@ -2,7 +2,7 @@ get:
     tags:
         - hs-office-debitors
     description: 'Fetch a single debitor by its uuid, if visible for the current subject.'
-    operationId: getDebitorByUuid
+    operationId: getSingleDebitorByUuid
     parameters:
         - $ref: 'auth.yaml#/components/parameters/currentSubject'
         - $ref: 'auth.yaml#/components/parameters/assumedRoles'

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

@@ -3,7 +3,7 @@ get:
     description: Returns the list of (optionally filtered) debitors which are visible to the current subject or any of it's assumed roles.
     tags:
         - hs-office-debitors
-    operationId: listDebitors
+    operationId: getListOfDebitors
     parameters:
         - $ref: 'auth.yaml#/components/parameters/currentSubject'
         - $ref: 'auth.yaml#/components/parameters/assumedRoles'
@@ -17,7 +17,10 @@ get:
           in: query
           required: false
           schema:
-              type: integer
+              type: string
+              minLength: 9
+              maxLength: 9
+              pattern: 'D-[0-9]{7}'
           description: Debitor number of the requested debitor.
     responses:
         "200":
@@ -37,7 +40,7 @@ post:
     summary: Adds a new debitor.
     tags:
         - hs-office-debitors
-    operationId: addDebitor
+    operationId: postNewDebitor
     parameters:
         - $ref: 'auth.yaml#/components/parameters/currentSubject'
         - $ref: 'auth.yaml#/components/parameters/assumedRoles'

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

@@ -26,9 +26,10 @@ components:
                 mainDebitor:
                     $ref: 'hs-office-debitor-schemas.yaml#/components/schemas/HsOfficeDebitor'
                 memberNumber:
-                    type: integer
-                    minimum: 1000000
-                    maximum: 9999999
+                    type: string
+                    minLength: 9
+                    maxLength: 9
+                    pattern: 'M-[0-9]{7}'
                 memberNumberSuffix:
                     type: string
                     minLength: 2

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

@@ -2,7 +2,7 @@ get:
     tags:
         - hs-office-memberships
     description: 'Fetch a single membership by its uuid, if visible for the current subject.'
-    operationId: getMembershipByUuid
+    operationId: getSingleMembershipByUuid
     parameters:
         - $ref: 'auth.yaml#/components/parameters/currentSubject'
         - $ref: 'auth.yaml#/components/parameters/assumedRoles'

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

@@ -4,7 +4,7 @@ get:
         The list can optionally be filtered by either the `partnerUuid` or the `memberNumber` - not both at the same time.
     tags:
         - hs-office-memberships
-    operationId: listMemberships
+    operationId: getListOfMemberships
     parameters:
         - $ref: 'auth.yaml#/components/parameters/currentSubject'
         - $ref: 'auth.yaml#/components/parameters/assumedRoles'
@@ -19,7 +19,10 @@ get:
           in: query
           required: false
           schema:
-              type: integer
+              type: string
+              minLength: 9
+              maxLength: 9
+              pattern: 'M-[0-9]{7}'
           description: Member number, exclusive to `partnerUuid`.
     responses:
         "200":
@@ -39,7 +42,7 @@ post:
     summary: Adds a new membership.
     tags:
         - hs-office-memberships
-    operationId: addMembership
+    operationId: postNewMembership
     parameters:
         - $ref: 'auth.yaml#/components/parameters/currentSubject'
         - $ref: 'auth.yaml#/components/parameters/assumedRoles'

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

@@ -10,10 +10,10 @@ components:
                     type: string
                     format: uuid
                 partnerNumber:
-                    type: integer
-                    format: int8
-                    minimum: 10000
-                    maximum: 99999
+                    type: string
+                    minLength: 7
+                    maxLength: 7
+                    pattern: 'P-[0-9]{5}'
                 partnerRel:
                     $ref: 'hs-office-relation-schemas.yaml#/components/schemas/HsOfficeRelation'
                 details:
@@ -86,10 +86,10 @@ components:
             type: object
             properties:
                 partnerNumber:
-                    type: integer
-                    format: int8
-                    minimum: 10000
-                    maximum: 99999
+                    type: string
+                    minLength: 7
+                    maxLength: 7
+                    pattern: 'P-[0-9]{5}'
                 partnerRel:
                     $ref: '#/components/schemas/HsOfficePartnerRelInsert'
                 details: