wso2 / wso2/api-platform

[Feature]: Supported Gateway Versions in Platform API

Open
#1,711 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area/Gateway Area/Management Aspect/API
Dominant language
Go
Stars
71
Forks
111
Avg merge
1d 14h
Merged PRs (30d)
110

Description

Please select the area the issue is related to

Area/Gateway (Routing, API deployment in gateway etc.), Area/Management (Management API or Management Portal UI)

Please select the aspect the issue is related to

Aspect/API (API backends, definitions, contracts, interfaces, OpenAPI)

Suggested Feature

The existing Platform API doesn't specify a version when registering a gateway.
Eg: gateway v1.0.0 reads the project ID from labels, gateway v1.1.0 reads the project ID from annotations.

This can be avoided by supporting the platform API to send the project ID via labels + annotations. But in the future, we may add more changes, which require this kind of change.

Related Issues

No response

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.

Research direction

Start by tracing the Platform API's gateway-registration request and its API contract. Review how gateway versions and project IDs are represented today, then define the version and compatibility behavior for registration. Done means the API can distinguish supported gateway versions and has coverage for the relevant registration cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.