From af3e0696d4f06fd6a5109527272e41544c9614ad Mon Sep 17 00:00:00 2001
From: Sam Schumacher <42777208+sam-schu@users.noreply.github.com>
Date: Tue, 5 Nov 2024 15:07:27 -0500
Subject: [PATCH] [AN-242] Update MethodQuery schema in Swagger docs (#1482)

---
 src/main/resources/swagger/api-docs.yaml | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

diff --git a/src/main/resources/swagger/api-docs.yaml b/src/main/resources/swagger/api-docs.yaml
index c101a6ce3..1f145a9f6 100755
--- a/src/main/resources/swagger/api-docs.yaml
+++ b/src/main/resources/swagger/api-docs.yaml
@@ -7820,40 +7820,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