feat: 🎉 initialize project

Author: alebas1

.gitignore

@@ -0,0 +1,3 @@
+**/node_modules
+**/dist
+**/.DS_Store

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "stoplight.spectral"
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "javascript.preferences.importModuleSpecifierEnding": "js",
+    "typescript.preferences.importModuleSpecifierEnding": "js",
+    "spectral.rulesetFile": "docs/.spectral.yaml",
+}

docs/.spectral.yaml

@@ -0,0 +1,18 @@
+extends: "spectral:oas"
+rules:
+  examples-mandatory-on-primitive-objects:
+    severity: error
+    description: |
+      This rule ensures that all primitive types have an example value.
+    given: $..[?(@.type == 'string' || @.type == 'number' || @.type == 'integer' || @.type == 'boolean' || @.type == 'null')]
+    then:
+      field: example
+      function: truthy
+  no-examples-on-non-primitives-objects:
+    severity: error
+    description: |
+      This rule ensures that non primitive types do not have an example value.
+    given: $..[?(@.type == 'object' || @.type == 'array')]
+    then:
+      field: example
+      function: falsy

docs/openapi-spec.yaml

@@ -0,0 +1,47 @@
+openapi: 3.0.3
+info:
+  title: Simple fastify API
+  description: A simple API built with Fastify.
+  version: '0.0.0'
+  contact:
+    email: lebas.axel@gmail.com
+servers:
+  - url: 'http://localhost:8080'
+    description: Local
+tags:
+  - name: health
+    description: API Health checks
+paths:
+  /health:
+    get:
+      summary: Health check
+      description: Check the health of the API.
+      operationId: health
+      tags:
+        - health
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Health'
+components:
+  schemas:
+    Health:
+      type: object
+      properties:
+        status:
+          type: string
+          example: ok
+          description: The status of the API
+          enum:
+            - ok
+        uptime:
+          type: integer
+          format: int64
+          description: The uptime of the API in seconds
+          example: 60
+      required:
+        - status
+        - uptime