begin alignment with new API

NREL · Dec 4, 2023 · 0d47b9a · 0d47b9a
1 parent 99540f3
commit 0d47b9a
Show file tree

Hide file tree

Showing 5 changed files with 415 additions and 252 deletions.
diff --git a/alfalfa_web/components.yml b/alfalfa_web/components.yml
@@ -0,0 +1,73 @@
+components:
+  schemas:
+    runId:
+      type: string
+    pointId:
+      type: string
+      format: uuid
+    pointName:
+      type: string
+      default: Outdoor Air Temperature Sensor
+    pointType:
+      type: string
+      enum:
+        - "input"
+        - "output"
+        - "bidirectional"
+    runMetadata:
+      type: object
+      properties:
+        id:
+          $ref: "#/components/schemas/runId"
+    pointMetadata:
+      type: object
+      properties:
+        id:
+          $ref: "#/components/schemas/pointId"
+        name:
+          $ref: "#/components/schemas/pointName"
+        description:
+          type: string
+          default: An outdoor air temperature sensor for an air handling unit
+          readOnly: true
+        unit:
+          type: string
+          default: °F
+          readOnly: true
+        min:
+          type: number
+          readOnly: true
+        max:
+          type: number
+        type:
+          $ref: "#/components/schemas/pointType"
+      required:
+        - id
+        - type
+    pointValue:
+      type: object
+      properties:
+        id:
+          $ref: "#/components/schemas/pointId"
+        value:
+          type: number
+          default: 24.3
+    pointData:
+      allOf:
+        - $ref: "#/components/schemas/pointMetadata"
+        - $ref: "#/components/schemas/pointValue"
+  parameters:
+    runId:
+      in: path
+      name: runId
+      schema:
+        $ref: "#/components/schemas/runId"
+      required: true
+      description: UUID of run
+    pointId:
+      in: path
+      name: pointId
+      schema:
+        $ref: "#/components/schemas/pointId"
+      required: true
+      description: UUID of point
diff --git a/alfalfa_web/generate-docs.js b/alfalfa_web/generate-docs.js
@@ -8,7 +8,7 @@ const { version } = require("./package.json");
 const serverType = process.env.NODE_ENV === "production" ? "Production" : "Development";
 
 const openapiSpecification = swaggerJsdoc({
-  apis: ["./server/api-v2.js", "./server/api-haystack.js"],
+  apis: ["./server/api-v2.js", "./server/api-haystack.js", "./components.yml"],
   definition: {
     openapi: "3.1.0",
     info: {
@@ -47,6 +47,10 @@ const openapiSpecification = swaggerJsdoc({
         name: "Site",
         description: "Manage sites"
       },
+      {
+        name: "Run",
+        description: "Manage Runs"
+      },
       {
         name: "Haystack",
         description:
@@ -56,7 +60,7 @@ const openapiSpecification = swaggerJsdoc({
     "x-tagGroups": [
       {
         name: "Alfalfa API",
-        tags: ["About", "Alias", "Model", "Simulation", "Site"]
+        tags: ["About", "Alias", "Model", "Simulation", "Site", "Run"]
       },
       {
         name: "Project Haystack API",

diff --git a/alfalfa_web/package.json b/alfalfa_web/package.json
@@ -56,7 +56,7 @@
     "@babel/polyfill": "^7.12.1",
     "@babel/preset-env": "^7.20.2",
     "@babel/preset-react": "^7.18.6",
-    "@redocly/cli": "^1.0.0-beta.124",
+    "@redocly/cli": "^1.5.0",
     "babel-loader": "^9.1.2",
     "babel-preset-minify": "^0.5.2",
     "before-build-webpack": "^0.2.13",