From 462419401a3a105c914fca4a081bfdf7025b48ba Mon Sep 17 00:00:00 2001
From: Tom Winter <tom@aam-digital.com>
Date: Tue, 19 Nov 2024 09:40:34 +0100
Subject: [PATCH] docs: add skill-api-v1.yaml

---
 docs/api-specs/skill-api-v1.yaml | 99 ++++++++++++++++++++++++++++++++
 1 file changed, 99 insertions(+)
 create mode 100644 docs/api-specs/skill-api-v1.yaml

diff --git a/docs/api-specs/skill-api-v1.yaml b/docs/api-specs/skill-api-v1.yaml
new file mode 100644
index 0000000..d8766ba
--- /dev/null
+++ b/docs/api-specs/skill-api-v1.yaml
@@ -0,0 +1,99 @@
+openapi: 3.0.3
+info:
+  title: Skill API
+  description: REST API for handling skill and user profile mapping.
+  version: 1.0.0
+servers:
+  - url: /v1/skill
+
+paths:
+  /user-profile:
+    get:
+      summary: Return all UserProfile
+      description: todo
+      parameters:
+        - name: fullName
+          in: query
+          required: false
+          schema:
+            type: string
+            description: Optional fullName filter
+        - name: email
+          in: query
+          required: false
+          schema:
+            type: string
+            description: Optional email filter
+        - name: phone
+          in: query
+          required: false
+          schema:
+            type: string
+            description: Optional phone filter
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/UserProfile'
+
+  /user-profile/{userProfileId}:
+    get:
+      summary: Return all UserProfile
+      description: todo
+      parameters:
+        - name: userProfileId
+          in: path
+          required: true
+          schema:
+            type: string
+            format: UUID
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserProfile'
+
+components:
+  schemas:
+    UserProfile:
+      type: object
+      properties:
+        id:
+          type: string
+          format: uuid
+        fullName:
+          type: string
+        phone:
+          type: string
+        email:
+          type: string
+        skills:
+          type: array
+          items:
+            $ref: '#/components/schemas/Skill'
+        updatedAtExternalSystem:
+          type: string
+        importedAt:
+          type: string
+        latestSyncAt:
+          type: string
+
+    Skill:
+      type: object
+      properties:
+        escoUri:
+          type: string
+        usage:
+          type: string
+          enum:
+            - ALMOST_NEVER
+            - SOMETIMES
+            - OFTEN
+            - ALMOST_ALWAYS
+            - ALWAYS