diff --git a/vscode/microsoft-kiota/CHANGELOG.md b/vscode/microsoft-kiota/CHANGELOG.md index 7c7900fe3d..cf9109acf9 100644 --- a/vscode/microsoft-kiota/CHANGELOG.md +++ b/vscode/microsoft-kiota/CHANGELOG.md @@ -8,7 +8,7 @@ All notable changes to this project will be documented in this file. ### Changed -## [1.19.24091901] - 2024-09-19 +## [1.19.24092001] - 2024-09-20 ### Added diff --git a/vscode/microsoft-kiota/README.md b/vscode/microsoft-kiota/README.md index 5e61aa15c3..edf47b00b2 100644 --- a/vscode/microsoft-kiota/README.md +++ b/vscode/microsoft-kiota/README.md @@ -22,7 +22,7 @@ This [Visual Studio Code](https://code.visualstudio.com/) (VS Code) extension ad ## Kiota extension installation 1. In VS Code, navigate to `Extensions`. -Navigate to Extensions on VS Code +Navigate to Extensions on VS Code 2. Search for 'kiota' 3. Click on Install. @@ -35,21 +35,23 @@ Once the extension is installed, you will be able to see the commands available You can kick start the process by using the add file icons as appears below or using command pallete with the command "Add API description" -Use the add file icon +Use the add file icon The notification bar will also notify you of ongoing background processes e.g when searching for an api using a keyword -vscode extension search notification +vscode extension search notification -vscode extension search results +The search results will be displayed as below once the search is complete + +vscode extension search results Select the OpenAPI description you are interested in and you will be presented with the Kiota OpenAPI Explorer containing all the available endpoints -Kiota OpenAPI explorer +Kiota OpenAPI explorer Select the endpoints to include in your API client as above and click the `generate` icon. Kiota extension will display with the options to generate either client, plugin or other. -kiota vscode generate options +kiota vscode generate options Finally, the notification bar at the bottom right will display "Generation Completed Successfully" once the generation is done. Click on your vscode file explorer to see the generated outputs in the current workspace if default selection was your output directory choice or navigate to selected folder to see the output. @@ -57,15 +59,15 @@ Finally, the notification bar at the bottom right will display "Generation Compl The latest version of the Kiota extension has been improved to using a workspace instead of a lock file to facilitate having multiple clients, plugins, or manifests within the same workspace. The workspace.json file also provides an opportunity to edit, or regenerate the outputs conveniently. -Working with the extension's workspace +Working with the extension's workspace If you previously generated a client that had a lock file, kiota prompts you to migrate to using the workspace once you open the previously generated folder containing a lock file. You can choose to migrate immediately or ask to be reminded later. -Notification to Migrate to extension's workspace +Notification to Migrate to extension's workspace You can also access the same feature later by using the contextual option on the lock file, by right-clicking on the lock file and selecting the option to migrate. -Contextual Migrate option on right-clicking on lockfile +Contextual Migrate option on right-clicking on lockfile Enjoy the benefits of the workspace once the migration is complete.