wso2 / wso2/api-platform

Improvement: Add securitySchemes and per-operation security declarations to management OpenAPI spec

Open
#1,440 0 comments 0 reactions 1 assignee View on GitHub

@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.securitySchemes entry is defined anywhere in the spec.
  • No security requirement is attached to any operation that returns 401.
  • Clients cannot determine the authentication mechanism from the spec alone.

Proposed Improvement

  1. Define a components.securitySchemes entry (e.g., HTTP Bearer / JWT or API key header) appropriate to the gateway controller's auth mechanism.
  2. Attach the corresponding security requirement to all protected operations across all endpoint groups.
  3. Update any example requests or description text to reference the scheme where relevant.

References

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.