Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add workflow api specs #328

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add workflow api specs #328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 docs/source/Asset.yaml → docs/specs/Asset.yaml
View file
Open in desktop
File renamed without changes.
0 docs/source/AssetType.yaml → docs/specs/AssetType.yaml
View file
Open in desktop
File renamed without changes.
21 changes: 21 additions & 0 deletions docs/specs/FlowEndpointBRT.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
21 changes: 21 additions & 0 deletions docs/specs/FlowEndpointCZI.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
21 changes: 21 additions & 0 deletions docs/specs/FlowEndpointDM.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
21 changes: 21 additions & 0 deletions docs/specs/FlowEndpointLRG.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
21 changes: 21 additions & 0 deletions docs/specs/FlowEndpointSEM.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
0 docs/source/ImageSet.yaml → docs/specs/ImageSet.yaml
View file
Open in desktop
File renamed without changes.
0 docs/source/NeuroglancerMetadata.yaml → docs/specs/NeuroglancerMetadata.yaml
View file
Open in desktop
File renamed without changes.
0 docs/source/PipelineCallback.yaml → docs/specs/PipelineCallback.yaml
View file
Open in desktop
File renamed without changes.
32 changes: 32 additions & 0 deletions docs/specs/RequestBodyBRT.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions docs/specs/RequestBodySEM.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
type: object
required:
properties:
tilt_angle:
type: float
19 changes: 19 additions & 0 deletions docs/specs/RequestBodyShared.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
0 docs/source/demo_callback.json → docs/specs/demo_callback.json
View file
Open in desktop
File renamed without changes.
10 changes: 5 additions & 5 deletions docs/source/metadata.yml → docs/specs/metadata.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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": {
Expand All @@ -27,7 +27,7 @@


# Close to legacy metadata specifications - not preferred
"metadata": {
"metadata 3": {
"shader": "Grayscale",
"dimensions": "XYZ",
"shaderParameters": {
Expand All @@ -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": {
Expand Down
24 changes: 24 additions & 0 deletions docs/specs/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These paths might be wrong. I took flow group ID for these paths.

$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
Loading