Merge pull request #144 from bcgov/release/v0.4.0

Release COMS v0.4.0
bcgov · Mar 16, 2023 · 5683ef4 · 5683ef4
2 parents 63f4971 + c6f441f
commit 5683ef4
Show file tree

Hide file tree

Showing 8 changed files with 49 additions and 33 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -10,6 +10,11 @@ assignees: ''
 #### Describe the bug
 <!-- A clear and concise description of what the bug is. -->
 
+#### Version Number
+<!-- The specific application version you are currently using. -->
+<!-- This can be found by visiting the root of the application. -->
+<!-- Please include the `app.gitRev` and the `app.version`. -->
+
 #### To Reproduce
 
 Steps to reproduce the behavior:

diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -10,6 +10,11 @@ assignees: ''
 #### Is your feature request related to a problem? Please describe.
 <!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
 
+#### Version Number
+<!-- The specific application version you are currently using. -->
+<!-- This can be found by visiting the root of the application. -->
+<!-- Please include the `app.gitRev` and the `app.version`. -->
+
 #### Describe the solution you'd like
 <!-- A clear and concise description of what you want to happen. -->
 

diff --git a/SECURITY.md b/SECURITY.md
@@ -14,8 +14,8 @@ At this time, only the latest version of Common Object Management Service is sup
 
 | Version | Supported          |
 | ------- | ------------------ |
-| 0.3.0   | :white_check_mark: |
-| < 0.3.x | :x:                |
+| 0.4.0   | :white_check_mark: |
+| < 0.4.x | :x:                |
 
 ## Reporting a Bug
 

