Skip to content

feat(platform-api): support upstreamDefinitions pool and per-operation upstream overrides #2155

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.

Sign up for GitHub

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

Open
mehara-rothila wants to merge 8 commits into
base: main
Choose a base branch
from
Open

feat(platform-api): support upstreamDefinitions pool and per-operation upstream overrides #2155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8058f3e
feat(platform-api): add upstreamDefinitions pool and per-operation up…
mehara-rothila Jul 12, 2026
408ae7d
feat(platform-api): validate upstreamDefinitions basePath against the…
mehara-rothila Jul 16, 2026
a932f98
fix(platform-api): correct the upstream weight description
mehara-rothila Jul 16, 2026
40a6528
test(platform-api): drop a stale sentinel reference from a test comment
mehara-rothila Jul 17, 2026
5dbd5d0
test(platform-api): apply review polish to comments and test setup
mehara-rothila Jul 17, 2026
ee93249
test(platform-api): extend upstream test coverage
mehara-rothila Jul 20, 2026
67f26d5
refactor(platform-api): rename reusable-upstream converters and add s…
mehara-rothila Jul 21, 2026
486ecb2
refactor(platform-api): clarify reusable upstream naming
mehara-rothila Jul 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 55 additions & 4 deletions platform-api/api/generated.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

39 changes: 29 additions & 10 deletions platform-api/internal/dto/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,15 +137,16 @@ type Vhosts struct {

// APIYAMLData represents a basic spec section of the API deployment YAML
type APIYAMLData struct {
DisplayName string `yaml:"displayName"`
Version string `yaml:"version"`
Context string `yaml:"context"`
SubscriptionPlans []string `yaml:"subscriptionPlans,omitempty"`
Vhosts *Vhosts `yaml:"vhosts,omitempty"`
Upstream *UpstreamYAML `yaml:"upstream,omitempty"`
Policies []Policy `yaml:"policies,omitempty"`
Operations []api.OperationRequest `yaml:"operations,omitempty"`
Channels []api.ChannelRequest `yaml:"channels,omitempty"`
DisplayName string `yaml:"displayName"`
Version string `yaml:"version"`
Context string `yaml:"context"`
SubscriptionPlans []string `yaml:"subscriptionPlans,omitempty"`
Vhosts *Vhosts `yaml:"vhosts,omitempty"`
Upstream *UpstreamYAML `yaml:"upstream,omitempty"`
UpstreamDefinitions []ReusableUpstreamYAML `yaml:"upstreamDefinitions,omitempty"`

@ashera96 ashera96 Jul 24, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we rename this ReusableUpstreamYAML to something more aligning like []UpstreamDefinition? Any limitation in doing a rename like that?

@mehara-rothila mehara-rothila Jul 24, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

UpstreamDefinition is already a pre-existing platform-api schema/type, used for the API-level upstream.main/sandbox endpoint (the url | ref | auth union). It predates this PR:

api-platform/platform-api/resources/openapi.yaml

Lines 6703 to 6719 in be3e3a0

UpstreamDefinition:
type: object
oneOf:
- required: [ "url" ]
- required: [ "ref" ]
description: Upstream endpoint configuration (single target or reference)
properties:
url:
type: string
format: uri
description: Direct backend URL to route traffic to
example: http://prod-backend:5000/api/v2
ref:
type: string
description: Reference to a predefined upstreamDefinition
auth:
$ref: '#/components/schemas/UpstreamAuth'

That is why the new pool entry is ReusableUpstream: renaming it to UpstreamDefinition would collide with that existing type in both the OpenAPI components and the generated Go.

For context, the gateway's management-openapi.yaml uses the opposite terminology, Upstream for the endpoint and UpstreamDefinition for the pool entry, so the two planes already name these concepts differently, independent of this PR.

Policies []Policy `yaml:"policies,omitempty"`
Operations []api.OperationRequest `yaml:"operations,omitempty"`
Channels []api.ChannelRequest `yaml:"channels,omitempty"`
}

// UpstreamYAML represents the upstream configuration for API deployment YAML
Expand All @@ -160,10 +161,28 @@ type UpstreamTarget struct {
Ref string `yaml:"ref,omitempty"`
}

// ReusableUpstreamYAML represents a named entry in the deployment YAML's upstreamDefinitions pool.
type ReusableUpstreamYAML struct {
Name string `yaml:"name"`
BasePath string `yaml:"basePath,omitempty"`
Timeout *UpstreamTimeoutYAML `yaml:"timeout,omitempty"`

@ashera96 ashera96 Jul 24, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need the YAML part in this type? Can we maybe use just UpstreamTimeout?

Upstreams []UpstreamBackendYAML `yaml:"upstreams"`
}

// UpstreamBackendYAML represents a weighted backend target within a reusable upstream.
type UpstreamBackendYAML struct {
URL string `yaml:"url"`
Weight *int `yaml:"weight,omitempty"`
}

// UpstreamTimeoutYAML represents the timeout configuration for a reusable upstream.
type UpstreamTimeoutYAML struct {
Connect string `yaml:"connect,omitempty"`
}

// APIListResponse represents a paginated list of APIs (constitution-compliant)
type APIListResponse struct {
Count int `json:"count" yaml:"count"` // Number of items in current response
List []*API `json:"list" yaml:"list"` // Array of API objects
Pagination Pagination `json:"pagination" yaml:"pagination"` // Pagination metadata
}

Loading
Loading