Improvement: Add securitySchemes and per-operation security declarations to management OpenAPI spec
Open
@Krishanx92 is already working on this.
Since Mar 23, 2026.
- Dominant language
- Go
- Stars
- 71
- Forks
- 111
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 110
Description
Summary
The gateway/gateway-controller/api/management-openapi.yaml currently omits components.securitySchemes and per-operation security declarations across all protected endpoints (Rest API, WebSub, LLM Provider, LLM Proxy, Certificates, Secrets Management, etc.). This means the OpenAPI contract does not specify how clients must authenticate, even though endpoints advertise 401 Unauthorized responses.
Problem
- No
components.securitySchemesentry is defined anywhere in the spec. - No
securityrequirement is attached to any operation that returns401. - Clients cannot determine the authentication mechanism from the spec alone.
Proposed Improvement
- Define a
components.securitySchemesentry (e.g., HTTP Bearer / JWT or API key header) appropriate to the gateway controller's auth mechanism. - Attach the corresponding
securityrequirement to all protected operations across all endpoint groups. - Update any example requests or description text to reference the scheme where relevant.
References
- Identified in PR: https://github.com/wso2/api-platform/pull/1438
- Discussion comment: https://github.com/wso2/api-platform/pull/1438#discussion_r2972610392
- Requested by: @nimsara66
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.