Add workflow api specs

docs/specs/FlowEndpointBRT.yaml

@@ -0,0 +1,21 @@
+post:
+  summary: Create a BRT workflow run
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: "#definitions/RequestBody"
+  response:
+    200:
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: PipelineCallback.yaml
+
+definitions:
+  RequestBody:
+    allOf:
+      - $ref: RequestBodyShared.yaml
+      - $ref: RequestBodyBRT.yaml

docs/specs/FlowEndpointCZI.yaml

@@ -0,0 +1,21 @@
+post:
+  summary: Create a CZI workflow run
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: "#definitions/RequestBody"
+  response:
+    200:
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: PipelineCallback.yaml
+
+definitions:
+  RequestBody:
+    allOf:
+      - $ref: RequestBodyShared.yaml
+      # - $ref: RequestBodyCZI.yaml

docs/specs/FlowEndpointDM.yaml

@@ -0,0 +1,21 @@
+post:
+  summary: Create a DM workflow run
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: "#definitions/RequestBody"
+  response:
+    200:
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: PipelineCallback.yaml
+
+definitions:
+  RequestBody:
+    allOf:
+      - $ref: RequestBodyShared.yaml
+      # - $ref: RequestBodyDM.yaml

docs/specs/FlowEndpointLRG.yaml

@@ -0,0 +1,21 @@
+post:
+  summary: Create a LRG workflow run
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: "#definitions/RequestBody"
+  response:
+    200:
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: PipelineCallback.yaml
+
+definitions:
+  RequestBody:
+    allOf:
+      - $ref: RequestBodyShared.yaml
+      # - $ref: RequestBodyLRG.yaml

docs/specs/FlowEndpointSEM.yaml

@@ -0,0 +1,21 @@
+post:
+  summary: Create a SEM workflow run
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: "#definitions/RequestBody"
+  response:
+    200:
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: PipelineCallback.yaml
+
+definitions:
+  RequestBody:
+    allOf:
+      - $ref: RequestBodyShared.yaml
+      - $ref: RequestBodySEM.yaml

docs/specs/RequestBodyBRT.yaml

@@ -0,0 +1,32 @@
+type: object
+required:
+  - gold
+  - focus
+  - montage
+  - fiducialless
+  - trackingMethod
+  - TwoSurfaces
+  - TargetNumberOfBeads
+  - LocalAlignments
+  - THICKNESS
+properties:
+  LocalAlignments:
+    type: integer
+  THICKNESS:
+    type: integer
+  TargetNumberOfBeads:
+    type: integer
+  TwoSurfaces:
+    type: integer
+  adoc_template:
+    type: string
+  fiducialless:
+    type: integer
+  focus:
+    type: integer
+  gold:
+    type: integer
+  montage:
+    type: integer
+  trackingMethod:
+    type: integer

docs/specs/RequestBodySEM.yaml

@@ -0,0 +1,5 @@
+type: object
+required:
+properties:
+  tilt_angle:
+    type: float

docs/specs/RequestBodyShared.yaml

@@ -0,0 +1,19 @@
+type: object
+required:
+  - input_dir
+  - file_share
+properties:
+  input_dir:
+    type: string
+  file_share:
+    type: string
+  file_name:
+    type: string
+  callback_url:
+    type: string
+  token:
+    type: string
+  no_api:
+    type: string
+  keep_workdir:
+    type: boolean

docs/source/metadata.yml → docs/specs/metadata.yml

@@ -4,7 +4,7 @@
 # Note:
 # - Floor/Limit is used for window, while Min/Max is used for range.
 # - Floor/Limit has a range wider or equal to Min/Max
-"metadata": {
+"metadata 1": {
   "neuroglancerPrecomputedMin": "-53",
   "neuroglancerPrecomputedMax": "58",
   "neuroglancerPrecomputedFloor": "-571",
@@ -16,7 +16,7 @@
 # - removed "neuroglancerPrecomputed" prefix as that format is no longer being used
 # - Changed two values to an array of integers for stringified number
 # - Renamed to the parameter name of the invlerp
-"metadata": {
+"metadata 2": {
       "shader": "Grayscale",
       "dimensions": "XYZ",
       "shaderParameters": {
@@ -27,7 +27,7 @@
 
 
   # Close to legacy metadata specifications - not preferred
-"metadata": {
+"metadata 3": {
     "shader": "Grayscale",
     "dimensions": "XYZ",
     "shaderParameters": {
@@ -40,15 +40,15 @@
 
 
 # Proposed RGB specification ( could be dimension:XYZ in the future )
-"metadata": {
+"metadata 4": {
     "shader" : "RGB",
     "dimensions" : "XY",
     "shaderParameters" : {}
   }
 
 
 # Proposed MultiChannel metadata
-"metadata": {
+"metadata 5": {
   "shader": "MultiChannel",
   "dimensions": "XY",
   "shaderParameters": {

docs/specs/openapi.yaml

@@ -0,0 +1,24 @@
+openapi: 3.1.0
+info:
+  title: Hedwig Workflow API
+  description: REST API for Hedwig Workflows
+  version: 0.1.0
+  license:
+    name: BSD 3-Clause License
+    identifier: BSD 3-Clause License
+
+servers:
+  - url: https://prefect1.hedwig-workflow-api.niaiddev.net/default/flow/
+    description: Dev API
+
+paths:
+  /11bab698-95bd-47a2-95b4-e7188cb4903d:
+    $ref: BRTFlowEndpoint.yaml
+  /966ec553-3e8e-42ce-80e1-263f6d4ea58f:
+    $ref: CZIFlowEndpoint.yaml
+  /de6e9025-715a-49c1-88cf-58213e0003ed:
+    $ref: DMFlowEndpoint.yaml
+  /375bec74-d33d-4a3d-893a-b4a64e4628fc:
+    $ref: LRGFlowEndpoint.yaml
+  /090d8f02-c46c-4464-866f-b268e2b5d5be:
+    $ref: SEMFlowEndpoint.yaml