feat(specification-storage): implement endpoint to fetch specifications

Closes: MRSPECS-3

Dockerfile

@@ -4,8 +4,8 @@ USER root
 RUN apk upgrade --no-cache
 USER folio
 
-ENV APP_FILE mod-record-specifications-fat.jar
-ARG JAR_FILE=./mod-record-specifications-server/target/mod-record-specifications-server-1.0.0-SNAPSHOT.jar
+ENV APP_FILE mod-record-specifications-server-fat.jar
+ENV JAR_FILE=mod-record-specifications-server/target/${APP_FILE}
 COPY ${JAR_FILE} ${JAVA_APP_DIR}/${APP_FILE}
 
 EXPOSE 8081

api/examples/response/unknownErrorResponse.yaml

@@ -0,0 +1,6 @@
+value:
+  errors:
+    - message: "Illegal argument error"
+      type: "IllegalArgumentException"
+      code: "unknown_error"
+  total_records: 1

api/examples/response/validationErrorResponse.yaml

@@ -0,0 +1,10 @@
+value:
+  errors:
+    - message: "must not be null"
+      type: "MethodArgumentNotValidException"
+      code: "validation_error"
+      parameters:
+        - key: "parameter"
+          value: "null"
+  total_records: 1
+

api/mod-record-specifications.yaml

@@ -25,28 +25,10 @@ servers:
           - snapshot-2
 
 tags:
-  - name: tag
-    description: Tag description
+  - name: specifications
+    description: Provides API for managing specifications.
 
 
 paths:
-  /stub:
-    get:
-      summary: Stub
-      description: New endpoint
-      tags:
-        - tag
-      operationId: stub
-      responses:
-        '200':
-          description: New response
-          content:
-            application/json:
-              schema:
-                title: StubObject
-                type: object
-                properties:
-                  id:
-                    type: string
-                    format: uuid
-
+  /specification-storage/specifications:
+    $ref: 'paths/specification-storage/get-specifications-path.yaml'

api/parameters/limit-param.yaml

@@ -0,0 +1,8 @@
+in: query
+name: limit
+description: Limit the number of elements returned in the response.
+schema:
+  type: integer
+  minimum: 0
+  maximum: 500
+  default: 100

api/parameters/offset-param.yaml

@@ -0,0 +1,8 @@
+in: query
+name: offset
+description: Skip over a number of elements by specifying an offset value for the query.
+schema:
+  type: integer
+  minimum: 0
+  maximum: 9999
+  default: 0

api/paths/specification-storage/get-specifications-path.yaml

@@ -0,0 +1,40 @@
+get:
+  summary: Get Specifications
+  description: Get a collection of specifications.
+  operationId: getSpecifications
+  tags:
+    - specifications
+  security:
+    - ApiKeyAuth: [ ]
+  parameters:
+    - in: query
+      name: family
+      description: Filter by specification's family.
+      schema:
+        $ref: '../../schemas/family.yaml'
+    - in: query
+      name: profile
+      description: Filter by specification's family profile.
+      schema:
+        $ref: '../../schemas/familyProfile.yaml'
+    - in: query
+      name: include
+      description: Limit the number of elements returned in the response.
+      schema:
+        type: string
+        enum:
+          - all
+          - required-fields
+    - $ref: '../../parameters/limit-param.yaml'
+    - $ref: '../../parameters/offset-param.yaml'
+  responses:
+    '200':
+      description: Collection of specifications
+      content:
+        application/json:
+          schema:
+            $ref: '../../schemas/specificationCollection.yaml'
+    '400':
+      $ref: '../../responses/badRequestResponse.yaml'
+    '500':
+      $ref: '../../responses/internalServerErrorResponse.yaml'

api/responses/badRequestResponse.yaml

@@ -0,0 +1,8 @@
+description: Validation errors
+content:
+  application/json:
+    schema:
+      $ref: "../schemas/common/errorCollection.yaml"
+    examples:
+      validationErrorResponse:
+        $ref: "../examples/response/validationErrorResponse.yaml"

api/responses/internalServerErrorResponse.yaml

@@ -0,0 +1,8 @@
+description: When unhandled exception occurred during code execution, e.g. NullPointerException.
+content:
+  application/json:
+    schema:
+      $ref: "../schemas/common/errorCollection.yaml"
+    examples:
+      unknownError:
+        $ref: "../examples/response/unknownErrorResponse.yaml"

api/schemas/common/error.yaml

@@ -0,0 +1,16 @@
+description: An error
+type: object
+properties:
+  message:
+    type: string
+    description: Error message text
+  type:
+    type: string
+    description: Error message type
+  code:
+    type: string
+    description: Error message code
+  parameters:
+    type: array
+    items:
+      $ref: 'parameter.yaml'

api/schemas/common/errorCollection.yaml

@@ -0,0 +1,18 @@
+description: A List of errors
+type: object
+properties:
+  errors:
+    description: List of errors
+    type: array
+    items:
+      $ref: 'error.yaml'
+  totalRecords:
+    description: Total number of errors
+    type: integer
+example:
+  errors:
+    - message: Illegal argument error
+      type: IllegalArgumentException
+      code: unknown_error
+  total_records: 1
+

api/schemas/common/metadata.yaml

