Skip to content

fix: correct naming #9

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.

Sign up for GitHub

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

Merged
Yangyang96 merged 1 commit into from
Jan 15, 2025
+344 −3
Merged

fix: correct naming #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
107 changes: 107 additions & 0 deletions api/openapispec/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3038,6 +3038,113 @@ const docTemplate = `{
}
},
"/api/v1/stacks/{stackID}/preview": {
"post": {
"description": "Preview stack information by stack ID",
"produces": [
"application/json"
],
"tags": [
"stack"
],
"summary": "Preview stack",
"operationId": "previewStack",
"parameters": [
{
"type": "integer",
"description": "Stack ID",
"name": "stackID",
"in": "path",
"required": true
},
{
"description": "The resources to import during the stack preview",
"name": "importedResources",
"in": "body",
"schema": {
"$ref": "#/definitions/request.StackImportRequest"
}
},
{
"type": "string",
"description": "The target workspace to preview the spec in.",
"name": "workspace",
"in": "query",
"required": true
},
{
"type": "boolean",
"description": "Import existing resources during the stack preview",
"name": "importResources",
"in": "query"
},
{
"type": "string",
"description": "Output format. Choices are: json, default. Default to default output format in Kusion.",
"name": "output",
"in": "query"
},
{
"type": "boolean",
"description": "Show detailed output",
"name": "detail",
"in": "query"
},
{
"type": "string",
"description": "The Spec ID to use for the preview. Default to the last one generated.",
"name": "specID",
"in": "query"
},
{
"type": "boolean",
"description": "Force the preview even when the stack is locked",
"name": "force",
"in": "query"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"allOf": [
{
"$ref": "#/definitions/handler.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/models.Changes"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {}
},
"401": {
"description": "Unauthorized",
"schema": {}
},
"404": {
"description": "Not Found",
"schema": {}
},
"429": {
"description": "Too Many Requests",
"schema": {}
},
"500": {
"description": "Internal Server Error",
"schema": {}
}
}
}
},
"/api/v1/stacks/{stackID}/preview/async": {
"post": {
"description": "Start a run and asynchronously preview stack changes by stack ID",
"produces": [
Expand Down
107 changes: 107 additions & 0 deletions api/openapispec/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3027,6 +3027,113 @@
}
},
"/api/v1/stacks/{stackID}/preview": {
"post": {
"description": "Preview stack information by stack ID",
"produces": [
"application/json"
],
"tags": [
"stack"
],
"summary": "Preview stack",
"operationId": "previewStack",
"parameters": [
{
"type": "integer",
"description": "Stack ID",
"name": "stackID",
"in": "path",
"required": true
},
{
"description": "The resources to import during the stack preview",
"name": "importedResources",
"in": "body",
"schema": {
"$ref": "#/definitions/request.StackImportRequest"
}
},
{
"type": "string",
"description": "The target workspace to preview the spec in.",
"name": "workspace",
"in": "query",
"required": true
},
{
"type": "boolean",
"description": "Import existing resources during the stack preview",
"name": "importResources",
"in": "query"
},
{
"type": "string",
"description": "Output format. Choices are: json, default. Default to default output format in Kusion.",
"name": "output",
"in": "query"
},
{
"type": "boolean",
"description": "Show detailed output",
"name": "detail",
"in": "query"
},
{
"type": "string",
"description": "The Spec ID to use for the preview. Default to the last one generated.",
"name": "specID",
"in": "query"
},
{
"type": "boolean",
"description": "Force the preview even when the stack is locked",
"name": "force",
"in": "query"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"allOf": [
{
"$ref": "#/definitions/handler.Response"
},
{
"type": "object",
"properties": {
"data": {
"$ref": "#/definitions/models.Changes"
}
}
}
]
}
},
"400": {
"description": "Bad Request",
"schema": {}
},
"401": {
"description": "Unauthorized",
"schema": {}
},
"404": {
"description": "Not Found",
"schema": {}
},
"429": {
"description": "Too Many Requests",
"schema": {}
},
"500": {
"description": "Internal Server Error",
"schema": {}
}
}
}
},
"/api/v1/stacks/{stackID}/preview/async": {
"post": {
"description": "Start a run and asynchronously preview stack changes by stack ID",
"produces": [
Expand Down
71 changes: 71 additions & 0 deletions api/openapispec/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3394,6 +3394,77 @@ paths:
tags:
- stack
/api/v1/stacks/{stackID}/preview:
post:
description: Preview stack information by stack ID
operationId: previewStack
parameters:
- description: Stack ID
in: path
name: stackID
required: true
type: integer
- description: The resources to import during the stack preview
in: body
name: importedResources
schema:
$ref: '#/definitions/request.StackImportRequest'
- description: The target workspace to preview the spec in.
in: query
name: workspace
required: true
type: string
- description: Import existing resources during the stack preview
in: query
name: importResources
type: boolean
- description: 'Output format. Choices are: json, default. Default to default
output format in Kusion.'
in: query
name: output
type: string
- description: Show detailed output
in: query
name: detail
type: boolean
- description: The Spec ID to use for the preview. Default to the last one generated.
in: query
name: specID
type: string
- description: Force the preview even when the stack is locked
in: query
name: force
type: boolean
produces:
- application/json
responses:
"200":
description: Success
schema:
allOf:
- $ref: '#/definitions/handler.Response'
- properties:
data:
$ref: '#/definitions/models.Changes'
type: object
"400":
description: Bad Request
schema: {}
"401":
description: Unauthorized
schema: {}
"404":
description: Not Found
schema: {}
"429":
description: Too Many Requests
schema: {}
"500":
description: Internal Server Error
schema: {}
summary: Preview stack
tags:
- stack
/api/v1/stacks/{stackID}/preview/async:
post:
description: Start a run and asynchronously preview stack changes by stack ID
operationId: previewStackAsync
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@kusionstack/kusion-api-client-sdk",
"version": "1.1.3",
"version": "1.1.4",
"description": "Kusion API Client SDK",
"main": "dist/src/client/index.js",
"types": "dist/src/client/index.d.ts",
Expand Down
15 changes: 13 additions & 2 deletions src/client/sdk.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// This file is auto-generated by @hey-api/openapi-ts

import { createClient, createConfig, type OptionsLegacyParser } from '@hey-api/client-fetch';
import type { ListBackendData, ListBackendError, ListBackendResponse, CreateBackendData, CreateBackendError, CreateBackendResponse, DeleteBackendData, DeleteBackendError, DeleteBackendResponse, GetBackendData, GetBackendError, GetBackendResponse, UpdateBackendData, UpdateBackendError, UpdateBackendResponse, GetEndpointsError, GetEndpointsResponse, ListModuleData, ListModuleError, ListModuleResponse, CreateModuleData, CreateModuleError, CreateModuleResponse, DeleteModuleData, DeleteModuleError, DeleteModuleResponse, GetModuleData, GetModuleError, GetModuleResponse, UpdateModuleData, UpdateModuleError, UpdateModuleResponse, ListOrganizationData, ListOrganizationError, ListOrganizationResponse, CreateOrganizationData, CreateOrganizationError, CreateOrganizationResponse, DeleteOrganizationData, DeleteOrganizationError, DeleteOrganizationResponse, GetOrganizationData, GetOrganizationError, GetOrganizationResponse, UpdateOrganizationData, UpdateOrganizationError, UpdateOrganizationResponse, ListProjectData, ListProjectError, ListProjectResponse, CreateProjectData, CreateProjectError, CreateProjectResponse, DeleteProjectData, DeleteProjectError, DeleteProjectResponse, GetProjectData, GetProjectError, GetProjectResponse, UpdateProjectData, UpdateProjectError, UpdateProjectResponse, ListResourceData, ListResourceError, ListResourceResponse, GetResourceData, GetResourceError, GetResourceResponse, GetResourceGraphData, GetResourceGraphError, GetResourceGraphResponse, GetRunData, GetRunError, GetRunResponse, GetRunResultData, GetRunResultError, GetRunResultResponse, ListSourceData, ListSourceError, ListSourceResponse, CreateSourceData, CreateSourceError, CreateSourceResponse, DeleteSourceData, DeleteSourceError, DeleteSourceResponse, GetSourceData, GetSourceError, GetSourceResponse, UpdateSourceData, UpdateSourceError, UpdateSourceResponse, ListRunData, ListRunError, ListRunResponse, ListStackData, ListStackError, ListStackResponse, CreateStackData, CreateStackError, CreateStackResponse, DeleteStackData, DeleteStackError, DeleteStackResponse, GetStackData, GetStackError, GetStackResponse, UpdateStackData, UpdateStackError, UpdateStackResponse, ApplyStackData, ApplyStackError, ApplyStackResponse, ApplyStackAsyncData, ApplyStackAsyncError, ApplyStackAsyncResponse, DestroyStackData, DestroyStackError, DestroyStackResponse, DestroyStackAsyncData, DestroyStackAsyncError, DestroyStackAsyncResponse, GenerateStackData, GenerateStackError, GenerateStackResponse, GenerateStackAsyncData, GenerateStackAsyncError, GenerateStackAsyncResponse, PreviewStackAsyncData, PreviewStackAsyncError, PreviewStackAsyncResponse, ListWorkspaceData, ListWorkspaceError, ListWorkspaceResponse, CreateWorkspaceData, CreateWorkspaceError, CreateWorkspaceResponse, DeleteWorkspaceData, DeleteWorkspaceError, DeleteWorkspaceResponse, GetWorkspaceData, GetWorkspaceError, GetWorkspaceResponse, UpdateWorkspaceData, UpdateWorkspaceError, UpdateWorkspaceResponse, GetWorkspaceConfigsData, GetWorkspaceConfigsError, GetWorkspaceConfigsResponse, UpdateWorkspaceConfigsData, UpdateWorkspaceConfigsError, UpdateWorkspaceConfigsResponse, CreateWorkspaceModDepsData, CreateWorkspaceModDepsError, CreateWorkspaceModDepsResponse, ValidateWorkspaceConfigsData, ValidateWorkspaceConfigsError, ValidateWorkspaceConfigsResponse } from './types.gen';
import type { ListBackendData, ListBackendError, ListBackendResponse, CreateBackendData, CreateBackendError, CreateBackendResponse, DeleteBackendData, DeleteBackendError, DeleteBackendResponse, GetBackendData, GetBackendError, GetBackendResponse, UpdateBackendData, UpdateBackendError, UpdateBackendResponse, GetEndpointsError, GetEndpointsResponse, ListModuleData, ListModuleError, ListModuleResponse, CreateModuleData, CreateModuleError, CreateModuleResponse, DeleteModuleData, DeleteModuleError, DeleteModuleResponse, GetModuleData, GetModuleError, GetModuleResponse, UpdateModuleData, UpdateModuleError, UpdateModuleResponse, ListOrganizationData, ListOrganizationError, ListOrganizationResponse, CreateOrganizationData, CreateOrganizationError, CreateOrganizationResponse, DeleteOrganizationData, DeleteOrganizationError, DeleteOrganizationResponse, GetOrganizationData, GetOrganizationError, GetOrganizationResponse, UpdateOrganizationData, UpdateOrganizationError, UpdateOrganizationResponse, ListProjectData, ListProjectError, ListProjectResponse, CreateProjectData, CreateProjectError, CreateProjectResponse, DeleteProjectData, DeleteProjectError, DeleteProjectResponse, GetProjectData, GetProjectError, GetProjectResponse, UpdateProjectData, UpdateProjectError, UpdateProjectResponse, ListResourceData, ListResourceError, ListResourceResponse, GetResourceData, GetResourceError, GetResourceResponse, GetResourceGraphData, GetResourceGraphError, GetResourceGraphResponse, GetRunData, GetRunError, GetRunResponse, GetRunResultData, GetRunResultError, GetRunResultResponse, ListSourceData, ListSourceError, ListSourceResponse, CreateSourceData, CreateSourceError, CreateSourceResponse, DeleteSourceData, DeleteSourceError, DeleteSourceResponse, GetSourceData, GetSourceError, GetSourceResponse, UpdateSourceData, UpdateSourceError, UpdateSourceResponse, ListRunData, ListRunError, ListRunResponse, ListStackData, ListStackError, ListStackResponse, CreateStackData, CreateStackError, CreateStackResponse, DeleteStackData, DeleteStackError, DeleteStackResponse, GetStackData, GetStackError, GetStackResponse, UpdateStackData, UpdateStackError, UpdateStackResponse, ApplyStackData, ApplyStackError, ApplyStackResponse, ApplyStackAsyncData, ApplyStackAsyncError, ApplyStackAsyncResponse, DestroyStackData, DestroyStackError, DestroyStackResponse, DestroyStackAsyncData, DestroyStackAsyncError, DestroyStackAsyncResponse, GenerateStackData, GenerateStackError, GenerateStackResponse, GenerateStackAsyncData, GenerateStackAsyncError, GenerateStackAsyncResponse, PreviewStackData, PreviewStackError, PreviewStackResponse, PreviewStackAsyncData, PreviewStackAsyncError, PreviewStackAsyncResponse, ListWorkspaceData, ListWorkspaceError, ListWorkspaceResponse, CreateWorkspaceData, CreateWorkspaceError, CreateWorkspaceResponse, DeleteWorkspaceData, DeleteWorkspaceError, DeleteWorkspaceResponse, GetWorkspaceData, GetWorkspaceError, GetWorkspaceResponse, UpdateWorkspaceData, UpdateWorkspaceError, UpdateWorkspaceResponse, GetWorkspaceConfigsData, GetWorkspaceConfigsError, GetWorkspaceConfigsResponse, UpdateWorkspaceConfigsData, UpdateWorkspaceConfigsError, UpdateWorkspaceConfigsResponse, CreateWorkspaceModDepsData, CreateWorkspaceModDepsError, CreateWorkspaceModDepsResponse, ValidateWorkspaceConfigsData, ValidateWorkspaceConfigsError, ValidateWorkspaceConfigsResponse } from './types.gen';

export const client = createClient(createConfig());

Expand Down Expand Up @@ -503,14 +503,25 @@ export class StackService {
});
}

/**
* Preview stack
* Preview stack information by stack ID
*/
public static previewStack<ThrowOnError extends boolean = false>(options: OptionsLegacyParser<PreviewStackData, ThrowOnError>) {
return (options?.client ?? client).post<PreviewStackResponse, PreviewStackError, ThrowOnError>({
...options,
url: '/api/v1/stacks/{stackID}/preview'
});
}

/**
* Asynchronously preview stack
* Start a run and asynchronously preview stack changes by stack ID
*/
public static previewStackAsync<ThrowOnError extends boolean = false>(options: OptionsLegacyParser<PreviewStackAsyncData, ThrowOnError>) {
return (options?.client ?? client).post<PreviewStackAsyncResponse, PreviewStackAsyncError, ThrowOnError>({
...options,
url: '/api/v1/stacks/{stackID}/preview'
url: '/api/v1/stacks/{stackID}/preview/async'
});
}

Expand Down
Loading
Loading