Skip to content

Update gateway endpoint path and proto name#19385

Merged
TomeHirata merged 2 commits intomlflow:masterfrom
TomeHirata:refactor/endpoint-tag-namespace
Dec 15, 2025
Merged

Update gateway endpoint path and proto name#19385
TomeHirata merged 2 commits intomlflow:masterfrom
TomeHirata:refactor/endpoint-tag-namespace

Conversation

@TomeHirata
Copy link
Collaborator

@TomeHirata TomeHirata commented Dec 15, 2025 •
edited by github-actions bot
Loading

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/19385/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/19385/merge#subdirectory=libs/skinny

For Databricks, use the following command:

%sh curl -LsSf https://raw.githubusercontent.com/mlflow/mlflow/HEAD/dev/install-skinny.sh | sh -s pull/19385/merge

Related Issues/PRs

n/a

What changes are proposed in this pull request?

Update proto name and REST API endpoints of gateway related feature for consistency

How is this PR tested?

  • Existing unit/integration tests
  • New unit/integration tests
  • Manual tests

Does this PR require documentation update?

  • No. You can skip the rest of this section.
  • Yes. I've updated:
    • Examples
    • API references
    • Instructions

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release notes for MLflow users.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

  • area/tracking: Tracking Service, tracking client APIs, autologging
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/evaluation: MLflow model evaluation features, evaluation metrics, and evaluation workflows
  • area/gateway: MLflow AI Gateway client APIs, server, and third-party integrations
  • area/prompts: MLflow prompt engineering features, prompt templates, and prompt management
  • area/tracing: MLflow Tracing features, tracing APIs, and LLM tracing functionality
  • area/projects: MLproject format, project running backends
  • area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
  • area/build: Build and test infrastructure for MLflow
  • area/docs: MLflow documentation pages

How should the PR be classified in the release notes? Choose one:

  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • rn/feature - A new user-facing feature worth mentioning in the release notes
  • rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
  • rn/documentation - A user-facing documentation change worth mentioning in the release notes

Should this PR be included in the next patch release?

Yes should be selected for bug fixes, documentation updates, and other small changes. No should be selected for new features and larger changes. If you're unsure about the release classification of this PR, leave this unchecked to let the maintainers decide.

What is a minor/patch release?
  • Minor release: a release that increments the second part of the version number (e.g., 1.2.0 -> 1.3.0).
    Bug fixes, doc updates and new features usually go into minor releases.
  • Patch release: a release that increments the third part of the version number (e.g., 1.2.0 -> 1.2.1).
    Bug fixes and doc updates usually go into patch releases.
  • Yes (this PR will be cherry-picked and included in the next patch release)
  • No (this PR will be included in the next minor release)

@TomeHirata
Update gateway api namespace
ed493b1 
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
Copilot AI review requested due to automatic review settings December 15, 2025 02:41
@TomeHirata TomeHirata added the team-review Trigger a team review request label Dec 15, 2025
@github-actions github-actions bot added rn/none List under Small Changes in Changelogs. v3.7.1 labels Dec 15, 2025
Copilot AI reviewed Dec 15, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates protobuf message names and REST API endpoints for gateway-related features to improve consistency and follow established naming conventions.

Key Changes

  • Renamed SetEndpointTag → SetGatewayEndpointTag and DeleteEndpointTag → DeleteGatewayEndpointTag across all proto definitions
  • Updated REST API endpoint paths from /mlflow/endpoints/* to /mlflow/gateway/* for supported-providers, supported-models, and provider-config endpoints
  • Synchronized changes across Python handlers, proto files, type stubs, and Java generated code

Reviewed changes

Copilot reviewed 4 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
mlflow/protos/service.proto Updated protobuf message and RPC definitions with new names for endpoint tag operations
mlflow/protos/service_pb2.pyi Updated Python type stubs to reflect renamed protobuf messages
mlflow/server/handlers.py Updated imports, handler implementations, and REST endpoint URL paths from /mlflow/endpoints/* to /mlflow/gateway/*
mlflow/store/tracking/gateway/rest_mixin.py Updated imports and message class usage for renamed protobuf messages
mlflow/java/client/src/main/java/org/mlflow/api/proto/Service.java Updated Java generated code with renamed classes and descriptors

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@TomeHirata TomeHirata added v3.8.0 and removed v3.7.1 labels Dec 15, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 15, 2025 •
edited
Loading

Documentation preview for dcfd304 is available at:

More info
  • Ignore this comment if this PR does not change the documentation.
  • The preview is updated when a new commit is pushed to this PR.
  • This comment was created by this workflow run.
  • The documentation was built by this workflow run.

@TomeHirata
test
dcfd304 
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
@TomeHirata TomeHirata changed the title Update gateway endpoint namespace v2 Update gateway endpoint path and proto name Dec 15, 2025
@serena-ruan
Copy link
Collaborator

serena-ruan commented Dec 15, 2025

This is a breaking change?

@TomeHirata
Copy link
Collaborator Author

TomeHirata commented Dec 15, 2025 •
edited
Loading

@serena-ruan No, these APIs haven't been released yet

serena-ruan
serena-ruan approved these changes Dec 15, 2025
View reviewed changes
Copy link
Collaborator

@serena-ruan serena-ruan left a comment

Choose a reason for hiding this comment

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

LGTM!

@TomeHirata TomeHirata added this pull request to the merge queue Dec 15, 2025
Merged via the queue into mlflow:master with commit a0879d1 Dec 15, 2025
58 of 60 checks passed
@TomeHirata TomeHirata deleted the refactor/endpoint-tag-namespace branch December 15, 2025 06:35
@TomeHirata TomeHirata mentioned this pull request Dec 15, 2025
Merged
29 tasks
WeichenXu123 pushed a commit to WeichenXu123/mlflow that referenced this pull request Dec 19, 2025
@TomeHirata @WeichenXu123
Update gateway endpoint path and proto name (mlflow#19385)
99cceb3 
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
WeichenXu123 pushed a commit that referenced this pull request Dec 19, 2025
@TomeHirata @WeichenXu123
Update gateway endpoint path and proto name (#19385)
7f59a87 
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@serena-ruan serena-ruan serena-ruan approved these changes

@B-Step62 B-Step62 Awaiting requested review from B-Step62

@BenWilson2 BenWilson2 Awaiting requested review from BenWilson2

@daniellok-db daniellok-db Awaiting requested review from daniellok-db

@harupy harupy Awaiting requested review from harupy

@kevin-lyn kevin-lyn Awaiting requested review from kevin-lyn

@WeichenXu123 WeichenXu123 Awaiting requested review from WeichenXu123

@xq-yin xq-yin Awaiting requested review from xq-yin

Assignees

@serena-ruan serena-ruan

Labels

rn/none List under Small Changes in Changelogs. team-review Trigger a team review request v3.8.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@TomeHirata @serena-ruan