diff --git a/api/openapispec/docs.go b/api/openapispec/docs.go index 86bb756..7619f99 100644 --- a/api/openapispec/docs.go +++ b/api/openapispec/docs.go @@ -147,7 +147,7 @@ const docTemplate = `{ } } }, - "/api/v1/backends/{id}": { + "/api/v1/backends/{backendID}": { "get": { "description": "Get backend information by backend ID", "produces": [ @@ -162,7 +162,7 @@ const docTemplate = `{ { "type": "integer", "description": "Backend ID", - "name": "id", + "name": "backendID", "in": "path", "required": true } @@ -225,7 +225,7 @@ const docTemplate = `{ { "type": "integer", "description": "Backend ID", - "name": "id", + "name": "backendID", "in": "path", "required": true }, @@ -294,7 +294,7 @@ const docTemplate = `{ { "type": "integer", "description": "Backend ID", - "name": "id", + "name": "backendID", "in": "path", "required": true } @@ -485,7 +485,7 @@ const docTemplate = `{ } } }, - "/api/v1/modules/{name}": { + "/api/v1/modules/{moduleName}": { "get": { "description": "Get module information by module name", "produces": [ @@ -500,7 +500,7 @@ const docTemplate = `{ { "type": "string", "description": "Module Name", - "name": "name", + "name": "moduleName", "in": "path", "required": true } @@ -563,7 +563,7 @@ const docTemplate = `{ { "type": "string", "description": "Module Name", - "name": "name", + "name": "moduleName", "in": "path", "required": true }, @@ -632,7 +632,7 @@ const docTemplate = `{ { "type": "string", "description": "Module Name", - "name": "name", + "name": "moduleName", "in": "path", "required": true } @@ -811,7 +811,7 @@ const docTemplate = `{ } } }, - "/api/v1/orgs/{id}": { + "/api/v1/orgs/{orgID}": { "get": { "description": "Get organization information by organization ID", "produces": [ @@ -826,7 +826,7 @@ const docTemplate = `{ { "type": "integer", "description": "Organization ID", - "name": "id", + "name": "orgID", "in": "path", "required": true } @@ -889,7 +889,7 @@ const docTemplate = `{ { "type": "integer", "description": "Organization ID", - "name": "id", + "name": "orgID", "in": "path", "required": true }, @@ -958,7 +958,7 @@ const docTemplate = `{ { "type": "integer", "description": "Organization ID", - "name": "id", + "name": "orgID", "in": "path", "required": true } @@ -1152,7 +1152,7 @@ const docTemplate = `{ } } }, - "/api/v1/projects/{project_id}": { + "/api/v1/projects/{projectID}": { "get": { "description": "Get project information by project ID", "produces": [ @@ -1167,7 +1167,7 @@ const docTemplate = `{ { "type": "integer", "description": "Project ID", - "name": "project_id", + "name": "projectID", "in": "path", "required": true } @@ -1230,7 +1230,7 @@ const docTemplate = `{ { "type": "integer", "description": "Project ID", - "name": "project_id", + "name": "projectID", "in": "path", "required": true }, @@ -1299,7 +1299,7 @@ const docTemplate = `{ { "type": "integer", "description": "Project ID", - "name": "project_id", + "name": "projectID", "in": "path", "required": true } @@ -1358,6 +1358,36 @@ const docTemplate = `{ "summary": "List resource", "operationId": "listResource", "parameters": [ + { + "type": "integer", + "description": "The organization ID", + "name": "orgID", + "in": "query" + }, + { + "type": "integer", + "description": "The project ID", + "name": "projectID", + "in": "query" + }, + { + "type": "integer", + "description": "The stack ID", + "name": "stackID", + "in": "query" + }, + { + "type": "string", + "description": "The resource type", + "name": "resourceType", + "in": "query" + }, + { + "type": "string", + "description": "The resource plane", + "name": "resourcePlane", + "in": "query" + }, { "type": "integer", "description": "The current page to fetch. Default to 1", @@ -1431,7 +1461,7 @@ const docTemplate = `{ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "query", "required": true } @@ -1478,7 +1508,7 @@ const docTemplate = `{ } } }, - "/api/v1/resources/{id}": { + "/api/v1/resources/{resourceID}": { "get": { "description": "Get resource information by resource ID", "produces": [ @@ -1493,7 +1523,7 @@ const docTemplate = `{ { "type": "integer", "description": "Resource ID", - "name": "id", + "name": "resourceID", "in": "path", "required": true } @@ -1558,30 +1588,6 @@ const docTemplate = `{ "name": "projectID", "in": "query" }, - { - "type": "integer", - "description": "OrgID to filter runs by. Default to all", - "name": "orgID", - "in": "query" - }, - { - "type": "string", - "description": "ProjectName to filter runs by. Default to all", - "name": "projectName", - "in": "query" - }, - { - "type": "string", - "description": "Cloud to filter runs by. Default to all", - "name": "cloud", - "in": "query" - }, - { - "type": "string", - "description": "Environment to filter runs by. Default to all", - "name": "env", - "in": "query" - }, { "type": "array", "items": { @@ -1681,7 +1687,7 @@ const docTemplate = `{ } } }, - "/api/v1/runs/{run_id}": { + "/api/v1/runs/{runID}": { "get": { "description": "Get run information by run ID", "produces": [ @@ -1696,7 +1702,7 @@ const docTemplate = `{ { "type": "integer", "description": "Run ID", - "name": "run", + "name": "runID", "in": "path", "required": true } @@ -1743,7 +1749,7 @@ const docTemplate = `{ } } }, - "/api/v1/runs/{run_id}/result": { + "/api/v1/runs/{runID}/result": { "get": { "description": "Get run result by run ID", "produces": [ @@ -1758,7 +1764,7 @@ const docTemplate = `{ { "type": "integer", "description": "Run ID", - "name": "run", + "name": "runID", "in": "path", "required": true } @@ -1943,7 +1949,7 @@ const docTemplate = `{ } } }, - "/api/v1/sources/{id}": { + "/api/v1/sources/{sourceID}": { "get": { "description": "Get source information by source ID", "produces": [ @@ -1958,7 +1964,7 @@ const docTemplate = `{ { "type": "integer", "description": "Source ID", - "name": "id", + "name": "sourceID", "in": "path", "required": true } @@ -2021,7 +2027,7 @@ const docTemplate = `{ { "type": "integer", "description": "Source ID", - "name": "id", + "name": "sourceID", "in": "path", "required": true }, @@ -2090,7 +2096,7 @@ const docTemplate = `{ { "type": "integer", "description": "Source ID", - "name": "id", + "name": "sourceID", "in": "path", "required": true } @@ -2169,14 +2175,8 @@ const docTemplate = `{ }, { "type": "string", - "description": "Cloud to filter stacks by. Default to all", - "name": "cloud", - "in": "query" - }, - { - "type": "string", - "description": "Environment to filter stacks by. Default to all", - "name": "env", + "description": "Path to filter stacks by. Default to all", + "name": "path", "in": "query" }, { @@ -2311,7 +2311,7 @@ const docTemplate = `{ } } }, - "/api/v1/stacks/{stack_id}": { + "/api/v1/stacks/{stackID}": { "get": { "description": "Get stack information by stack ID", "produces": [ @@ -2326,7 +2326,7 @@ const docTemplate = `{ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true } @@ -2389,7 +2389,7 @@ const docTemplate = `{ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true }, @@ -2458,7 +2458,7 @@ const docTemplate = `{ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true } @@ -2505,7 +2505,7 @@ const docTemplate = `{ } } }, - "/api/v1/stacks/{stack_id}/apply": { + "/api/v1/stacks/{stackID}/apply": { "post": { "description": "Apply stack information by stack ID", "produces": [ @@ -2520,7 +2520,7 @@ const docTemplate = `{ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true }, @@ -2606,7 +2606,7 @@ const docTemplate = `{ } } }, - "/api/v1/stacks/{stack_id}/apply/async": { + "/api/v1/stacks/{stackID}/apply/async": { "post": { "description": "Start a run and asynchronously apply stack changes by stack ID", "produces": [ @@ -2621,7 +2621,7 @@ const docTemplate = `{ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true }, @@ -2707,7 +2707,7 @@ const docTemplate = `{ } } }, - "/api/v1/stacks/{stack_id}/destroy": { + "/api/v1/stacks/{stackID}/destroy": { "post": { "description": "Destroy stack information by stack ID", "produces": [ @@ -2722,7 +2722,7 @@ const docTemplate = `{ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true }, @@ -2788,7 +2788,7 @@ const docTemplate = `{ } } }, - "/api/v1/stacks/{stack_id}/destroy/async": { + "/api/v1/stacks/{stackID}/destroy/async": { "post": { "description": "Start a run and asynchronously destroy stack resources by stack ID", "produces": [ @@ -2803,7 +2803,7 @@ const docTemplate = `{ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true }, @@ -2869,7 +2869,7 @@ const docTemplate = `{ } } }, - "/api/v1/stacks/{stack_id}/generate": { + "/api/v1/stacks/{stackID}/generate": { "post": { "description": "Generate stack information by stack ID", "produces": [ @@ -2884,7 +2884,7 @@ const docTemplate = `{ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true }, @@ -2950,7 +2950,7 @@ const docTemplate = `{ } } }, - "/api/v1/stacks/{stack_id}/generate/async": { + "/api/v1/stacks/{stackID}/generate/async": { "post": { "description": "Start a run and asynchronously generate stack spec by stack ID", "produces": [ @@ -2965,7 +2965,7 @@ const docTemplate = `{ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true }, @@ -3031,7 +3031,7 @@ const docTemplate = `{ } } }, - "/api/v1/stacks/{stack_id}/preview": { + "/api/v1/stacks/{stackID}/preview": { "post": { "description": "Start a run and asynchronously preview stack changes by stack ID", "produces": [ @@ -3046,7 +3046,7 @@ const docTemplate = `{ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true }, @@ -3150,6 +3150,12 @@ const docTemplate = `{ "summary": "List workspaces", "operationId": "listWorkspace", "parameters": [ + { + "type": "integer", + "description": "BackendID to filter workspaces by. Default to all", + "name": "backendID", + "in": "query" + }, { "type": "integer", "description": "The current page to fetch. Default to 1", @@ -3325,7 +3331,7 @@ const docTemplate = `{ } } }, - "/api/v1/workspaces/{id}": { + "/api/v1/workspaces/{workspaceID}": { "get": { "description": "Get workspace information by workspace ID", "produces": [ @@ -3340,7 +3346,7 @@ const docTemplate = `{ { "type": "integer", "description": "Workspace ID", - "name": "id", + "name": "workspaceID", "in": "path", "required": true } @@ -3403,7 +3409,7 @@ const docTemplate = `{ { "type": "integer", "description": "Workspace ID", - "name": "id", + "name": "workspaceID", "in": "path", "required": true }, @@ -3472,7 +3478,7 @@ const docTemplate = `{ { "type": "integer", "description": "Workspace ID", - "name": "id", + "name": "workspaceID", "in": "path", "required": true } @@ -3519,7 +3525,7 @@ const docTemplate = `{ } } }, - "/api/v1/workspaces/{id}/configs": { + "/api/v1/workspaces/{workspaceID}/configs": { "get": { "description": "Get configurations in the specified workspace", "consumes": [ @@ -3537,7 +3543,7 @@ const docTemplate = `{ { "type": "integer", "description": "Workspace ID", - "name": "id", + "name": "workspaceID", "in": "path", "required": true } @@ -3588,7 +3594,7 @@ const docTemplate = `{ { "type": "integer", "description": "Workspace ID", - "name": "id", + "name": "workspaceID", "in": "path", "required": true }, @@ -3632,7 +3638,7 @@ const docTemplate = `{ } } }, - "/api/v1/workspaces/{id}/configs/mod-deps": { + "/api/v1/workspaces/{workspaceID}/configs/mod-deps": { "post": { "description": "Create the module dependencies in kcl.mod of the specified workspace", "consumes": [ @@ -3650,7 +3656,7 @@ const docTemplate = `{ { "type": "integer", "description": "Workspace ID", - "name": "id", + "name": "workspaceID", "in": "path", "required": true } @@ -3747,18 +3753,18 @@ const docTemplate = `{ "constant.SourceProviderType": { "type": "string", "enum": [ - "git", "git", "github", "oci", - "local" + "local", + "git" ], "x-enum-varnames": [ - "DefaultSourceType", "SourceProviderTypeGit", "SourceProviderTypeGithub", "SourceProviderTypeOCI", - "SourceProviderTypeLocal" + "SourceProviderTypeLocal", + "DefaultSourceType" ] }, "constant.StackState": { diff --git a/api/openapispec/swagger.json b/api/openapispec/swagger.json index fdd7021..bf39c69 100644 --- a/api/openapispec/swagger.json +++ b/api/openapispec/swagger.json @@ -136,7 +136,7 @@ } } }, - "/api/v1/backends/{id}": { + "/api/v1/backends/{backendID}": { "get": { "description": "Get backend information by backend ID", "produces": [ @@ -151,7 +151,7 @@ { "type": "integer", "description": "Backend ID", - "name": "id", + "name": "backendID", "in": "path", "required": true } @@ -214,7 +214,7 @@ { "type": "integer", "description": "Backend ID", - "name": "id", + "name": "backendID", "in": "path", "required": true }, @@ -283,7 +283,7 @@ { "type": "integer", "description": "Backend ID", - "name": "id", + "name": "backendID", "in": "path", "required": true } @@ -474,7 +474,7 @@ } } }, - "/api/v1/modules/{name}": { + "/api/v1/modules/{moduleName}": { "get": { "description": "Get module information by module name", "produces": [ @@ -489,7 +489,7 @@ { "type": "string", "description": "Module Name", - "name": "name", + "name": "moduleName", "in": "path", "required": true } @@ -552,7 +552,7 @@ { "type": "string", "description": "Module Name", - "name": "name", + "name": "moduleName", "in": "path", "required": true }, @@ -621,7 +621,7 @@ { "type": "string", "description": "Module Name", - "name": "name", + "name": "moduleName", "in": "path", "required": true } @@ -800,7 +800,7 @@ } } }, - "/api/v1/orgs/{id}": { + "/api/v1/orgs/{orgID}": { "get": { "description": "Get organization information by organization ID", "produces": [ @@ -815,7 +815,7 @@ { "type": "integer", "description": "Organization ID", - "name": "id", + "name": "orgID", "in": "path", "required": true } @@ -878,7 +878,7 @@ { "type": "integer", "description": "Organization ID", - "name": "id", + "name": "orgID", "in": "path", "required": true }, @@ -947,7 +947,7 @@ { "type": "integer", "description": "Organization ID", - "name": "id", + "name": "orgID", "in": "path", "required": true } @@ -1141,7 +1141,7 @@ } } }, - "/api/v1/projects/{project_id}": { + "/api/v1/projects/{projectID}": { "get": { "description": "Get project information by project ID", "produces": [ @@ -1156,7 +1156,7 @@ { "type": "integer", "description": "Project ID", - "name": "project_id", + "name": "projectID", "in": "path", "required": true } @@ -1219,7 +1219,7 @@ { "type": "integer", "description": "Project ID", - "name": "project_id", + "name": "projectID", "in": "path", "required": true }, @@ -1288,7 +1288,7 @@ { "type": "integer", "description": "Project ID", - "name": "project_id", + "name": "projectID", "in": "path", "required": true } @@ -1347,6 +1347,36 @@ "summary": "List resource", "operationId": "listResource", "parameters": [ + { + "type": "integer", + "description": "The organization ID", + "name": "orgID", + "in": "query" + }, + { + "type": "integer", + "description": "The project ID", + "name": "projectID", + "in": "query" + }, + { + "type": "integer", + "description": "The stack ID", + "name": "stackID", + "in": "query" + }, + { + "type": "string", + "description": "The resource type", + "name": "resourceType", + "in": "query" + }, + { + "type": "string", + "description": "The resource plane", + "name": "resourcePlane", + "in": "query" + }, { "type": "integer", "description": "The current page to fetch. Default to 1", @@ -1420,7 +1450,7 @@ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "query", "required": true } @@ -1467,7 +1497,7 @@ } } }, - "/api/v1/resources/{id}": { + "/api/v1/resources/{resourceID}": { "get": { "description": "Get resource information by resource ID", "produces": [ @@ -1482,7 +1512,7 @@ { "type": "integer", "description": "Resource ID", - "name": "id", + "name": "resourceID", "in": "path", "required": true } @@ -1547,30 +1577,6 @@ "name": "projectID", "in": "query" }, - { - "type": "integer", - "description": "OrgID to filter runs by. Default to all", - "name": "orgID", - "in": "query" - }, - { - "type": "string", - "description": "ProjectName to filter runs by. Default to all", - "name": "projectName", - "in": "query" - }, - { - "type": "string", - "description": "Cloud to filter runs by. Default to all", - "name": "cloud", - "in": "query" - }, - { - "type": "string", - "description": "Environment to filter runs by. Default to all", - "name": "env", - "in": "query" - }, { "type": "array", "items": { @@ -1670,7 +1676,7 @@ } } }, - "/api/v1/runs/{run_id}": { + "/api/v1/runs/{runID}": { "get": { "description": "Get run information by run ID", "produces": [ @@ -1685,7 +1691,7 @@ { "type": "integer", "description": "Run ID", - "name": "run", + "name": "runID", "in": "path", "required": true } @@ -1732,7 +1738,7 @@ } } }, - "/api/v1/runs/{run_id}/result": { + "/api/v1/runs/{runID}/result": { "get": { "description": "Get run result by run ID", "produces": [ @@ -1747,7 +1753,7 @@ { "type": "integer", "description": "Run ID", - "name": "run", + "name": "runID", "in": "path", "required": true } @@ -1932,7 +1938,7 @@ } } }, - "/api/v1/sources/{id}": { + "/api/v1/sources/{sourceID}": { "get": { "description": "Get source information by source ID", "produces": [ @@ -1947,7 +1953,7 @@ { "type": "integer", "description": "Source ID", - "name": "id", + "name": "sourceID", "in": "path", "required": true } @@ -2010,7 +2016,7 @@ { "type": "integer", "description": "Source ID", - "name": "id", + "name": "sourceID", "in": "path", "required": true }, @@ -2079,7 +2085,7 @@ { "type": "integer", "description": "Source ID", - "name": "id", + "name": "sourceID", "in": "path", "required": true } @@ -2158,14 +2164,8 @@ }, { "type": "string", - "description": "Cloud to filter stacks by. Default to all", - "name": "cloud", - "in": "query" - }, - { - "type": "string", - "description": "Environment to filter stacks by. Default to all", - "name": "env", + "description": "Path to filter stacks by. Default to all", + "name": "path", "in": "query" }, { @@ -2300,7 +2300,7 @@ } } }, - "/api/v1/stacks/{stack_id}": { + "/api/v1/stacks/{stackID}": { "get": { "description": "Get stack information by stack ID", "produces": [ @@ -2315,7 +2315,7 @@ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true } @@ -2378,7 +2378,7 @@ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true }, @@ -2447,7 +2447,7 @@ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true } @@ -2494,7 +2494,7 @@ } } }, - "/api/v1/stacks/{stack_id}/apply": { + "/api/v1/stacks/{stackID}/apply": { "post": { "description": "Apply stack information by stack ID", "produces": [ @@ -2509,7 +2509,7 @@ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true }, @@ -2595,7 +2595,7 @@ } } }, - "/api/v1/stacks/{stack_id}/apply/async": { + "/api/v1/stacks/{stackID}/apply/async": { "post": { "description": "Start a run and asynchronously apply stack changes by stack ID", "produces": [ @@ -2610,7 +2610,7 @@ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true }, @@ -2696,7 +2696,7 @@ } } }, - "/api/v1/stacks/{stack_id}/destroy": { + "/api/v1/stacks/{stackID}/destroy": { "post": { "description": "Destroy stack information by stack ID", "produces": [ @@ -2711,7 +2711,7 @@ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true }, @@ -2777,7 +2777,7 @@ } } }, - "/api/v1/stacks/{stack_id}/destroy/async": { + "/api/v1/stacks/{stackID}/destroy/async": { "post": { "description": "Start a run and asynchronously destroy stack resources by stack ID", "produces": [ @@ -2792,7 +2792,7 @@ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true }, @@ -2858,7 +2858,7 @@ } } }, - "/api/v1/stacks/{stack_id}/generate": { + "/api/v1/stacks/{stackID}/generate": { "post": { "description": "Generate stack information by stack ID", "produces": [ @@ -2873,7 +2873,7 @@ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true }, @@ -2939,7 +2939,7 @@ } } }, - "/api/v1/stacks/{stack_id}/generate/async": { + "/api/v1/stacks/{stackID}/generate/async": { "post": { "description": "Start a run and asynchronously generate stack spec by stack ID", "produces": [ @@ -2954,7 +2954,7 @@ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true }, @@ -3020,7 +3020,7 @@ } } }, - "/api/v1/stacks/{stack_id}/preview": { + "/api/v1/stacks/{stackID}/preview": { "post": { "description": "Start a run and asynchronously preview stack changes by stack ID", "produces": [ @@ -3035,7 +3035,7 @@ { "type": "integer", "description": "Stack ID", - "name": "stack_id", + "name": "stackID", "in": "path", "required": true }, @@ -3139,6 +3139,12 @@ "summary": "List workspaces", "operationId": "listWorkspace", "parameters": [ + { + "type": "integer", + "description": "BackendID to filter workspaces by. Default to all", + "name": "backendID", + "in": "query" + }, { "type": "integer", "description": "The current page to fetch. Default to 1", @@ -3314,7 +3320,7 @@ } } }, - "/api/v1/workspaces/{id}": { + "/api/v1/workspaces/{workspaceID}": { "get": { "description": "Get workspace information by workspace ID", "produces": [ @@ -3329,7 +3335,7 @@ { "type": "integer", "description": "Workspace ID", - "name": "id", + "name": "workspaceID", "in": "path", "required": true } @@ -3392,7 +3398,7 @@ { "type": "integer", "description": "Workspace ID", - "name": "id", + "name": "workspaceID", "in": "path", "required": true }, @@ -3461,7 +3467,7 @@ { "type": "integer", "description": "Workspace ID", - "name": "id", + "name": "workspaceID", "in": "path", "required": true } @@ -3508,7 +3514,7 @@ } } }, - "/api/v1/workspaces/{id}/configs": { + "/api/v1/workspaces/{workspaceID}/configs": { "get": { "description": "Get configurations in the specified workspace", "consumes": [ @@ -3526,7 +3532,7 @@ { "type": "integer", "description": "Workspace ID", - "name": "id", + "name": "workspaceID", "in": "path", "required": true } @@ -3577,7 +3583,7 @@ { "type": "integer", "description": "Workspace ID", - "name": "id", + "name": "workspaceID", "in": "path", "required": true }, @@ -3621,7 +3627,7 @@ } } }, - "/api/v1/workspaces/{id}/configs/mod-deps": { + "/api/v1/workspaces/{workspaceID}/configs/mod-deps": { "post": { "description": "Create the module dependencies in kcl.mod of the specified workspace", "consumes": [ @@ -3639,7 +3645,7 @@ { "type": "integer", "description": "Workspace ID", - "name": "id", + "name": "workspaceID", "in": "path", "required": true } @@ -3736,18 +3742,18 @@ "constant.SourceProviderType": { "type": "string", "enum": [ - "git", "git", "github", "oci", - "local" + "local", + "git" ], "x-enum-varnames": [ - "DefaultSourceType", "SourceProviderTypeGit", "SourceProviderTypeGithub", "SourceProviderTypeOCI", - "SourceProviderTypeLocal" + "SourceProviderTypeLocal", + "DefaultSourceType" ] }, "constant.StackState": { diff --git a/api/openapispec/swagger.yaml b/api/openapispec/swagger.yaml index 6dd47b0..b4ccc00 100644 --- a/api/openapispec/swagger.yaml +++ b/api/openapispec/swagger.yaml @@ -30,17 +30,17 @@ definitions: constant.SourceProviderType: enum: - git - - git - github - oci - local + - git type: string x-enum-varnames: - - DefaultSourceType - SourceProviderTypeGit - SourceProviderTypeGithub - SourceProviderTypeOCI - SourceProviderTypeLocal + - DefaultSourceType constant.StackState: enum: - UnSynced @@ -1514,14 +1514,14 @@ paths: summary: Create backend tags: - backend - /api/v1/backends/{id}: + /api/v1/backends/{backendID}: delete: description: Delete specified backend by ID operationId: deleteBackend parameters: - description: Backend ID in: path - name: id + name: backendID required: true type: integer produces: @@ -1560,7 +1560,7 @@ paths: parameters: - description: Backend ID in: path - name: id + name: backendID required: true type: integer produces: @@ -1601,7 +1601,7 @@ paths: parameters: - description: Backend ID in: path - name: id + name: backendID required: true type: integer - description: Updated backend @@ -1733,14 +1733,14 @@ paths: summary: Create module tags: - module - /api/v1/modules/{name}: + /api/v1/modules/{moduleName}: delete: description: Delete the specified module by name operationId: deleteModule parameters: - description: Module Name in: path - name: name + name: moduleName required: true type: string produces: @@ -1779,7 +1779,7 @@ paths: parameters: - description: Module Name in: path - name: name + name: moduleName required: true type: string produces: @@ -1820,7 +1820,7 @@ paths: parameters: - description: Module Name in: path - name: name + name: moduleName required: true type: string - description: Updated module @@ -1944,14 +1944,14 @@ paths: summary: Create organization tags: - organization - /api/v1/orgs/{id}: + /api/v1/orgs/{orgID}: delete: description: Delete specified organization by ID operationId: deleteOrganization parameters: - description: Organization ID in: path - name: id + name: orgID required: true type: integer produces: @@ -1990,7 +1990,7 @@ paths: parameters: - description: Organization ID in: path - name: id + name: orgID required: true type: integer produces: @@ -2031,7 +2031,7 @@ paths: parameters: - description: Organization ID in: path - name: id + name: orgID required: true type: integer - description: Updated organization @@ -2166,14 +2166,14 @@ paths: summary: Create project tags: - project - /api/v1/projects/{project_id}: + /api/v1/projects/{projectID}: delete: description: Delete specified project by ID operationId: deleteProject parameters: - description: Project ID in: path - name: project_id + name: projectID required: true type: integer produces: @@ -2212,7 +2212,7 @@ paths: parameters: - description: Project ID in: path - name: project_id + name: projectID required: true type: integer produces: @@ -2253,7 +2253,7 @@ paths: parameters: - description: Project ID in: path - name: project_id + name: projectID required: true type: integer - description: Updated project @@ -2297,6 +2297,26 @@ paths: description: List resource information operationId: listResource parameters: + - description: The organization ID + in: query + name: orgID + type: integer + - description: The project ID + in: query + name: projectID + type: integer + - description: The stack ID + in: query + name: stackID + type: integer + - description: The resource type + in: query + name: resourceType + type: string + - description: The resource plane + in: query + name: resourcePlane + type: string - description: The current page to fetch. Default to 1 in: query name: page @@ -2337,14 +2357,14 @@ paths: summary: List resource tags: - resource - /api/v1/resources/{id}: + /api/v1/resources/{resourceID}: get: description: Get resource information by resource ID operationId: getResource parameters: - description: Resource ID in: path - name: id + name: resourceID required: true type: integer produces: @@ -2384,7 +2404,7 @@ paths: parameters: - description: Stack ID in: query - name: stack_id + name: stackID required: true type: integer produces: @@ -2426,22 +2446,6 @@ paths: in: query name: projectID type: integer - - description: OrgID to filter runs by. Default to all - in: query - name: orgID - type: integer - - description: ProjectName to filter runs by. Default to all - in: query - name: projectName - type: string - - description: Cloud to filter runs by. Default to all - in: query - name: cloud - type: string - - description: Environment to filter runs by. Default to all - in: query - name: env - type: string - collectionFormat: csv description: RunType to filter runs by. Default to all in: query @@ -2510,14 +2514,14 @@ paths: summary: List runs tags: - stack - /api/v1/runs/{run_id}: + /api/v1/runs/{runID}: get: description: Get run information by run ID operationId: getRun parameters: - description: Run ID in: path - name: run + name: runID required: true type: integer produces: @@ -2550,14 +2554,14 @@ paths: summary: Get run tags: - run - /api/v1/runs/{run_id}/result: + /api/v1/runs/{runID}/result: get: description: Get run result by run ID operationId: getRunResult parameters: - description: Run ID in: path - name: run + name: runID required: true type: integer produces: @@ -2679,14 +2683,14 @@ paths: summary: Create source tags: - source - /api/v1/sources/{id}: + /api/v1/sources/{sourceID}: delete: description: Delete specified source by ID operationId: deleteSource parameters: - description: Source ID in: path - name: id + name: sourceID required: true type: integer produces: @@ -2725,7 +2729,7 @@ paths: parameters: - description: Source ID in: path - name: id + name: sourceID required: true type: integer produces: @@ -2766,7 +2770,7 @@ paths: parameters: - description: Source ID in: path - name: id + name: sourceID required: true type: integer - description: Updated source @@ -2822,13 +2826,9 @@ paths: in: query name: projectName type: string - - description: Cloud to filter stacks by. Default to all - in: query - name: cloud - type: string - - description: Environment to filter stacks by. Default to all + - description: Path to filter stacks by. Default to all in: query - name: env + name: path type: string - description: The current page to fetch. Default to 1 in: query @@ -2920,14 +2920,14 @@ paths: summary: Create stack tags: - stack - /api/v1/stacks/{stack_id}: + /api/v1/stacks/{stackID}: delete: description: Delete specified stack by ID operationId: deleteStack parameters: - description: Stack ID in: path - name: stack_id + name: stackID required: true type: integer produces: @@ -2966,7 +2966,7 @@ paths: parameters: - description: Stack ID in: path - name: stack_id + name: stackID required: true type: integer produces: @@ -3007,7 +3007,7 @@ paths: parameters: - description: Stack ID in: path - name: stack_id + name: stackID required: true type: integer - description: Updated stack @@ -3046,14 +3046,14 @@ paths: summary: Update stack tags: - stack - /api/v1/stacks/{stack_id}/apply: + /api/v1/stacks/{stackID}/apply: post: description: Apply stack information by stack ID operationId: applyStack parameters: - description: Stack ID in: path - name: stack_id + name: stackID required: true type: integer - description: The resources to import during the stack preview @@ -3114,14 +3114,14 @@ paths: summary: Apply stack tags: - stack - /api/v1/stacks/{stack_id}/apply/async: + /api/v1/stacks/{stackID}/apply/async: post: description: Start a run and asynchronously apply stack changes by stack ID operationId: applyStackAsync parameters: - description: Stack ID in: path - name: stack_id + name: stackID required: true type: integer - description: The resources to import during the stack preview @@ -3182,14 +3182,14 @@ paths: summary: Asynchronously apply stack tags: - stack - /api/v1/stacks/{stack_id}/destroy: + /api/v1/stacks/{stackID}/destroy: post: description: Destroy stack information by stack ID operationId: destroyStack parameters: - description: Stack ID in: path - name: stack_id + name: stackID required: true type: integer - description: The target workspace to preview the spec in. @@ -3236,7 +3236,7 @@ paths: summary: Destroy stack tags: - stack - /api/v1/stacks/{stack_id}/destroy/async: + /api/v1/stacks/{stackID}/destroy/async: post: description: Start a run and asynchronously destroy stack resources by stack ID @@ -3244,7 +3244,7 @@ paths: parameters: - description: Stack ID in: path - name: stack_id + name: stackID required: true type: integer - description: The target workspace to preview the spec in. @@ -3291,14 +3291,14 @@ paths: summary: Asynchronously destroy stack tags: - stack - /api/v1/stacks/{stack_id}/generate: + /api/v1/stacks/{stackID}/generate: post: description: Generate stack information by stack ID operationId: generateStack parameters: - description: Stack ID in: path - name: stack_id + name: stackID required: true type: integer - description: The target workspace to preview the spec in. @@ -3345,14 +3345,14 @@ paths: summary: Generate stack tags: - stack - /api/v1/stacks/{stack_id}/generate/async: + /api/v1/stacks/{stackID}/generate/async: post: description: Start a run and asynchronously generate stack spec by stack ID operationId: generateStackAsync parameters: - description: Stack ID in: path - name: stack_id + name: stackID required: true type: integer - description: The target workspace to preview the spec in. @@ -3399,14 +3399,14 @@ paths: summary: Asynchronously generate stack tags: - stack - /api/v1/stacks/{stack_id}/preview: + /api/v1/stacks/{stackID}/preview: post: description: Start a run and asynchronously preview stack changes by stack ID operationId: previewStackAsync parameters: - description: Stack ID in: path - name: stack_id + name: stackID required: true type: integer - description: The resources to import during the stack preview @@ -3475,6 +3475,10 @@ paths: description: List all workspaces operationId: listWorkspace parameters: + - description: BackendID to filter workspaces by. Default to all + in: query + name: backendID + type: integer - description: The current page to fetch. Default to 1 in: query name: page @@ -3555,14 +3559,14 @@ paths: summary: Create workspace tags: - workspace - /api/v1/workspaces/{id}: + /api/v1/workspaces/{workspaceID}: delete: description: Delete specified workspace by ID operationId: deleteWorkspace parameters: - description: Workspace ID in: path - name: id + name: workspaceID required: true type: integer produces: @@ -3601,7 +3605,7 @@ paths: parameters: - description: Workspace ID in: path - name: id + name: workspaceID required: true type: integer produces: @@ -3642,7 +3646,7 @@ paths: parameters: - description: Workspace ID in: path - name: id + name: workspaceID required: true type: integer - description: Updated workspace @@ -3681,7 +3685,7 @@ paths: summary: Update workspace tags: - workspace - /api/v1/workspaces/{id}/configs: + /api/v1/workspaces/{workspaceID}/configs: get: consumes: - application/json @@ -3690,7 +3694,7 @@ paths: parameters: - description: Workspace ID in: path - name: id + name: workspaceID required: true type: integer produces: @@ -3726,7 +3730,7 @@ paths: parameters: - description: Workspace ID in: path - name: id + name: workspaceID required: true type: integer - description: Updated workspace configurations @@ -3760,7 +3764,7 @@ paths: summary: Update workspace configurations tags: - workspace - /api/v1/workspaces/{id}/configs/mod-deps: + /api/v1/workspaces/{workspaceID}/configs/mod-deps: post: consumes: - application/json @@ -3769,7 +3773,7 @@ paths: parameters: - description: Workspace ID in: path - name: id + name: workspaceID required: true type: integer produces: diff --git a/package.json b/package.json index 27e20a5..69cf1e1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@kusionstack/kusion-api-client-sdk", - "version": "1.0.3", + "version": "1.1.0", "description": "Kusion API Client SDK", "main": "dist/src/client/index.js", "types": "dist/src/client/index.d.ts", @@ -46,4 +46,4 @@ "publishConfig": { "access": "public" } -} \ No newline at end of file +} diff --git a/src/client/schemas.gen.ts b/src/client/schemas.gen.ts index 605213b..8e70b4c 100644 --- a/src/client/schemas.gen.ts +++ b/src/client/schemas.gen.ts @@ -13,9 +13,9 @@ export const constant_RunTypeSchema = { } as const; export const constant_SourceProviderTypeSchema = { - enum: ['git', 'git', 'github', 'oci', 'local'], + enum: ['git', 'github', 'oci', 'local', 'git'], type: 'string', - 'x-enum-varnames': ['DefaultSourceType', 'SourceProviderTypeGit', 'SourceProviderTypeGithub', 'SourceProviderTypeOCI', 'SourceProviderTypeLocal'] + 'x-enum-varnames': ['SourceProviderTypeGit', 'SourceProviderTypeGithub', 'SourceProviderTypeOCI', 'SourceProviderTypeLocal', 'DefaultSourceType'] } as const; export const constant_StackStateSchema = { diff --git a/src/client/sdk.gen.ts b/src/client/sdk.gen.ts index b155c83..c1240c7 100644 --- a/src/client/sdk.gen.ts +++ b/src/client/sdk.gen.ts @@ -35,7 +35,7 @@ export class BackendService { public static deleteBackend(options: OptionsLegacyParser) { return (options?.client ?? client).delete({ ...options, - url: '/api/v1/backends/{id}' + url: '/api/v1/backends/{backendID}' }); } @@ -46,7 +46,7 @@ export class BackendService { public static getBackend(options: OptionsLegacyParser) { return (options?.client ?? client).get({ ...options, - url: '/api/v1/backends/{id}' + url: '/api/v1/backends/{backendID}' }); } @@ -57,7 +57,7 @@ export class BackendService { public static updateBackend(options: OptionsLegacyParser) { return (options?.client ?? client).put({ ...options, - url: '/api/v1/backends/{id}' + url: '/api/v1/backends/{backendID}' }); } @@ -107,7 +107,7 @@ export class ModuleService { public static deleteModule(options: OptionsLegacyParser) { return (options?.client ?? client).delete({ ...options, - url: '/api/v1/modules/{name}' + url: '/api/v1/modules/{moduleName}' }); } @@ -118,7 +118,7 @@ export class ModuleService { public static getModule(options: OptionsLegacyParser) { return (options?.client ?? client).get({ ...options, - url: '/api/v1/modules/{name}' + url: '/api/v1/modules/{moduleName}' }); } @@ -129,7 +129,7 @@ export class ModuleService { public static updateModule(options: OptionsLegacyParser) { return (options?.client ?? client).put({ ...options, - url: '/api/v1/modules/{name}' + url: '/api/v1/modules/{moduleName}' }); } @@ -165,7 +165,7 @@ export class OrganizationService { public static deleteOrganization(options: OptionsLegacyParser) { return (options?.client ?? client).delete({ ...options, - url: '/api/v1/orgs/{id}' + url: '/api/v1/orgs/{orgID}' }); } @@ -176,7 +176,7 @@ export class OrganizationService { public static getOrganization(options: OptionsLegacyParser) { return (options?.client ?? client).get({ ...options, - url: '/api/v1/orgs/{id}' + url: '/api/v1/orgs/{orgID}' }); } @@ -187,7 +187,7 @@ export class OrganizationService { public static updateOrganization(options: OptionsLegacyParser) { return (options?.client ?? client).put({ ...options, - url: '/api/v1/orgs/{id}' + url: '/api/v1/orgs/{orgID}' }); } @@ -223,7 +223,7 @@ export class ProjectService { public static deleteProject(options: OptionsLegacyParser) { return (options?.client ?? client).delete({ ...options, - url: '/api/v1/projects/{project_id}' + url: '/api/v1/projects/{projectID}' }); } @@ -234,7 +234,7 @@ export class ProjectService { public static getProject(options: OptionsLegacyParser) { return (options?.client ?? client).get({ ...options, - url: '/api/v1/projects/{project_id}' + url: '/api/v1/projects/{projectID}' }); } @@ -245,7 +245,7 @@ export class ProjectService { public static updateProject(options: OptionsLegacyParser) { return (options?.client ?? client).put({ ...options, - url: '/api/v1/projects/{project_id}' + url: '/api/v1/projects/{projectID}' }); } @@ -270,7 +270,7 @@ export class ResourceService { public static getResource(options: OptionsLegacyParser) { return (options?.client ?? client).get({ ...options, - url: '/api/v1/resources/{id}' + url: '/api/v1/resources/{resourceID}' }); } @@ -295,7 +295,7 @@ export class RunService { public static getRun(options: OptionsLegacyParser) { return (options?.client ?? client).get({ ...options, - url: '/api/v1/runs/{run_id}' + url: '/api/v1/runs/{runID}' }); } @@ -306,7 +306,7 @@ export class RunService { public static getRunResult(options: OptionsLegacyParser) { return (options?.client ?? client).get({ ...options, - url: '/api/v1/runs/{run_id}/result' + url: '/api/v1/runs/{runID}/result' }); } @@ -342,7 +342,7 @@ export class SourceService { public static deleteSource(options: OptionsLegacyParser) { return (options?.client ?? client).delete({ ...options, - url: '/api/v1/sources/{id}' + url: '/api/v1/sources/{sourceID}' }); } @@ -353,7 +353,7 @@ export class SourceService { public static getSource(options: OptionsLegacyParser) { return (options?.client ?? client).get({ ...options, - url: '/api/v1/sources/{id}' + url: '/api/v1/sources/{sourceID}' }); } @@ -364,7 +364,7 @@ export class SourceService { public static updateSource(options: OptionsLegacyParser) { return (options?.client ?? client).put({ ...options, - url: '/api/v1/sources/{id}' + url: '/api/v1/sources/{sourceID}' }); } @@ -411,7 +411,7 @@ export class StackService { public static deleteStack(options: OptionsLegacyParser) { return (options?.client ?? client).delete({ ...options, - url: '/api/v1/stacks/{stack_id}' + url: '/api/v1/stacks/{stackID}' }); } @@ -422,7 +422,7 @@ export class StackService { public static getStack(options: OptionsLegacyParser) { return (options?.client ?? client).get({ ...options, - url: '/api/v1/stacks/{stack_id}' + url: '/api/v1/stacks/{stackID}' }); } @@ -433,7 +433,7 @@ export class StackService { public static updateStack(options: OptionsLegacyParser) { return (options?.client ?? client).put({ ...options, - url: '/api/v1/stacks/{stack_id}' + url: '/api/v1/stacks/{stackID}' }); } @@ -444,7 +444,7 @@ export class StackService { public static applyStack(options: OptionsLegacyParser) { return (options?.client ?? client).post({ ...options, - url: '/api/v1/stacks/{stack_id}/apply' + url: '/api/v1/stacks/{stackID}/apply' }); } @@ -455,7 +455,7 @@ export class StackService { public static applyStackAsync(options: OptionsLegacyParser) { return (options?.client ?? client).post({ ...options, - url: '/api/v1/stacks/{stack_id}/apply/async' + url: '/api/v1/stacks/{stackID}/apply/async' }); } @@ -466,7 +466,7 @@ export class StackService { public static destroyStack(options: OptionsLegacyParser) { return (options?.client ?? client).post({ ...options, - url: '/api/v1/stacks/{stack_id}/destroy' + url: '/api/v1/stacks/{stackID}/destroy' }); } @@ -477,7 +477,7 @@ export class StackService { public static destroyStackAsync(options: OptionsLegacyParser) { return (options?.client ?? client).post({ ...options, - url: '/api/v1/stacks/{stack_id}/destroy/async' + url: '/api/v1/stacks/{stackID}/destroy/async' }); } @@ -488,7 +488,7 @@ export class StackService { public static generateStack(options: OptionsLegacyParser) { return (options?.client ?? client).post({ ...options, - url: '/api/v1/stacks/{stack_id}/generate' + url: '/api/v1/stacks/{stackID}/generate' }); } @@ -499,7 +499,7 @@ export class StackService { public static generateStackAsync(options: OptionsLegacyParser) { return (options?.client ?? client).post({ ...options, - url: '/api/v1/stacks/{stack_id}/generate/async' + url: '/api/v1/stacks/{stackID}/generate/async' }); } @@ -510,7 +510,7 @@ export class StackService { public static previewStackAsync(options: OptionsLegacyParser) { return (options?.client ?? client).post({ ...options, - url: '/api/v1/stacks/{stack_id}/preview' + url: '/api/v1/stacks/{stackID}/preview' }); } @@ -546,7 +546,7 @@ export class WorkspaceService { public static deleteWorkspace(options: OptionsLegacyParser) { return (options?.client ?? client).delete({ ...options, - url: '/api/v1/workspaces/{id}' + url: '/api/v1/workspaces/{workspaceID}' }); } @@ -557,7 +557,7 @@ export class WorkspaceService { public static getWorkspace(options: OptionsLegacyParser) { return (options?.client ?? client).get({ ...options, - url: '/api/v1/workspaces/{id}' + url: '/api/v1/workspaces/{workspaceID}' }); } @@ -568,7 +568,7 @@ export class WorkspaceService { public static updateWorkspace(options: OptionsLegacyParser) { return (options?.client ?? client).put({ ...options, - url: '/api/v1/workspaces/{id}' + url: '/api/v1/workspaces/{workspaceID}' }); } @@ -579,7 +579,7 @@ export class WorkspaceService { public static getWorkspaceConfigs(options: OptionsLegacyParser) { return (options?.client ?? client).get({ ...options, - url: '/api/v1/workspaces/{id}/configs' + url: '/api/v1/workspaces/{workspaceID}/configs' }); } @@ -590,7 +590,7 @@ export class WorkspaceService { public static updateWorkspaceConfigs(options: OptionsLegacyParser) { return (options?.client ?? client).put({ ...options, - url: '/api/v1/workspaces/{id}/configs' + url: '/api/v1/workspaces/{workspaceID}/configs' }); } @@ -601,7 +601,7 @@ export class WorkspaceService { public static createWorkspaceModDeps(options: OptionsLegacyParser) { return (options?.client ?? client).post({ ...options, - url: '/api/v1/workspaces/{id}/configs/mod-deps' + url: '/api/v1/workspaces/{workspaceID}/configs/mod-deps' }); } diff --git a/src/client/types.gen.ts b/src/client/types.gen.ts index 9da8bf9..9323ff0 100644 --- a/src/client/types.gen.ts +++ b/src/client/types.gen.ts @@ -17,10 +17,10 @@ export enum constant_RunType { } export enum constant_SourceProviderType { - DefaultSourceType = 'git', - SourceProviderTypeGit = 'github', - SourceProviderTypeGithub = 'oci', - SourceProviderTypeOCI = 'local' + SourceProviderTypeGit = 'git', + SourceProviderTypeGithub = 'github', + SourceProviderTypeOCI = 'oci', + SourceProviderTypeLocal = 'local' } export enum constant_StackState { @@ -1385,7 +1385,7 @@ export type DeleteBackendData = { /** * Backend ID */ - id: number; + backendID: number; }; }; @@ -1400,7 +1400,7 @@ export type GetBackendData = { /** * Backend ID */ - id: number; + backendID: number; }; }; @@ -1419,7 +1419,7 @@ export type UpdateBackendData = { /** * Backend ID */ - id: number; + backendID: number; }; }; @@ -1478,7 +1478,7 @@ export type DeleteModuleData = { /** * Module Name */ - name: string; + moduleName: string; }; }; @@ -1493,7 +1493,7 @@ export type GetModuleData = { /** * Module Name */ - name: string; + moduleName: string; }; }; @@ -1512,7 +1512,7 @@ export type UpdateModuleData = { /** * Module Name */ - name: string; + moduleName: string; }; }; @@ -1559,7 +1559,7 @@ export type DeleteOrganizationData = { /** * Organization ID */ - id: number; + orgID: number; }; }; @@ -1574,7 +1574,7 @@ export type GetOrganizationData = { /** * Organization ID */ - id: number; + orgID: number; }; }; @@ -1593,7 +1593,7 @@ export type UpdateOrganizationData = { /** * Organization ID */ - id: number; + orgID: number; }; }; @@ -1648,7 +1648,7 @@ export type DeleteProjectData = { /** * Project ID */ - project_id: number; + projectID: number; }; }; @@ -1663,7 +1663,7 @@ export type GetProjectData = { /** * Project ID */ - project_id: number; + projectID: number; }; }; @@ -1682,7 +1682,7 @@ export type UpdateProjectData = { /** * Project ID */ - project_id: number; + projectID: number; }; }; @@ -1694,6 +1694,10 @@ export type UpdateProjectError = (unknown); export type ListResourceData = { query?: { + /** + * The organization ID + */ + orgID?: number; /** * The current page to fetch. Default to 1 */ @@ -1702,6 +1706,22 @@ export type ListResourceData = { * The size of the page. Default to 10 */ pageSize?: number; + /** + * The project ID + */ + projectID?: number; + /** + * The resource plane + */ + resourcePlane?: string; + /** + * The resource type + */ + resourceType?: string; + /** + * The stack ID + */ + stackID?: number; }; }; @@ -1716,7 +1736,7 @@ export type GetResourceData = { /** * Resource ID */ - id: number; + resourceID: number; }; }; @@ -1731,7 +1751,7 @@ export type GetResourceGraphData = { /** * Stack ID */ - stack_id: number; + stackID: number; }; }; @@ -1746,7 +1766,7 @@ export type GetRunData = { /** * Run ID */ - run: number; + runID: number; }; }; @@ -1761,7 +1781,7 @@ export type GetRunResultData = { /** * Run ID */ - run: number; + runID: number; }; }; @@ -1812,7 +1832,7 @@ export type DeleteSourceData = { /** * Source ID */ - id: number; + sourceID: number; }; }; @@ -1827,7 +1847,7 @@ export type GetSourceData = { /** * Source ID */ - id: number; + sourceID: number; }; }; @@ -1846,7 +1866,7 @@ export type UpdateSourceData = { /** * Source ID */ - id: number; + sourceID: number; }; }; @@ -1858,22 +1878,10 @@ export type UpdateSourceError = (unknown); export type ListRunData = { query?: { - /** - * Cloud to filter runs by. Default to all - */ - cloud?: string; /** * EndTime to filter runs by. Default to all. Format: RFC3339 */ endTime?: string; - /** - * Environment to filter runs by. Default to all - */ - env?: string; - /** - * OrgID to filter runs by. Default to all - */ - orgID?: number; /** * The current page to fetch. Default to 1 */ @@ -1886,10 +1894,6 @@ export type ListRunData = { * ProjectID to filter runs by. Default to all */ projectID?: number; - /** - * ProjectName to filter runs by. Default to all - */ - projectName?: string; /** * StackID to filter runs by. Default to all */ @@ -1921,14 +1925,6 @@ export type ListRunError = (unknown); export type ListStackData = { query?: { - /** - * Cloud to filter stacks by. Default to all - */ - cloud?: string; - /** - * Environment to filter stacks by. Default to all - */ - env?: string; /** * OrgID to filter stacks by. Default to all */ @@ -1941,6 +1937,10 @@ export type ListStackData = { * The size of the page. Default to 10 */ pageSize?: number; + /** + * Path to filter stacks by. Default to all + */ + path?: string; /** * ProjectID to filter stacks by. Default to all */ @@ -1986,7 +1986,7 @@ export type DeleteStackData = { /** * Stack ID */ - stack_id: number; + stackID: number; }; }; @@ -2001,7 +2001,7 @@ export type GetStackData = { /** * Stack ID */ - stack_id: number; + stackID: number; }; }; @@ -2020,7 +2020,7 @@ export type UpdateStackData = { /** * Stack ID */ - stack_id: number; + stackID: number; }; }; @@ -2039,7 +2039,7 @@ export type ApplyStackData = { /** * Stack ID */ - stack_id: number; + stackID: number; }; query: { /** @@ -2080,7 +2080,7 @@ export type ApplyStackAsyncData = { /** * Stack ID */ - stack_id: number; + stackID: number; }; query: { /** @@ -2117,7 +2117,7 @@ export type DestroyStackData = { /** * Stack ID */ - stack_id: number; + stackID: number; }; query: { /** @@ -2146,7 +2146,7 @@ export type DestroyStackAsyncData = { /** * Stack ID */ - stack_id: number; + stackID: number; }; query: { /** @@ -2175,7 +2175,7 @@ export type GenerateStackData = { /** * Stack ID */ - stack_id: number; + stackID: number; }; query: { /** @@ -2204,7 +2204,7 @@ export type GenerateStackAsyncData = { /** * Stack ID */ - stack_id: number; + stackID: number; }; query: { /** @@ -2237,7 +2237,7 @@ export type PreviewStackAsyncData = { /** * Stack ID */ - stack_id: number; + stackID: number; }; query: { /** @@ -2275,6 +2275,10 @@ export type PreviewStackAsyncError = (unknown); export type ListWorkspaceData = { query?: { + /** + * BackendID to filter workspaces by. Default to all + */ + backendID?: number; /** * The current page to fetch. Default to 1 */ @@ -2310,7 +2314,7 @@ export type DeleteWorkspaceData = { /** * Workspace ID */ - id: number; + workspaceID: number; }; }; @@ -2325,7 +2329,7 @@ export type GetWorkspaceData = { /** * Workspace ID */ - id: number; + workspaceID: number; }; }; @@ -2344,7 +2348,7 @@ export type UpdateWorkspaceData = { /** * Workspace ID */ - id: number; + workspaceID: number; }; }; @@ -2359,7 +2363,7 @@ export type GetWorkspaceConfigsData = { /** * Workspace ID */ - id: number; + workspaceID: number; }; }; @@ -2376,7 +2380,7 @@ export type UpdateWorkspaceConfigsData = { /** * Workspace ID */ - id: number; + workspaceID: number; }; }; @@ -2389,7 +2393,7 @@ export type CreateWorkspaceModDepsData = { /** * Workspace ID */ - id: number; + workspaceID: number; }; };