add micrometer @Timing annotations to Controllers+Repositories + ArchTest (#128)

Co-authored-by: Michael Hoennig <michael@hoennig.de> Reviewed-on: https://dev.hostsharing.net/hostsharing/hs.hsadmin.ng/pulls/128 Reviewed-by: Timotheus Pokorra <timotheus.pokorra@hostsharing.net>
2024-12-05 10:32:34 +01:00
parent 0832c90c82
commit ddba946d72
88 changed files with 461 additions and 136 deletions
--- a/src/main/resources/api-definition/hs-booking/hs-booking-items-with-uuid.yaml
+++ b/src/main/resources/api-definition/hs-booking/hs-booking-items-with-uuid.yaml
@@ -2,7 +2,7 @@ get:
    tags:
        - hs-booking-items
    description: 'Fetch a single booking item its uuid, if visible for the current subject.'
-    operationId: getBookingItemByUuid
+    operationId: getSingleBookingItemByUuid
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-booking/hs-booking-items.yaml
+++ b/src/main/resources/api-definition/hs-booking/hs-booking-items.yaml
@@ -3,7 +3,7 @@ get:
    description: Returns the list of all booking items for a specified project which are visible to the current subject or any of it's assumed roles.
    tags:
        - hs-booking-items
-    operationId: listBookingItemsByProjectUuid
+    operationId: getListOfBookingItemsByProjectUuid
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
@@ -32,7 +32,7 @@ post:
    summary: Adds a new booking item.
    tags:
        - hs-booking-items
-    operationId: addBookingItem
+    operationId: postNewBookingItem
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-booking/hs-booking-projects.yaml
+++ b/src/main/resources/api-definition/hs-booking/hs-booking-projects.yaml
@@ -3,7 +3,7 @@ get:
    description: Returns the list of all booking projects for a specified debitor which are visible to the current subject or any of it's assumed roles.
    tags:
        - hs-booking-projects
-    operationId: listBookingProjectsByDebitorUuid
+    operationId: getListOfBookingProjectsByDebitorUuid
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
@@ -32,7 +32,7 @@ post:
    summary: Adds a new project as a container for booking items.
    tags:
        - hs-booking-projects
-    operationId: addBookingProject
+    operationId: postNewBookingProject
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-hosting/hs-hosting-asset-types-props.yaml
+++ b/src/main/resources/api-definition/hs-hosting/hs-hosting-asset-types-props.yaml
@@ -3,7 +3,7 @@ get:
    description: Returns the list of available properties and their validations for a given asset type.
    tags:
        - hs-hosting-asset-props
-    operationId: listAssetTypeProps
+    operationId: getListOfHostingAssetTypeProps
    parameters:
        - name: assetType
          in: path
--- a/src/main/resources/api-definition/hs-hosting/hs-hosting-asset-types.yaml
+++ b/src/main/resources/api-definition/hs-hosting/hs-hosting-asset-types.yaml
@@ -3,7 +3,7 @@ get:
    description: Returns the list of asset types to enable an adaptive UI.
    tags:
        - hs-hosting-asset-props
-    operationId: listAssetTypes
+    operationId: getListOfHostingAssetTypes
    responses:
        "200":
            description: OK
--- a/src/main/resources/api-definition/hs-hosting/hs-hosting-assets-with-uuid.yaml
+++ b/src/main/resources/api-definition/hs-hosting/hs-hosting-assets-with-uuid.yaml
@@ -2,7 +2,7 @@ get:
    tags:
        - hs-hosting-assets
    description: 'Fetch a single managed asset by its uuid, if visible for the current subject.'
-    operationId: getAssetByUuid
+    operationId: getSingleHostingAssetByUuid
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
@@ -30,7 +30,7 @@ patch:
    tags:
        - hs-hosting-assets
    description: 'Updates a single hosting asset identified by its uuid, if permitted for the current subject.'
-    operationId: patchAsset
+    operationId: patchHostingAsset
    parameters:
        -   $ref: 'auth.yaml#/components/parameters/currentSubject'
        -   $ref: 'auth.yaml#/components/parameters/assumedRoles'
@@ -61,7 +61,7 @@ delete:
    tags:
        - hs-hosting-assets
    description: 'Delete a single hosting asset identified by its uuid, if permitted for the current subject.'
-    operationId: deleteAssetUuid
+    operationId: deleteHostingAssetByUuid
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-hosting/hs-hosting-assets.yaml
+++ b/src/main/resources/api-definition/hs-hosting/hs-hosting-assets.yaml
@@ -3,7 +3,7 @@ get:
    description: Returns the list of all hosting assets which match the given filters and are visible to the current subject or any of it's assumed roles.
    tags:
        - hs-hosting-assets
-    operationId: listAssets
+    operationId: getListOfHostingAssets
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
@@ -45,7 +45,7 @@ post:
    summary: Adds a new hosting asset.
    tags:
        - hs-hosting-assets
-    operationId: addAsset
+    operationId: postNewHostingAsset
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-office/hs-office-bankaccounts-with-uuid.yaml
+++ b/src/main/resources/api-definition/hs-office/hs-office-bankaccounts-with-uuid.yaml
@@ -2,7 +2,7 @@ get:
    tags:
        - hs-office-bank-accounts
    description: 'Fetch a single bank account by its uuid, if visible for the current subject.'
-    operationId: getBankAccountByUuid
+    operationId: getSingleBankAccountByUuid
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-office/hs-office-bankaccounts.yaml
+++ b/src/main/resources/api-definition/hs-office/hs-office-bankaccounts.yaml
@@ -3,7 +3,7 @@ get:
    description: Returns the list of (optionally filtered) bankaccounts which are visible to the current subject or any of it's assumed roles.
    tags:
        - hs-office-bank-accounts
-    operationId: listBankAccounts
+    operationId: getListOfBankAccounts
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
@@ -31,7 +31,7 @@ post:
    summary: Adds a new bank account.
    tags:
        - hs-office-bank-accounts
-    operationId: addBankAccount
+    operationId: postNewBankAccount
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-office/hs-office-contacts-with-uuid.yaml
+++ b/src/main/resources/api-definition/hs-office/hs-office-contacts-with-uuid.yaml
@@ -2,7 +2,7 @@ get:
    tags:
        - hs-office-contacts
    description: 'Fetch a single business contact by its uuid, if visible for the current subject.'
-    operationId: getContactByUuid
+    operationId: getSingleContactByUuid
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-office/hs-office-contacts.yaml
+++ b/src/main/resources/api-definition/hs-office/hs-office-contacts.yaml
@@ -3,7 +3,7 @@ get:
    description: Returns the list of (optionally filtered) contacts which are visible to the current subject or any of it's assumed roles.
    tags:
        - hs-office-contacts
-    operationId: listContacts
+    operationId: getListOfContacts
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
@@ -31,7 +31,7 @@ post:
    summary: Adds a new contact.
    tags:
        - hs-office-contacts
-    operationId: addContact
+    operationId: postNewContact
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-office/hs-office-partners-with-uuid.yaml
+++ b/src/main/resources/api-definition/hs-office/hs-office-partners-with-uuid.yaml
@@ -2,7 +2,7 @@ get:
    tags:
        - hs-office-partners
    description: 'Fetch a single business partner by its uuid, if visible for the current subject.'
-    operationId: getPartnerByUuid
+    operationId: getSinglePartnerByUuid
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-office/hs-office-partners.yaml
+++ b/src/main/resources/api-definition/hs-office/hs-office-partners.yaml
@@ -3,7 +3,7 @@ get:
    description: Returns the list of (optionally filtered) business partners which are visible to the current subject or any of it's assumed roles.
    tags:
        - hs-office-partners
-    operationId: listPartners
+    operationId: getListOfPartners
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
@@ -31,7 +31,7 @@ post:
    summary: Adds a new business partner.
    tags:
        - hs-office-partners
-    operationId: addPartner
+    operationId: postNewPartner
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-office/hs-office-persons-with-uuid.yaml
+++ b/src/main/resources/api-definition/hs-office/hs-office-persons-with-uuid.yaml
@@ -2,7 +2,7 @@ get:
    tags:
        - hs-office-persons
    description: 'Fetch a single business person by its uuid, if visible for the current subject.'
-    operationId: getPersonByUuid
+    operationId: getSinglePersonByUuid
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-office/hs-office-persons.yaml
+++ b/src/main/resources/api-definition/hs-office/hs-office-persons.yaml
@@ -3,7 +3,7 @@ get:
    description: Returns the list of (optionally filtered) persons which are visible to the current subject or any of it's assumed roles.
    tags:
        - hs-office-persons
-    operationId: listPersons
+    operationId: getListOfPersons
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
@@ -31,7 +31,7 @@ post:
    summary: Adds a new person.
    tags:
        - hs-office-persons
-    operationId: addPerson
+    operationId: postNewPerson
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-office/hs-office-relations-with-uuid.yaml
+++ b/src/main/resources/api-definition/hs-office/hs-office-relations-with-uuid.yaml
@@ -2,7 +2,7 @@ get:
    tags:
        - hs-office-relations
    description: 'Fetch a single person relation by its uuid, if visible for the current subject.'
-    operationId: getRelationByUuid
+    operationId: getSingleRelationByUuid
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-office/hs-office-relations.yaml
+++ b/src/main/resources/api-definition/hs-office/hs-office-relations.yaml
@@ -5,7 +5,7 @@ get:
        To match data, all given query parameters must be fulfilled ('and' / logical conjunction).
    tags:
        - hs-office-relations
-    operationId: listRelations
+    operationId: getListOfRelations
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
@@ -52,7 +52,7 @@ post:
    summary: Adds a new person relation.
    tags:
        - hs-office-relations
-    operationId: addRelation
+    operationId: postNewRelation
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-office/hs-office-sepamandates-with-uuid.yaml
+++ b/src/main/resources/api-definition/hs-office/hs-office-sepamandates-with-uuid.yaml
@@ -2,7 +2,7 @@ get:
    tags:
        - hs-office-sepaMandates
    description: 'Fetch a single SEPA Mandate by its uuid, if visible for the current subject.'
-    operationId: getSepaMandateByUuid
+    operationId: getSingleSepaMandateByUuid
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/hs-office/hs-office-sepamandates.yaml
+++ b/src/main/resources/api-definition/hs-office/hs-office-sepamandates.yaml
@@ -3,7 +3,7 @@ get:
    description: Returns the list of (optionally filtered) SEPA Mandates which are visible to the current subject or any of it's assumed roles.
    tags:
        - hs-office-sepaMandates
-    operationId: listSepaMandatesByIBAN
+    operationId: getListOfSepaMandates
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
@@ -31,7 +31,7 @@ post:
    summary: Adds a new SEPA Mandate.
    tags:
        - hs-office-sepaMandates
-    operationId: addSepaMandate
+    operationId: postNewSepaMandate
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/rbac/rbac-grants-with-id.yaml
+++ b/src/main/resources/api-definition/rbac/rbac-grants-with-id.yaml
@@ -1,7 +1,7 @@
 get:
  tags:
    - rbac-grants
-  operationId: getGrantById
+  operationId: getListOfGrantsByUuid
  parameters:
    - $ref: 'auth.yaml#/components/parameters/currentSubject'
    - $ref: 'auth.yaml#/components/parameters/assumedRoles'
@@ -36,7 +36,7 @@ get:
 delete:
    tags:
        - rbac-grants
-    operationId: revokeRoleFromSubject
+    operationId: deleteRoleGrantFromSubject
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/rbac/rbac-grants.yaml
+++ b/src/main/resources/api-definition/rbac/rbac-grants.yaml
@@ -1,7 +1,7 @@
 get:
    tags:
        - rbac-grants
-    operationId: listSubjectGrants
+    operationId: getListOfSubjectGrants
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
@@ -18,7 +18,7 @@ get:
 post:
    tags:
        - rbac-grants
-    operationId: grantRoleToSubject
+    operationId: postNewRoleGrantToSubject
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/rbac/rbac-roles.yaml
+++ b/src/main/resources/api-definition/rbac/rbac-roles.yaml
@@ -1,7 +1,7 @@
 get:
    tags:
        - rbac-roles
-    operationId: listRoles
+    operationId: getListOfRoles
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/rbac/rbac-subjects-with-id-permissions.yaml
+++ b/src/main/resources/api-definition/rbac/rbac-subjects-with-id-permissions.yaml
@@ -2,7 +2,7 @@ get:
    tags:
        - rbac-subjects
    description: 'List all visible permissions granted to the given subject; reduced '
-    operationId: listSubjectPermissions
+    operationId: getListOfSubjectPermissions
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/rbac/rbac-subjects-with-uuid.yaml
+++ b/src/main/resources/api-definition/rbac/rbac-subjects-with-uuid.yaml
@@ -2,7 +2,7 @@ get:
    tags:
        - rbac-subjects
    description: 'Fetch a single subject by its id, if visible for the current subject.'
-    operationId: getSubjectById
+    operationId: getSingleSubjectByUuid
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
--- a/src/main/resources/api-definition/rbac/rbac-subjects.yaml
+++ b/src/main/resources/api-definition/rbac/rbac-subjects.yaml
@@ -2,7 +2,7 @@ get:
    tags:
        - rbac-subjects
    description: List accessible RBAC subjects with optional filter by name.
-    operationId: listSubjects
+    operationId: getListOfSubjects
    parameters:
        - $ref: 'auth.yaml#/components/parameters/currentSubject'
        - $ref: 'auth.yaml#/components/parameters/assumedRoles'
@@ -29,7 +29,7 @@ post:
    tags:
        - rbac-subjects
    description: Create a new RBAC subject (e.g. user).
-    operationId: createSubject
+    operationId: postNewSubject
    requestBody:
        required: true
        content:
--- a/src/main/resources/application.yml
+++ b/src/main/resources/application.yml
@@ -9,9 +9,11 @@ management:
        web:
            exposure:
                include: info, health, metrics
+    observations:
+        annotations:
+            enabled: true

 spring:
-
    datasource:
        driver-class-name: org.postgresql.Driver
        password: password
@@ -33,3 +35,11 @@ liquibase:
 hsadminng:
    postgres:
        leakproof:
+
+metrics:
+    distribution:
+        percentiles-histogram:
+            http:
+                server:
+                    requests: true
+