@@ -0,0 +1,17 @@
+description: Creater, updater, creation date, last updated date
+type: object
+properties:
+  createdDate:
+    description: Date and time when the record was created
+    type: string
+  createdByUserId:
+    description: ID of the user who created the record (when available)
+    type: string
+    format: uuid
+  updatedDate:
+    description: Date and time when the record was last updated
+    type: string
+  updatedByUserId:
+    description: ID of the user who last updated the record (when available)
+    type: string
+    format: uuid

api/schemas/common/parameter.yaml

@@ -0,0 +1,12 @@
+description: List of key/value parameters of an error
+type: object
+properties:
+  key:
+    description: Parameter key
+    type: string
+  value:
+    description: Parameter value
+    type: string
+example:
+  key: source
+  value: null

api/schemas/family.yaml

@@ -0,0 +1,3 @@
+type: string
+enum:
+  - MARC

api/schemas/familyProfile.yaml

@@ -0,0 +1,4 @@
+type: string
+enum:
+  - authority
+  - bibliographic

api/schemas/specification.yaml

@@ -0,0 +1,17 @@
+type: object
+x-parent: "abstract"
+properties:
+  id:
+    type: string
+    format: uuid
+  title:
+    type: string
+  family:
+    $ref: 'family.yaml'
+  profile:
+    $ref: 'familyProfile.yaml'
+  url:
+    type: string
+    format: url
+  metadata:
+    $ref: 'common/metadata.yaml'

api/schemas/specificationCollection.yaml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  specifications:
+    type: array
+    items:
+      oneOf:
+        - $ref: 'specification.yaml'
+        - $ref: 'specificationFull.yaml'
+  totalRecords:
+    type: integer

api/schemas/specificationFull.yaml

@@ -0,0 +1,12 @@
+allOf:
+  - $ref: 'specification.yaml'
+  - type: object
+    properties:
+      fields:
+        type: array
+        items:
+          type: object
+      rules:
+        type: array
+        items:
+          type: object

descriptors/DeploymentDescriptor-template.json

@@ -2,7 +2,7 @@
   "srvcId": "@artifactId@-@version@",
   "nodeId": "localhost",
   "descriptor": {
-    "exec": "java -Dport=%p -jar ../mod-record-specifications/target/mod-record-specifications-fat.jar -Dhttp.port=%p embed_postgres=true"
+    "exec": "java -Dport=%p -jar ../mod-record-specifications/mod-record-specifications-server/target/mod-record-specifications-fat.jar -Dhttp.port=%p"
   }
 }
 

descriptors/ModuleDescriptor-template.json

@@ -2,6 +2,21 @@
   "id": "@artifactId@-@version@",
   "name": "Record Specifications",
   "provides": [
+    {
+      "id": "specification-storage",
+      "version": "1.0",
+      "handlers": [
+        {
+          "methods": [
+            "GET"
+          ],
+          "pathPattern": "/specification-storage/specifications",
+          "permissionsRequired": [
+            "specification-storage.specifications.collection.get"
+          ]
+        }
+      ]
+    },
     {
       "id": "_tenant",
       "version": "2.0",
@@ -24,6 +39,19 @@
     }
   ],
   "permissionSets": [
+    {
+      "permissionName": "specification-storage.specifications.collection.get",
+      "displayName": "Specification Storage - Get specification collection",
+      "description": "Get specification collection"
+    },
+    {
+      "permissionName": "specification-storage.all",
+      "displayName": "Specification Storage - All permissions",
+      "description": "Entire set of permissions needed to manage specifications",
+      "subPermissions": [
+        "specification-storage.specifications.collection.get"
+      ]
+    }
   ],
   "launchDescriptor": {
     "dockerImage": "@artifactId@:@version@",

mod-record-specifications-dto/pom.xml

@@ -29,6 +29,10 @@
       <artifactId>jackson-databind-nullable</artifactId>
       <scope>provided</scope>
     </dependency>
+    <dependency>
+      <groupId>org.springframework</groupId>
+      <artifactId>spring-context</artifactId>
+    </dependency>
     <dependency>
       <groupId>org.openapitools</groupId>
       <artifactId>openapi-generator</artifactId>
@@ -66,21 +70,10 @@
               <configOptions>
                 <library>spring-boot</library>
                 <useSpringBoot3>true</useSpringBoot3>
+                <sourceFolder>model</sourceFolder>
               </configOptions>
             </configuration>
           </execution>
-          <execution>
-            <id>Client generation</id>
-            <goals>
-              <goal>generate</goal>
-            </goals>
-            <configuration>
-              <inputSpec>${project.parent.basedir}/${openapi.input.file}</inputSpec>
-              <output>${project.build.directory}/generated-sources</output>
-              <modelPackage>${project.groupId}.rspec.domain.dto</modelPackage>
-              <generatorName>mysql-schema</generatorName>
-            </configuration>
-          </execution>
         </executions>
       </plugin>
 
@@ -96,7 +89,7 @@
             </goals>
             <configuration>
               <sources>
-                <source>${project.build.directory}/generated-sources/src/main/java</source>
+                <source>${project.build.directory}/generated-sources/model</source>
               </sources>
             </configuration>
           </execution>