Various adjustments based on PO feedback

Author: mweaver-ebsco

fqm-config.toml

@@ -51,3 +51,19 @@ schema = "src/main/resources/fqm/schemas/noteType.yaml"
 permissions = ["note.types.collection.get"]
 sort = ["id", "ASC"]
 includeJsonbField = false
+
+[entityTypes.fieldOverrides.metadata_created_date]
+x-fqm-visible-by-default = false
+x-fqm-essential = false
+
+[entityTypes.fieldOverrides.metadata_created_by_user_id]
+x-fqm-visible-by-default = false
+x-fqm-essential = false
+
+[entityTypes.fieldOverrides.metadata_updated_date]
+x-fqm-visible-by-default = false
+x-fqm-essential = false
+
+[entityTypes.fieldOverrides.metadata_updated_by_user_id]
+x-fqm-visible-by-default = false
+x-fqm-essential = false

src/main/resources/fqm/schemas/link.yaml

@@ -8,15 +8,20 @@ properties:
     $ref: '../../swagger.api/schemas/common.yaml#/uuid'
     description: UUID primary key of the link row; used by note_link.link_id
     x-fqm-value-getter: ${source}.id
-    x-fqm-is-id-column: true # Despite the name, this is the unique ID for the link record itself.
-    x-fqm-visibility: "all"
+    x-fqm-is-id-column: true
+    x-fqm-visibility: "hidden"
     x-fqm-visible-by-default: true
     x-fqm-essential: true
-  id:
+    x-fqm-joins-to:
+      - targetModule: mod-notes
+        targetEntity: link
+        targetField: link_id
+        type: equality-cast-uuid
+  objectId:
     $ref: '../../swagger.api/schemas/link.yaml#/link/properties/id'
   type:
     $ref: '../../swagger.api/schemas/link.yaml#/link/properties/type'
 required:
   - linkId
-  - id
+  - objectId
   - type

src/main/resources/fqm/schemas/noteLink.yaml

@@ -9,9 +9,9 @@ properties:
     description: UUID of the associated note
     x-fqm-value-getter: ${source}.note_id
     x-fqm-is-id-column: true # There are 2 ID columns here, matching the table's primary key.
-    x-fqm-visibility: "all"
+    x-fqm-visibility: "hidden"
     x-fqm-essential: true
-    x-fqm-visible-by-default: true
+    x-fqm-visible-by-default: false
     x-fqm-joins-to:
       - targetModule: mod-notes
         targetEntity: note
@@ -22,9 +22,9 @@ properties:
     description: UUID of the associated link
     x-fqm-value-getter: ${source}.link_id
     x-fqm-is-id-column: true # There are 2 ID columns here, matching the table's primary key.
-    x-fqm-visibility: "all"
+    x-fqm-visibility: "hidden"
     x-fqm-essential: true
-    x-fqm-visible-by-default: true
+    x-fqm-visible-by-default: false
     x-fqm-joins-to:
       - targetModule: mod-notes
         targetEntity: link

src/main/resources/swagger.api/schemas/common.yaml

@@ -13,13 +13,24 @@ metadata:
       description: Date and time when the record was created
       x-fqm-value-getter: to_char(${source}.created_date, 'YYYY-MM-DD"T"HH24:MI:SS.MS"Z"')
       x-fqm-visibility: "all"
+      x-fqm-visible-by-default: true
       x-fqm-essential: true
     createdByUserId:
       $ref: '#/uuid'
       description: ID of the user who created the record
       x-fqm-value-getter: ${source}.created_by
       x-fqm-visibility: "all"
+      x-fqm-visible-by-default: false
       x-fqm-essential: true
+      x-fqm-joins-to-raw:
+        - targetId: bb058933-cd06-4539-bd3a-6f248ff98ee2
+          targetField: id
+          direction: left
+          type: equality-cast-uuid
+        - targetId: f2615ea6-450b-425d-804d-6a495afd9308
+          targetField: id
+          direction: left
+          type: equality-cast-uuid
     createdByUsername:
       type: string
       description: Username of the user who created the record (when available)
@@ -34,13 +45,24 @@ metadata:
       description: Date and time when the record was last updated
       x-fqm-value-getter: to_char(${source}.updated_date, 'YYYY-MM-DD"T"HH24:MI:SS.MS"Z"')
       x-fqm-visibility: "all"
