Skip to content
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.

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

Jira plugin open api #648

Merged
merged 31 commits into from May 1, 2023
Merged

Jira plugin open api #648

merged 31 commits into from May 1, 2023

Conversation

amsacha
Copy link
Contributor

@amsacha amsacha commented Apr 25, 2023

Motivation and Context

Provide an example implementation of connecting the Semantic Kernel to external plugins following the open api schema.

Description

Jira Open API schema usage example
Renaming the azure key vault example, so all open api skill examples are grouped together
Prevent RestApiOperationRunner.cs from wrapping a json response into a json object.

Contribution Checklist

@github-actions github-actions bot added .NET Issue or Pull requests regarding .NET code kernel.core labels Apr 25, 2023
@adrianwyatt adrianwyatt self-assigned this Apr 25, 2023
@adrianwyatt adrianwyatt added the PR: feedback to address Waiting for PR owner to address comments/questions label Apr 25, 2023
Copy link
Collaborator

@dluc dluc left a comment

Choose a reason for hiding this comment

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

pls see comments about naming and docs

@amsacha amsacha requested a review from dluc April 27, 2023 19:55
@gitri-ms gitri-ms added PR: feedback to address Waiting for PR owner to address comments/questions and removed PR: ready for review All feedback addressed, ready for reviews labels Apr 27, 2023
@amsacha amsacha requested a review from gitri-ms April 27, 2023 21:33
@amsacha amsacha added PR: ready for review All feedback addressed, ready for reviews and removed PR: feedback to address Waiting for PR owner to address comments/questions labels Apr 27, 2023
@adrianwyatt adrianwyatt requested review from dluc and gitri-ms and removed request for dluc and gitri-ms April 28, 2023 20:52
@cchighman
Copy link
Member

Curious whether it makes sense to pull the openapi spec from https://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.json versus including the spec as part of the skill since this create a tight coupling between the version included with the skill and the current version available -- implying I assume that updates must be made here if we want to keep up to date. There's also the risk of a breaking change to Jira's API, which is less likely to happen but does happen, that might render this skill unusable for a customer in production until fix were made.

@cchighman
Copy link
Member

Curious whether it makes sense to pull the openapi spec from https://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.json versus including the spec as part of the skill since this create a tight coupling between the version included with the skill and the current version available -- implying I assume that updates must be made here if we want to keep up to date. There's also the risk of a breaking change to Jira's API, which is less likely to happen but does happen, that might render this skill unusable for a customer in production until fix were made.

Perhaps it could be cached, for efficiency. There is an implicit assumption here that you would always be pulling the latest API as opposed to a specific version so maybe that link above wouldnt work. Maybe https://developer.atlassian.com/cloud/jira/platform/swagger.json is meant to always point to the latest.

@amsacha
Copy link
Contributor Author

amsacha commented Apr 28, 2023

Curious whether it makes sense to pull the openapi spec from https://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.json versus including the spec as part of the skill since this create a tight coupling between the version included with the skill and the current version available -- implying I assume that updates must be made here if we want to keep up to date. There's also the risk of a breaking change to Jira's API, which is less likely to happen but does happen, that might render this skill unusable for a customer in production until fix were made.

We don't support version 3 in the semantic kernel, so we cant use the latest swagger anyway

@adrianwyatt adrianwyatt merged commit 0c31da2 into microsoft:main May 1, 2023
11 checks passed
awharrison-28 pushed a commit to awharrison-28/semantic-kernel that referenced this pull request May 1, 2023
### Motivation and Context
Provide an example implementation of connecting the Semantic Kernel to
external plugins following the open api schema.

### Description
Jira Open API schema usage example
Renaming the azure key vault example, so all open api skill examples are
grouped together
Prevent RestApiOperationRunner.cs from wrapping a json response into a
json object.
codebrain pushed a commit to searchpioneer/semantic-kernel that referenced this pull request May 16, 2023
### Motivation and Context
Provide an example implementation of connecting the Semantic Kernel to
external plugins following the open api schema.

### Description
Jira Open API schema usage example
Renaming the azure key vault example, so all open api skill examples are
grouped together
Prevent RestApiOperationRunner.cs from wrapping a json response into a
json object.
@amsacha amsacha deleted the JiraPluginOpenAPI branch May 17, 2023 20:56
dehoward pushed a commit to lemillermicrosoft/semantic-kernel that referenced this pull request Jun 1, 2023
### Motivation and Context
Provide an example implementation of connecting the Semantic Kernel to
external plugins following the open api schema.

### Description
Jira Open API schema usage example
Renaming the azure key vault example, so all open api skill examples are
grouped together
Prevent RestApiOperationRunner.cs from wrapping a json response into a
json object.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
.NET Issue or Pull requests regarding .NET code PR: ready for review All feedback addressed, ready for reviews
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants