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

VS Code extension support with TTK should support .kiota folder #5407

Open
sebastienlevert opened this issue Sep 12, 2024 · 1 comment · May be fixed by #5612
Open

VS Code extension support with TTK should support .kiota folder #5407

sebastienlevert opened this issue Sep 12, 2024 · 1 comment · May be fixed by #5612
Assignees
Labels
blocked This work can't be done until an external dependent work is done. status:waiting-for-dependency An issue that has core project dependency that's currently blocking it status:waiting-for-triage An issue that is yet to be reviewed or assigned type:infrastructure Core back-end work which includes quality work, code refactor, tests etc vscode-extension Work related to the vscode-extension WIP
Milestone

Comments

@sebastienlevert
Copy link
Contributor

sebastienlevert commented Sep 12, 2024

As part of the command-base integration between Kiota and TTK, .kiota folder should be supported.
.kiota folder includes the following:

workspace.json file, which is Kiota's input files used to generate clients and plugins. So, supporting this in the integration is vital to help one maintaining their clients/plugins.
apimanifest.json file, which represents a snapshot and a concatenated surface of all APIs used across plugins and clients. Both files, apimanifest.json and workspace.json will be used to generate the code files. A new hash composed of the Kiota version, the OpenAPI document location and the properties of the manifest will be generated and would trigger an update to the API Manifest in case there is any change.
documents folder, which contains a copy of all OpenAPI descriptions used to generate clients/plugins
As previous discussed with TTK team, supporting users in editing existing plugins, is one of their current goals and Kiota can provide that.
Once .kiota folder is supported in fx-extension.createprojectfromkiota command, Kiota will need to update its code to pass the right values.

Related to: OfficeDev/teams-toolkit#12489

@sebastienlevert sebastienlevert added the status:waiting-for-triage An issue that is yet to be reviewed or assigned label Sep 12, 2024
@maisarissi maisarissi self-assigned this Oct 7, 2024
@baywet baywet added this to the Kiota v1.19.1 milestone Oct 7, 2024
@maisarissi
Copy link
Contributor

I can't edit the initial description so I'm going to add the description as a comment:

As part of the command-base integration between Kiota and TTK, .kiota folder should be supported.
.kiota folder includes the following:

  • workspace.json file, which is Kiota's input files used to generate clients and plugins. So, supporting this in the integration is vital to help one maintaining their clients/plugins.
  • apimanifest.json file, which represents a snapshot and a concatenated surface of all APIs used across plugins and clients. Both files, apimanifest.json and workspace.json will be used to generate the code files. A new hash composed of the Kiota version, the OpenAPI document location and the properties of the manifest will be generated and would trigger an update to the API Manifest in case there is any change.
  • documents folder, which contains a copy of all OpenAPI descriptions used to generate clients/plugins

As previous discussed with TTK team, supporting users in editing existing plugins, is one of their current goals and Kiota can provide that.
Once .kiota folder is supported in fx-extension.createprojectfromkiota command, Kiota will need to update its code to pass the right values.

Related to: OfficeDev/teams-toolkit#12489

@fey101 fey101 added blocked This work can't be done until an external dependent work is done. vscode-extension Work related to the vscode-extension status:waiting-for-dependency An issue that has core project dependency that's currently blocking it type:infrastructure Core back-end work which includes quality work, code refactor, tests etc labels Oct 8, 2024
@baywet baywet modified the milestones: Kiota v1.19.1, Kiota v1.20 Oct 11, 2024
@thewahome thewahome self-assigned this Oct 16, 2024
@thewahome thewahome linked a pull request Oct 16, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked This work can't be done until an external dependent work is done. status:waiting-for-dependency An issue that has core project dependency that's currently blocking it status:waiting-for-triage An issue that is yet to be reviewed or assigned type:infrastructure Core back-end work which includes quality work, code refactor, tests etc vscode-extension Work related to the vscode-extension WIP
Projects
Status: In Progress 🚧
Development

Successfully merging a pull request may close this issue.

5 participants