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.

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

[AN-242] Update MethodQuery schema in Swagger docs #1482

Merged
merged 2 commits into from
Nov 5, 2024
Merged
Changes from all commits
Commits
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
19 changes: 12 additions & 7 deletions src/main/resources/swagger/api-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7749,40 +7749,45 @@ components:
format: int32
default: 0
MethodQuery:
required:
- namespace
- name
- payload
- entityType
type: object
properties:
namespace:
type: string
description: Namespace which contains AgoraEntity.
default: YOUR_NAMESPACE
example: YOUR_NAMESPACE
name:
type: string
description: Name of the AgoraEntity.
default: BWA
example: BWA
synopsis:
type: string
description: Synopsis which contains AgoraEntity.
default: Quickly aligns short nucleotide sequences.
example: Quickly aligns short nucleotide sequences.
snapshotComment:
type: string
description: Snapshot comment of AgoraEntity
default: Improved spline reticulation
example: Improved spline reticulation
documentation:
type: string
description: Documentation of the AgoraEntity.
default: |
example: |
BWA is a software package for mapping low-divergent sequences
against a large reference genome, such as the human genome.
It consists of three algorithms: BWA-backtrack, BWA-SW and BWA-MEM.
payload:
type: string
description: Payload of method -- must be in WDL format
default: |
example: |
task wc {File in_file command { cat ${in_file} | wc -l } output { Int count = read_int(stdout()) }}
entityType:
type: string
description: Type of the AgoraEntity -- Task or Workflow.
default: Task
example: Task
MethodShort:
required:
- managers
Expand Down
Loading