Skip to content
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

Jump to bottom

feat: add workspace config apis for kusion server #1311

Merged
merged 2 commits into from
Nov 14, 2024
Merged

feat: add workspace config apis for kusion server #1311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf9cf09
feat: add workspace config apis for kusion server
liu-hm19 Nov 14, 2024
3589285
fix: a lint error
liu-hm19 Nov 14, 2024
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
302 changes: 302 additions & 0 deletions api/openapispec/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2565,6 +2565,61 @@ const docTemplate = `{
}
}
},
"/api/v1/workspaces/configs/validate": {
"post": {
"description": "Validate the configurations in the specified workspace",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"workspace"
],
"summary": "Validate workspace configurations",
"operationId": "validateWorkspaceConfigs",
"parameters": [
{
"description": "Workspace configurations to be validated",
"name": "workspace",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.WorkspaceConfigs"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/request.WorkspaceConfigs"
}
},
"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/workspaces/{id}": {
"get": {
"description": "Get workspace information by workspace ID",
Expand Down Expand Up @@ -2723,6 +2778,172 @@ const docTemplate = `{
}
}
},
"/api/v1/workspaces/{id}/configs": {
"get": {
"description": "Get configurations in the specified workspace",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"workspace"
],
"summary": "get workspace configurations",
"operationId": "getWorkspaceConfigs",
"parameters": [
{
"type": "integer",
"description": "Workspace ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/request.WorkspaceConfigs"
}
},
"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": {}
}
}
},
"put": {
"description": "Update the configurations in the specified workspace",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"workspace"
],
"summary": "Update workspace configurations",
"operationId": "updateWorkspaceConfigs",
"parameters": [
{
"type": "integer",
"description": "Workspace ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Updated workspace configurations",
"name": "workspace",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/request.WorkspaceConfigs"
}
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/request.WorkspaceConfigs"
}
},
"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/workspaces/{id}/configs/mod-deps": {
"post": {
"description": "Create the module dependencies in kcl.mod of the specified workspace",
"consumes": [
"application/json"
],
"produces": [
"text/plain"
],
"tags": [
"workspace"
],
"summary": "Create the module dependencies of the workspace",
"operationId": "createWorkspaceModDeps",
"parameters": [
{
"type": "integer",
"description": "Workspace ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"type": "string"
}
},
"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": {}
}
}
}
},
"/endpoints": {
"get": {
"description": "List all registered endpoints in the router",
Expand Down Expand Up @@ -4045,6 +4266,35 @@ const docTemplate = `{
}
}
},
"request.WorkspaceConfigs": {
"type": "object",
"properties": {
"context": {
"description": "Context contains workspace-level configurations, such as runtimes, topologies, and metadata, etc.",
"allOf": [
{
"$ref": "#/definitions/v1.GenericConfig"
}
]
},
"modules": {
"description": "Modules are the configs of a set of modules.",
"allOf": [
{
"$ref": "#/definitions/v1.ModuleConfigs"
}
]
},
"secretStore": {
"description": "SecretStore represents a secure external location for storing secrets.",
"allOf": [
{
"$ref": "#/definitions/v1.SecretStore"
}
]
}
}
},
"url.URL": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -4172,6 +4422,19 @@ const docTemplate = `{
}
}
},
"v1.Configs": {
"type": "object",
"properties": {
"default": {
"description": "Default is default block of the module config.",
"allOf": [
{
"$ref": "#/definitions/v1.GenericConfig"
}
]
}
}
},
"v1.FakeProvider": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -4207,6 +4470,45 @@ const docTemplate = `{
"type": "object",
"additionalProperties": {}
},
"v1.ModuleConfig": {
"type": "object",
"properties": {
"configs": {
"description": "Configs contains all levels of module configs",
"allOf": [
{
"$ref": "#/definitions/v1.Configs"
}
]
},
"path": {
"description": "Path is the path of the module. It can be a local path or a remote URL",
"type": "string"
},
"version": {
"description": "Version is the version of the module.",
"type": "string"
}
}
},
"v1.ModuleConfigs": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/v1.ModuleConfig"
}
},
"v1.ModulePatcherConfig": {
"type": "object",
"properties": {
"projectSelector": {
"description": "ProjectSelector contains the selected projects.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1.OnPremisesProvider": {
"type": "object",
"properties": {
Expand Down
Loading
Loading