Skip to content

.Net: revise public api surface of the rest-api model #9549

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
Merged
merged 2 commits into from
Nov 5, 2024
Merged

.Net: revise public api surface of the rest-api model #9549

merged 2 commits into from
Nov 5, 2024

Conversation

@SergeyMenshykh
Copy link
Member

@SergeyMenshykh SergeyMenshykh commented Nov 5, 2024

Motivation and Context

Taking into account the plans to add REST API operation details to KernelFunction.Metadata, it makes sense to review the REST API operation model classes and ensure their surface is good enough to be publicly exposed, making it easy for the SK team to develop them over time with minimal or no breaking changes.

Description

  1. Changes collections/dictionaries to their read-only equivalents to prevent modifications - metadata is read-only.
  2. Makes the constructors of REST API operation model classes internal, allowing changes and development without the concern of introducing breaking changes.

Closes: #6884

@SergeyMenshykh SergeyMenshykh self-assigned this Nov 5, 2024
@SergeyMenshykh SergeyMenshykh requested a review from a team as a code owner November 5, 2024 16:35
@markwallace-microsoft markwallace-microsoft added the .NET Issue or Pull requests regarding .NET code label Nov 5, 2024
@SergeyMenshykh SergeyMenshykh added the openapi Issues related to the OpenAPI function importer label Nov 5, 2024
@SergeyMenshykh SergeyMenshykh added this pull request to the merge queue Nov 5, 2024
Merged via the queue into microsoft:main with commit 113cea0 Nov 5, 2024
15 checks passed
@SergeyMenshykh SergeyMenshykh deleted the revise-public-api-surface-of-openapi-classes branch November 5, 2024 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dmytrostruk dmytrostruk dmytrostruk approved these changes

@rogerbarreto rogerbarreto rogerbarreto approved these changes

@markwallace-microsoft markwallace-microsoft markwallace-microsoft approved these changes

Assignees

@SergeyMenshykh SergeyMenshykh

Labels

.NET Issue or Pull requests regarding .NET code openapi Issues related to the OpenAPI function importer

Projects

Semantic Kernel
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

.Net: Review public API surface of OpenAPI plugins

4 participants

@SergeyMenshykh @dmytrostruk @rogerbarreto @markwallace-microsoft