Updated with the latest API.

turbot · Dec 6, 2023 · 2667250 · 2667250
1 parent 3879527
commit 2667250
Show file tree

Hide file tree

Showing 17 changed files with 1,502 additions and 73 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -2,6 +2,7 @@
 .travis.yml
 README.md
 api/openapi.yaml
+api_mod.go
 api_pipeline.go
 api_process.go
 api_trigger.go
@@ -28,13 +29,16 @@ docs/ListProcessLogJSONResponse.md
 docs/ListProcessResponse.md
 docs/ListTriggerResponse.md
 docs/ListVariableResponse.md
+docs/Mod.md
+docs/ModApi.md
 docs/ModconfigNextStepAction.md
 docs/ModconfigOutput.md
 docs/ModconfigPipelineOutput.md
 docs/ModconfigStepError.md
 docs/ModconfigStepForEach.md
 docs/ModconfigStepLoop.md
 docs/ModconfigStepRetry.md
+docs/OpenGraph.md
 docs/PerrErrorDetailModel.md
 docs/PerrErrorModel.md
 docs/PipelineApi.md
@@ -68,18 +72,21 @@ model_list_process_log_json_response.go
 model_list_process_response.go
 model_list_trigger_response.go
 model_list_variable_response.go
+model_mod.go
 model_modconfig_next_step_action.go
 model_modconfig_output.go
 model_modconfig_pipeline_output.go
 model_modconfig_step_error.go
 model_modconfig_step_for_each.go
 model_modconfig_step_loop.go
 model_modconfig_step_retry.go
+model_open_graph.go
 model_perr_error_detail_model.go
 model_perr_error_model.go
 model_process.go
 model_process_event_log.go
 model_process_output_data.go
 model_variable.go
 response.go
+test/api_mod_test.go
 utils.go
diff --git a/README.md b/README.md
@@ -80,6 +80,7 @@ All URIs are relative to *https://localhost/api/v0*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*ModApi* | [**Get**](docs/ModApi.md#get) | **Get** /mod/{mod_name} | Get mod
 *PipelineApi* | [**Cmd**](docs/PipelineApi.md#cmd) | **Post** /pipeline/{pipeline_name}/cmd | Execute a pipeline command
 *PipelineApi* | [**Get**](docs/PipelineApi.md#get) | **Get** /pipeline/{pipeline_name} | Get pipeline
 *PipelineApi* | [**List**](docs/PipelineApi.md#list) | **Get** /pipeline | List pipelines
@@ -117,13 +118,15 @@ Class | Method | HTTP request | Description
  - [ListProcessResponse](docs/ListProcessResponse.md)
  - [ListTriggerResponse](docs/ListTriggerResponse.md)
  - [ListVariableResponse](docs/ListVariableResponse.md)
+ - [Mod](docs/Mod.md)
  - [ModconfigNextStepAction](docs/ModconfigNextStepAction.md)
  - [ModconfigOutput](docs/ModconfigOutput.md)
  - [ModconfigPipelineOutput](docs/ModconfigPipelineOutput.md)
  - [ModconfigStepError](docs/ModconfigStepError.md)
  - [ModconfigStepForEach](docs/ModconfigStepForEach.md)
  - [ModconfigStepLoop](docs/ModconfigStepLoop.md)
  - [ModconfigStepRetry](docs/ModconfigStepRetry.md)
+ - [OpenGraph](docs/OpenGraph.md)
  - [PerrErrorDetailModel](docs/PerrErrorDetailModel.md)
  - [PerrErrorModel](docs/PerrErrorModel.md)
  - [Process](docs/Process.md)

diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -13,6 +13,66 @@ info:
 servers:
 - url: https://localhost/api/v0
 paths:
+  /mod/{mod_name}:
+    get:
+      description: Get mod
+      operationId: mod_get
+      parameters:
+      - description: The name of the mod
+        explode: false
+        in: path
+        name: mod_name
+        required: true
+        schema:
+          format: "^[a-z]{0,32}$"
+          type: string
+        style: simple
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Mod'
+          description: OK
+        "400":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/perr.ErrorModel'
+          description: Bad Request
+        "401":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/perr.ErrorModel'
+          description: Unauthorized
+        "403":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/perr.ErrorModel'
+          description: Forbidden
+        "404":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/perr.ErrorModel'
+          description: Not Found
+        "429":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/perr.ErrorModel'
+          description: Too Many Requests
+        "500":
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/perr.ErrorModel'
+          description: Internal Server Error
+      summary: Get mod
+      tags:
+      - Mod
   /pipeline:
     get:
       description: Lists pipelines
@@ -873,15 +933,13 @@ components:
           - depends_on
           name: name
           description: description
-          sensitive: true
           value: "{}"
           resolved: true
         - depends_on:
           - depends_on
           - depends_on
           name: name
           description: description
-          sensitive: true
           value: "{}"
           resolved: true
         mod: mod
@@ -955,6 +1013,7 @@ components:
     FpTrigger:
       example:
         pipeline: pipeline
+        schedule: schedule
         documentation: documentation
         name: name
         description: description
@@ -972,6 +1031,8 @@ components:
           type: string
         pipeline:
           type: string
+        schedule:
+          type: string
         tags:
           additionalProperties:
             type: string
@@ -993,15 +1054,13 @@ components:
             - depends_on
             name: name
             description: description
-            sensitive: true
             value: "{}"
             resolved: true
           - depends_on:
             - depends_on
             - depends_on
             name: name
             description: description
-            sensitive: true
             value: "{}"
             resolved: true
           mod: mod
@@ -1031,15 +1090,13 @@ components:
             - depends_on
             name: name
             description: description
-            sensitive: true
             value: "{}"
             resolved: true
           - depends_on:
             - depends_on
             - depends_on
             name: name
             description: description
-            sensitive: true
             value: "{}"
             resolved: true
           mod: mod
@@ -1114,6 +1171,7 @@ components:
         next_token: next_token
         items:
         - pipeline: pipeline
+          schedule: schedule
           documentation: documentation
           name: name
           description: description
@@ -1123,6 +1181,7 @@ components:
           tags:
             key: tags
         - pipeline: pipeline
+          schedule: schedule
           documentation: documentation
           name: name
           description: description
@@ -1143,10 +1202,16 @@ components:
       example:
         next_token: next_token
         items:
-        - name: name
+        - default: "{}"
+          name: name
+          description: description
           type: type
-        - name: name
+          value: "{}"
+        - default: "{}"
+          name: name
+          description: description
           type: type
+          value: "{}"
       properties:
         items:
           items:
@@ -1155,6 +1220,49 @@ components:
         next_token:
           type: string
       type: object
+    Mod:
+      example:
+        color: color
+        documentation: documentation
+        name: name
+        description: description
+        categories:
+        - categories
+        - categories
+        title: title
+        opengraph:
+          description: description
+          title: title
+      properties:
+        categories:
+          items:
+            type: string
+          type: array
+        color:
+          type: string
+        description:
+          type: string
+        documentation:
+          type: string
+        name:
+          type: string
+        opengraph:
+          $ref: '#/components/schemas/OpenGraph'
+        title:
+          type: string
+      type: object
+    OpenGraph:
+      example:
+        description: description
+        title: title
+      properties:
+        description:
+          description: "The opengraph description (og:description) of the mod, for\
+            \ use in social media applications"
+          type: string
+        title:
+          type: string
+      type: object
     PipelineExecutionResponse:
       additionalProperties: true
       type: object
@@ -1203,13 +1311,22 @@ components:
       type: object
     Variable:
       example:
+        default: "{}"
         name: name
+        description: description
         type: type
+        value: "{}"
       properties:
+        default:
+          type: object
+        description:
+          type: string
         name:
           type: string
         type:
           type: string
+        value:
+          type: object
       type: object
     execution.Execution:
       example:
@@ -1833,7 +1950,6 @@ components:
         - depends_on
         name: name
         description: description
-        sensitive: true
         value: "{}"
         resolved: true
       properties:
@@ -1847,8 +1963,6 @@ components:
           type: string
         resolved:
           type: boolean
-        sensitive:
-          type: boolean
         value:
           type: object
       type: object