chore: use tags for open api

Signed-off-by: Dan Selman <[email protected]>
accordproject · Jan 17, 2023 · 1c3f687 · 1c3f687
1 parent 5490be0
commit 1c3f687
Show file tree

Hide file tree

Showing 6 changed files with 6,214 additions and 5,819 deletions.
diff --git a/_site/index.html b/_site/index.html
diff --git a/_site/templatemark/index.html b/_site/templatemark/index.html
diff --git a/index.md b/index.md
diff --git a/merge.js b/merge.js
@@ -26,4 +26,5 @@ const merged = {
 
 merged.paths = mergedPaths;
 merged.info.title = 'Accord Protocol';
+merged.info.description = 'API for document generation and agreement automation';
 fs.writeFileSync('./openapi.json', JSON.stringify(merged, null, 2));
diff --git a/openapi-extra-paths.json b/openapi-extra-paths.json
@@ -22,7 +22,8 @@
         },
         "operationId": "convertAgreementPdf",
         "summary": "Convert agreement to PDF",
-        "description": "Converts an existing `agreement` to PDF."
+        "description": "Converts an existing `agreement` to PDF.",
+        "tags": ["agreements"]
       },
       "parameters": [
         {
@@ -65,7 +66,8 @@
         },
         "operationId": "triggerAgreement",
         "summary": "Trigger an agreement",
-        "description": "Sends data to an existing agreement."
+        "description": "Sends data to an existing agreement.",
+        "tags": ["agreements"]
       },
       "parameters": [
         {
@@ -97,7 +99,8 @@
         },
         "operationId": "agreementState",
         "summary": "Get the state of an agreement",
-        "description": "Gets the runtime state of an agreement."
+        "description": "Gets the runtime state of an agreement.",
+        "tags": ["agreements"]
       },
       "parameters": [
         {
@@ -127,9 +130,10 @@
             "description": "Successful response - returns `capabilities` for the server."
           }
         },
-        "operationId": "capabilities",
+        "operationId": "getCapabilities",
         "summary": "Get server capabilities",
-        "description": "Retrieve the supported features of the server."
+        "description": "Retrieve the supported features of the server.",
+        "tags": ["capabilities"]
       }
     }
   }