diff --git a/app/package-lock.json b/app/package-lock.json
diff --git a/app/package.json b/app/package.json
@@ -1,6 +1,6 @@
 {
   "name": "common-object-management-service",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "private": true,
   "description": "",
   "author": "NR Common Service Showcase <[email protected]>",

diff --git a/app/src/docs/v1.api-spec.yaml b/app/src/docs/v1.api-spec.yaml
@@ -67,7 +67,11 @@ paths:
   /bucket:
     put:
       summary: Creates a bucket
-      description: Creates a bucket in the COMS database. Bucket should exist in S3.
+      description: >-
+        Creates a bucket record. Bucket should exist in S3. If the set of
+        `bucket`, `endpoint` and `key` match an existing record, the user will
+        be added to that existing bucket with full permissions instead of
+        generating a new bucket record.
       operationId: createBucket
       tags:
         - Bucket
@@ -100,8 +104,8 @@ paths:
     get:
       summary: Search for buckets
       description: >-
-        Returns a list of buckets matching all search criteria across all known
-        versions of buckets.
+        Returns a list of buckets matching all search criteria across all bucket
+        records
       operationId: searchBuckets
       tags:
         - Bucket
@@ -143,7 +147,7 @@ paths:
           $ref: "#/components/responses/Error"
     get:
       summary: Returns a bucket
-      description: Returns a bucket based on bucketId
+      description: Returns a bucket record based on bucketId
       operationId: readBucket
       tags:
         - Bucket
@@ -162,7 +166,7 @@ paths:
           $ref: "#/components/responses/Error"
     patch:
       summary: Updates a bucket
-      description: Returns updated bucket
+      description: Updates the bucket record
       operationId: updateBucket
       tags:
         - Bucket
@@ -188,7 +192,10 @@ paths:
           $ref: "#/components/responses/Error"
     delete:
       summary: Deletes a bucket
-      description: Deletes the bucket based on bucketId
+      description: >-
+        Deletes the bucket record based on bucketId. This request does not
+        dispatch an S3 operation to request the deletion of the associated
+        bucket.
       operationId: deleteBucket
       tags:
         - Bucket
@@ -332,8 +339,8 @@ paths:
         - $ref: "#/components/parameters/Path-ObjectId"
         - $ref: "#/components/parameters/Query-Download"
         - $ref: "#/components/parameters/Query-ExpiresIn"
-        - $ref: "#/components/parameters/Query-VersionId"
         - $ref: "#/components/parameters/Query-S3VersionId"
+        - $ref: "#/components/parameters/Query-VersionId"
       responses:
         "200":
           description: Returns the object
@@ -392,8 +399,8 @@ paths:
         - Object
       parameters:
         - $ref: "#/components/parameters/Path-ObjectId"
-        - $ref: "#/components/parameters/Query-VersionId"
         - $ref: "#/components/parameters/Query-S3VersionId"
+        - $ref: "#/components/parameters/Query-VersionId"
       responses:
         "204":
           description: Returns object headers
@@ -565,8 +572,8 @@ paths:
       parameters:
         - $ref: "#/components/parameters/Header-Metadata"
         - $ref: "#/components/parameters/Path-ObjectId"
-        - $ref: "#/components/parameters/Query-VersionId"
         - $ref: "#/components/parameters/Query-S3VersionId"
+        - $ref: "#/components/parameters/Query-VersionId"
       responses:
         "204":
           $ref: "#/components/responses/NoContent"
@@ -590,8 +597,8 @@ paths:
       parameters:
         - $ref: "#/components/parameters/Header-Metadata"
         - $ref: "#/components/parameters/Path-ObjectId"
-        - $ref: "#/components/parameters/Query-VersionId"
         - $ref: "#/components/parameters/Query-S3VersionId"
+        - $ref: "#/components/parameters/Query-VersionId"
       responses:
         "204":
           $ref: "#/components/responses/NoContent"
@@ -617,8 +624,8 @@ paths:
       parameters:
         - $ref: "#/components/parameters/Header-Metadata"
         - $ref: "#/components/parameters/Path-ObjectId"
-        - $ref: "#/components/parameters/Query-VersionId"
         - $ref: "#/components/parameters/Query-S3VersionId"
+        - $ref: "#/components/parameters/Query-VersionId"
       responses:
         "204":
           $ref: "#/components/responses/NoContent"
@@ -640,8 +647,8 @@ paths:
       parameters:
         - $ref: "#/components/parameters/Path-ObjectId"
         - $ref: "#/components/parameters/Query-TagSet"
-        - $ref: "#/components/parameters/Query-VersionId"
         - $ref: "#/components/parameters/Query-S3VersionId"
+        - $ref: "#/components/parameters/Query-VersionId"
       responses:
         "204":
           $ref: "#/components/responses/NoContent"
@@ -664,8 +671,8 @@ paths:
       parameters:
         - $ref: "#/components/parameters/Path-ObjectId"
         - $ref: "#/components/parameters/Query-TagSet"
-        - $ref: "#/components/parameters/Query-VersionId"
         - $ref: "#/components/parameters/Query-S3VersionId"
+        - $ref: "#/components/parameters/Query-VersionId"
       responses:
         "204":
           $ref: "#/components/responses/NoContent"
@@ -689,8 +696,8 @@ paths:
       parameters:
         - $ref: "#/components/parameters/Path-ObjectId"
         - $ref: "#/components/parameters/Query-TagSet"
-        - $ref: "#/components/parameters/Query-VersionId"
         - $ref: "#/components/parameters/Query-S3VersionId"
+        - $ref: "#/components/parameters/Query-VersionId"
       responses:
         "204":
           $ref: "#/components/responses/NoContent"
@@ -2051,7 +2058,7 @@ components:
             The unique identifier for the bucket. When `objectPerms=true`
             response will include buckets containing objects with matching
             permissions.
-          example: bf246e31-c807-496c-bc93-cd8bc2f1897hf
+          example: bf246e31-c807-496c-bc93-cd8bc2f1897f
         permissions:
           type: array
           items:
@@ -2135,10 +2142,9 @@ components:
           type: boolean
           example: true
         s3VersionId:
-          type: integer
-          format: int32
-          description: a version identifier created in S3
-          example: 1647462569641
+          type: string
+          description: A version identifier created in S3
+          example: "1647462569641"
     Response-ObjectDetails:
       title: Response Object Details
       type: object
@@ -2277,7 +2283,7 @@ components:
                   value:
                     type: object
                     description: Contents of the field that was in error.
-                    example: utf-8x
+                    example: {}
                   message:
                     type: string
                     description: The error message for the field.
@@ -2297,7 +2303,7 @@ components:
         s3VersionId:
           type: string
           description: a version identifier created in S3
-          example: 1647462569641
+          example: "1647462569641"
     S3-Metadata:
       title: S3 Metadata
       type: object
@@ -2357,8 +2363,8 @@ components:
           example: AES256
         s3VersionId:
           type: string
-          description: a version identifier created in S3
-          example: 1647462569641
+          description: A version identifier created in S3
+          example: "1647462569641"
     S3-Version:
       title: S3 Version
       type: object
@@ -2387,8 +2393,8 @@ components:
           description: Key of the object
         s3VersionId:
           type: string
-          description: a version identifier created in S3
-          example: 1647462569641
+          description: A version identifier created in S3
+          example: "1647462569641"
         IsLatest:
           description: >-
             Specifies whether the object is (true) or is not (false) the latest

diff --git a/charts/coms/Chart.yaml b/charts/coms/Chart.yaml
@@ -3,7 +3,7 @@ name: common-object-management-service
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.0.10
+version: 0.0.11
 kubeVersion: ">= 1.13.0"
 description: A microservice for managing access control to S3 Objects
 # A chart can be either an 'application' or a 'library' chart.
@@ -43,6 +43,6 @@ maintainers:
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "0.3.0"
+appVersion: "0.4.0"
 deprecated: false
 annotations: {}
diff --git a/charts/coms/README.md b/charts/coms/README.md
@@ -1,6 +1,6 @@
 # common-object-management-service
 
-![Version: 0.0.9](https://img.shields.io/badge/Version-0.0.9-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.3.0](https://img.shields.io/badge/AppVersion-0.3.0-informational?style=flat-square)
+![Version: 0.0.11](https://img.shields.io/badge/Version-0.0.11-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.4.0](https://img.shields.io/badge/AppVersion-0.4.0-informational?style=flat-square)
 
 A microservice for managing access control to S3 Objects