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.

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

Swagger API documentation missing for a number of Kubernetes APIs #10106

Closed
2 tasks done
jamest-portainer opened this issue Aug 24, 2023 · 0 comments · Fixed by #8843
Closed
2 tasks done

Swagger API documentation missing for a number of Kubernetes APIs #10106

jamest-portainer opened this issue Aug 24, 2023 · 0 comments · Fixed by #8843
Labels
Milestone

Comments

@jamest-portainer
Copy link

Before you start please confirm the following.

Problem Description

In the Kubernetes handlers there are quite a few API endpoints with missing Swagger (OpenAPI) docs,

e.g.
configmaps_and_secrets.go :-
getKubernetesConfigMaps

ingresses.go :-
getKubernetesIngressControllers,
getKubernetesIngressControllersByName

namespace.go :-
getKubernetesNamespaces,
getKubernetesNamespace,
createKubernetesNamespace,
updateKubernetesNamespace,
deleteKubernetesNamespace

services.go -
getKubernetesServices,
createKubernetesService,
deleteKubernetesServices,
updateKubernetesService

Expected Behavior

Kubernetes API endpoints should be documented in the Swagger (OpenAPI) docs.

Actual Behavior

Not all of our Kubernetes API endpoints are documented in the Swagger (OpenAPI) docs.

Steps to Reproduce

N/A (other than looking at the API docs).

Portainer logs or screenshots

No response

Portainer version

2.18.4

Portainer Edition

Community Edition (CE)

Platform and Version

API - Kubernetes endpoints

OS and Architecture

N/A

Browser

No response

What command did you use to deploy Portainer?

No response

Additional Information

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant