docs: updated specification (#30)

* docs: fixed responses for update password and challenge

* docs: added specification for new uses case of retrieving a user UUID by its username

* chore(release): 0.0.16

CHANGELOG.md

@@ -2,6 +2,21 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.0.16](https://github.com/hawks-atlanta/authentication-go/compare/v0.0.5...v0.0.16) (2023-08-30)
+
+
+### Features
+
+* v0.0.10 ([#12](https://github.com/hawks-atlanta/authentication-go/issues/12)) ([96549ef](https://github.com/hawks-atlanta/authentication-go/commit/96549eff4bb24932dec1fca949692bf5efe1395d))
+* v0.0.7 ([#8](https://github.com/hawks-atlanta/authentication-go/issues/8)) ([e9a8acd](https://github.com/hawks-atlanta/authentication-go/commit/e9a8acdf6d14be40ed3c05f62b71de28bab8ad83)), closes [#5](https://github.com/hawks-atlanta/authentication-go/issues/5) [#6](https://github.com/hawks-atlanta/authentication-go/issues/6) [#7](https://github.com/hawks-atlanta/authentication-go/issues/7)
+
+
+### Bug Fixes
+
+* fmt ([1653f19](https://github.com/hawks-atlanta/authentication-go/commit/1653f198fcbed059d14a657afe3b553983e5f531))
+* removed line ([#15](https://github.com/hawks-atlanta/authentication-go/issues/15)) ([6b3899f](https://github.com/hawks-atlanta/authentication-go/commit/6b3899f5c8a3da1f15c0522b452f5dc5a326a601))
+* triggering pipeline ([f1e7475](https://github.com/hawks-atlanta/authentication-go/commit/f1e7475f6d5595c5bcc656136ef6093ff647dcfc))
+
 ### 0.0.15 (2023-08-26)
 
 ### 0.0.14 (2023-08-26)

docs/spec.openapi.yaml

@@ -37,13 +37,13 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/error'
+                $ref: '#/components/schemas/statusResponse'
         '500':
           description: Internal error
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/error'
+                $ref: '#/components/schemas/statusResponse'
   /register:
     post:
       tags:
@@ -66,13 +66,13 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/error'
+                $ref: '#/components/schemas/statusResponse'
         '500':
           description: Internal error
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/error'
+                $ref: '#/components/schemas/statusResponse'
   /challenge:
     post:
       tags:
@@ -89,19 +89,19 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/authorization'
+                $ref: '#/components/schemas/account'
         '401':
           description: Unauthorized
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/error'
+                $ref: '#/components/schemas/statusResponse'
         '500':
           description: Internal error
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/error'
+                $ref: '#/components/schemas/statusResponse'
 
   /account/password:
     patch:
@@ -126,27 +126,64 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/authorization'
+                $ref: '#/components/schemas/statusResponse'
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/statusResponse'
+        '500':
+          description: Internal error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/statusResponse'
+  /user/uuid/{username}:
+    get:
+      tags:
+        - Account
+      description: Obtain the uuid of an user by its username
+      parameters:
+        - in: path
+          name: username
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: User uuid
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/account'
         '401':
           description: Unauthorized
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/error'
+                $ref: '#/components/schemas/statusResponse'
         '500':
           description: Internal error
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/error'
+                $ref: '#/components/schemas/statusResponse'
 
 components:
   schemas:
-    error:
+    account:
+      type: object
+      properties:
+        uuid:
+          type: string
+    statusResponse:
       type: object
       properties:
         msg:
           type: string
+        succeed:
+          type: boolean
     credentials:
       type: object
       properties:

package.json

@@ -3,5 +3,5 @@
 		"git-semver-tags": "^4.1.1",
 		"standard-version": "^9.5.0"
 	},
-	"version": "0.0.15"
+	"version": "0.0.16"
 }