+      x-fqm-visible-by-default: false
       x-fqm-essential: true
     updatedByUserId:
       $ref: '#/uuid'
       description: ID of the user who last updated the record
       x-fqm-value-getter: ${source}.updated_by
       x-fqm-visibility: "all"
+      x-fqm-visible-by-default: false
       x-fqm-essential: true
+      x-fqm-joins-to-raw:
+        - targetId: bb058933-cd06-4539-bd3a-6f248ff98ee2
+          targetField: id
+          direction: left
+          type: equality-cast-uuid
+        - targetId: f2615ea6-450b-425d-804d-6a495afd9308
+          targetField: id
+          direction: left
+          type: equality-cast-uuid
     updatedByUsername:
       type: string
       description: Username of the user who updated the record (when available)

src/main/resources/swagger.api/schemas/link.yaml

@@ -8,13 +8,13 @@ link:
       description: Id of object linked to note
       x-fqm-value-getter: ${source}.object_id
       x-fqm-is-id-column: false # Despite the name, this is not the unique ID for the link record.
-      x-fqm-visibility: "all"
+      x-fqm-visibility: "hidden"
       x-fqm-essential: true
     type:
       type: string
       description: Type of object linked to note
       x-fqm-value-getter: ${source}.object_type
-      x-fqm-visibility: "all"
+      x-fqm-visibility: "hidden"
       x-fqm-essential: true
   required:
     - id

src/main/resources/swagger.api/schemas/note.yaml

@@ -8,14 +8,14 @@ note:
       x-fqm-value-getter: ${source}.id
       x-fqm-filter-value-getter: ${source}.id
       x-fqm-visibility: "all"
-      x-fqm-visible-by-default: true
+      x-fqm-visible-by-default: false
       x-fqm-essential: true
     typeId:
       $ref: 'common.yaml#/uuid'
       description: Type id of note
       x-fqm-value-getter: ${source}.type_id
       x-fqm-filter-value-getter: ${source}.type_id
-      x-fqm-visibility: "all"
+      x-fqm-visibility: "hidden"
       x-fqm-essential: true
       x-fqm-joins-to:
         - targetModule: mod-notes
@@ -31,27 +31,32 @@ note:
       x-fqm-value-getter: ${source}.title
       x-fqm-visibility: "all"
       x-fqm-visible-by-default: true
+      x-fqm-essential: true
     domain:
       type: string
       description: Domain associated with this note
       x-fqm-value-getter: ${source}.domain
       x-fqm-visibility: "all"
       x-fqm-visible-by-default: true
+      x-fqm-essential: true
     content:
       type: string
       description: Content of the note
       x-fqm-value-getter: ${source}.content
       x-fqm-visibility: "all"
+      x-fqm-essential: true
     popUpOnCheckOut:
       type: boolean
       description: Flag that specify need of pop-up on check-out app
       x-fqm-value-getter: ${source}.pop_up_on_check_out
       x-fqm-visibility: "all"
+      x-fqm-essential: true
     popUpOnUser:
       type: boolean
       description: Flag that specify need of pop-up on users app
       x-fqm-value-getter: ${source}.pop_up_on_user
       x-fqm-visibility: "all"
+      x-fqm-essential: true
     links:
       type: array
       description: Collection of links to associated objects

src/main/resources/swagger.api/schemas/noteType.yaml

@@ -7,7 +7,7 @@ noteType:
       $ref: 'common.yaml#/uuid'
       description: A UUID identifying this note type
       x-fqm-value-getter: ${source}.id
-      x-fqm-visibility: "all"
+      x-fqm-visibility: "hidden"
       x-fqm-essential: true
     name:
       type: string

translations/mod-notes/en.json

@@ -15,7 +15,7 @@
   "fqm.entityType.link": "Link",
   "fqm.entityType.link._description": "Link records used by notes.",
   "fqm.entityType.link.link_id": "Link UUID",
-  "fqm.entityType.link.id": "Linked record ID",
+  "fqm.entityType.link.object_id": "Linked record ID",
   "fqm.entityType.link.type": "Linked record type",
   "fqm.entityType.note_link": "Note link",
   "fqm.entityType.note_link._description": "Relationships between notes and link records.",