Skip to content

chore: Add dynamic API response schema in registry swagger #5642

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

Jump to bottom
Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open

chore: Add dynamic API response schema in registry swagger #5642

wants to merge 15 commits into from
+9,528 −5,306

Conversation

aniketpalu
Copy link
Contributor

@aniketpalu aniketpalu commented Sep 29, 2025 •
edited
Loading

What this PR does / why we need it:

  • Introduces comprehensive Pydantic response models for all Feast REST Registry API endpoints, providing dynamic schema generation for OpenAPI/Swagger documentation
  • Standardizes API response formats across entities, feature views, data sources, saved datasets, permissions, and other registry resources with consistent pagination, relationships, and metadata structures
  • Enhances API documentation by leveraging protobuf-to-pydantic generated models (*_p2p.py files) to automatically create accurate, type-safe response schemas for the FastAPI-based registry server

Which issue(s) this PR fixes:

RHOAIENG-30426

Misc

@franciscojavierarceo
Copy link
Member

tests are failing

@aniketpalu
RHOAIENG-33922: Generated pydantic models using proto file & protobuf…
6232042 
…_to_pydantic library

Signed-off-by: Aniket Paluskar <[email protected]>
@aniketpalu
Minor patching to make pydantic models usable
74d5207 
Signed-off-by: Aniket Paluskar <[email protected]>
@aniketpalu
Created response model by re-using generated pydantic models
a0079f8 
Signed-off-by: Aniket Paluskar <[email protected]>
@aniketpalu
Reformatted, minor patching
ee25d3c 
Signed-off-by: Aniket Paluskar <[email protected]>
@aniketpalu
RHOAIENG-33923, RHOAIENG-33924: Added response models in APIs
eb4a577 
Signed-off-by: Aniket Paluskar <[email protected]>
@aniketpalu
Updated requirements with protobuf_to_pydantic lib
b219f98 
Signed-off-by: Aniket Paluskar <[email protected]>
@aniketpalu
Resolved conflicts, Updated requirements hashes
7c346ab 
Signed-off-by: Aniket Paluskar <[email protected]>
@aniketpalu
Added patching script and some new changes
b5516c6 
Signed-off-by: Aniket Paluskar <[email protected]>
@aniketpalu
Added Makefile command, minor formatting changes
fd0ddb0 
Signed-off-by: Aniket Paluskar <[email protected]>
@aniketpalu
Renamed command in Makefile
01fbecc 
Signed-off-by: Aniket Paluskar <[email protected]>
@aniketpalu
Updated requirements hashes
e0da5bd 
Signed-off-by: Aniket Paluskar <[email protected]>
@aniketpalu aniketpalu marked this pull request as ready for review October 22, 2025 08:21
@aniketpalu aniketpalu requested a review from a team as a code owner October 22, 2025 08:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@aniketpalu @franciscojavierarceo