homelab/portainer
1
0
Fork 0
mirror of https://github.com/portainer/portainer.git synced 2026-08-07 10:54:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix(api-docs) fix api spec and handler mismatches (#3104)

Browse Source
This commit is contained in:
Hannah Cooper
2026-07-20 11:10:12 +12:00
committed by GitHub
parent 2b7b8b492e
commit e465128e29
8 changed files with 433 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/docs/openapi.yaml
+100 -9
View File
@@ -4839,7 +4839,7 @@ paths:
"/kubernetes/{id}/namespaces":
delete:
description: |-
Delete a kubernetes namespace within the given environment.
Delete one or more kubernetes namespaces within the given environment.
**Access policy**: Authenticated user.
operationId: DeleteKubernetesNamespace
parameters:
@@ -4849,6 +4849,15 @@ paths:
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
items:
type: string
type: array
description: List of namespace names to delete
required: true
responses:
"200":
description: Success
@@ -4866,7 +4875,7 @@ paths:
security:
- ApiKeyAuth: []
jwt: []
summary: Delete a kubernetes namespace
summary: Delete kubernetes namespaces
tags:
- kubernetes
get:
@@ -4889,14 +4898,12 @@ paths:
the Namespace information. Default is false
in: query
name: withResourceQuota
required: true
schema:
type: boolean
- description: When set to true, include the unhealthy events information as part
of the Namespace information. Default is false
in: query
name: withUnhealthyEvents
required: true
schema:
type: boolean
responses:
@@ -4956,7 +4963,7 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/portainer.K8sNamespaceInfo"
$ref: "#/components/schemas/kubernetes.KubernetesCreateNamespaceResponse"
"400":
description: Invalid request payload, such as missing required fields or fields
not meeting validation criteria.
@@ -5054,7 +5061,6 @@ paths:
the Namespace information. Default is false
in: query
name: withResourceQuota
required: true
schema:
type: boolean
responses:
@@ -8589,7 +8595,7 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/portainer.Stack"
$ref: "#/components/schemas/stacks.createKubernetesStackResponse"
"400":
description: Invalid request
"409":
@@ -8630,7 +8636,7 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/portainer.Stack"
$ref: "#/components/schemas/stacks.createKubernetesStackResponse"
"400":
description: Invalid request
"500":
@@ -8669,7 +8675,7 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/portainer.Stack"
$ref: "#/components/schemas/stacks.createKubernetesStackResponse"
"400":
description: Invalid request
"500":
@@ -13240,6 +13246,64 @@ components:
storageClass:
$ref: "#/components/schemas/kubernetes.K8sStorageClass"
type: object
kubernetes.KubernetesCreateNamespaceResponse:
properties:
apiVersion:
description: >-
APIVersion defines the versioned schema of this representation of an
object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+optional
type: string
kind:
description: >-
Kind is a string value representing the REST resource this object
represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+optional
type: string
metadata:
allOf:
- $ref: "#/components/schemas/v1.ObjectMeta"
description: >-
Standard object's metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+optional
spec:
allOf:
- $ref: "#/components/schemas/v1.NamespaceSpec"
description: >-
Spec defines the behavior of the Namespace.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
+optional
status:
allOf:
- $ref: "#/components/schemas/v1.NamespaceStatus"
description: >-
Status describes the current status of a Namespace.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
+optional
type: object
kubernetes.KubernetesNodeResponse:
properties:
apiVersion:
@@ -16889,6 +16953,11 @@ components:
required:
- Name
type: object
stacks.createKubernetesStackResponse:
properties:
Output:
type: string
type: object
stacks.kubernetesGitDeploymentPayload:
properties:
AdditionalFiles:
@@ -18699,6 +18768,12 @@ components:
+required
type: string
type: object
v1.FinalizerName:
enum:
- kubernetes
type: string
x-enum-varnames:
- FinalizerKubernetes
v1.GRPCAction:
properties:
port:
@@ -19042,6 +19117,22 @@ components:
x-enum-varnames:
- NamespaceActive
- NamespaceTerminating
v1.NamespaceSpec:
properties:
finalizers:
description: >-
Finalizers is an opaque list of values that must be empty to
permanently remove object from storage.
More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
+optional
+listType=atomic
items:
$ref: "#/components/schemas/v1.FinalizerName"
type: array
type: object
v1.NamespaceStatus:
properties:
conditions:
api/docs/swagger.yaml
+80 -9
View File
@@ -2342,6 +2342,47 @@ definitions:
storageClass:
$ref: '#/definitions/kubernetes.K8sStorageClass'
type: object
kubernetes.KubernetesCreateNamespaceResponse:
properties:
apiVersion:
description: |-
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+optional
type: string
kind:
description: |-
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+optional
type: string
metadata:
allOf:
- $ref: '#/definitions/v1.ObjectMeta'
description: |-
Standard object's metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+optional
spec:
allOf:
- $ref: '#/definitions/v1.NamespaceSpec'
description: |-
Spec defines the behavior of the Namespace.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
+optional
status:
allOf:
- $ref: '#/definitions/v1.NamespaceStatus'
description: |-
Status describes the current status of a Namespace.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
+optional
type: object
kubernetes.KubernetesNodeResponse:
properties:
apiVersion:
@@ -5914,6 +5955,11 @@ definitions:
required:
- Name
type: object
stacks.createKubernetesStackResponse:
properties:
Output:
type: string
type: object
stacks.kubernetesGitDeploymentPayload:
properties:
AdditionalFiles:
@@ -7449,6 +7495,12 @@ definitions:
+required
type: string
type: object
v1.FinalizerName:
enum:
- kubernetes
type: string
x-enum-varnames:
- FinalizerKubernetes
v1.GRPCAction:
properties:
port:
@@ -7720,6 +7772,18 @@ definitions:
x-enum-varnames:
- NamespaceActive
- NamespaceTerminating
v1.NamespaceSpec:
properties:
finalizers:
description: |-
Finalizers is an opaque list of values that must be empty to permanently remove object from storage.
More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
+optional
+listType=atomic
items:
$ref: '#/definitions/v1.FinalizerName'
type: array
type: object
v1.NamespaceStatus:
properties:
conditions:
@@ -14326,8 +14390,10 @@ paths:
- kubernetes
/kubernetes/{id}/namespaces:
delete:
consumes:
- application/json
description: |-
Delete a kubernetes namespace within the given environment.
Delete one or more kubernetes namespaces within the given environment.
**Access policy**: Authenticated user.
operationId: DeleteKubernetesNamespace
parameters:
@@ -14336,6 +14402,14 @@ paths:
name: id
required: true
type: integer
- description: List of namespace names to delete
in: body
name: body
required: true
schema:
items:
type: string
type: array
responses:
"200":
description: Success
@@ -14351,7 +14425,7 @@ paths:
security:
- ApiKeyAuth: []
jwt: []
summary: Delete a kubernetes namespace
summary: Delete kubernetes namespaces
tags:
- kubernetes
get:
@@ -14369,13 +14443,11 @@ paths:
of the Namespace information. Default is false
in: query
name: withResourceQuota
required: true
type: boolean
- description: When set to true, include the unhealthy events information as
part of the Namespace information. Default is false
in: query
name: withUnhealthyEvents
required: true
type: boolean
produces:
- application/json
@@ -14433,7 +14505,7 @@ paths:
"200":
description: Success
schema:
$ref: '#/definitions/portainer.K8sNamespaceInfo'
$ref: '#/definitions/kubernetes.KubernetesCreateNamespaceResponse'
"400":
description: Invalid request payload, such as missing required fields or
fields not meeting validation criteria.
@@ -14529,7 +14601,6 @@ paths:
of the Namespace information. Default is false
in: query
name: withResourceQuota
required: true
type: boolean
produces:
- application/json
@@ -17952,7 +18023,7 @@ paths:
"200":
description: OK
schema:
$ref: '#/definitions/portainer.Stack'
$ref: '#/definitions/stacks.createKubernetesStackResponse'
"400":
description: Invalid request
"409":
@@ -17990,7 +18061,7 @@ paths:
"200":
description: OK
schema:
$ref: '#/definitions/portainer.Stack'
$ref: '#/definitions/stacks.createKubernetesStackResponse'
"400":
description: Invalid request
"500":
@@ -18026,7 +18097,7 @@ paths:
"200":
description: OK
schema:
$ref: '#/definitions/portainer.Stack'
$ref: '#/definitions/stacks.createKubernetesStackResponse'
"400":
description: Invalid request
"500":