From 95bed89e74267c53fae0de9daa4416dcb115a5fe Mon Sep 17 00:00:00 2001 From: Maisa Rissi Date: Fri, 22 Mar 2024 10:00:31 -0300 Subject: [PATCH] fixing some missing changes from kiota-config to workspace --- specs/cli/client-add.md | 2 +- specs/cli/workspace-init.md | 3 ++- specs/cli/workspace-migrate.md | 6 +++--- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/specs/cli/client-add.md b/specs/cli/client-add.md index 90e80a6b22..c960bb549c 100644 --- a/specs/cli/client-add.md +++ b/specs/cli/client-add.md @@ -8,7 +8,7 @@ When executing, a new API entry will be added and will use the `--client-name` p Every time an API client is added, a copy of the OpenAPI description file will be stored in the `./.kiota/clients/{client-name}.yaml|json` folder. The files will be named using the API client name. This will allow the CLI to detect changes in the description and avoid downloading the description again if it hasn't changed. -At the same time, an [API Manifest](https://www.ietf.org/archive/id/draft-miller-api-manifest-01.html) file will be generated (if non existing) or edited (if already existing) in the `.kiota` folder next to `workspace.json`. API Manifest represents a snapshot of API dependencies and permissions required to access those APIs. This file will represent 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 description location and the properties of the manifest will be generated and would trigger an update to the [API Manifest][https://www.ietf.org/archive/id/draft-miller-api-manifest-01.html]. +At the same time, an [API Manifest](https://www.ietf.org/archive/id/draft-miller-api-manifest-01.html) file will be generated (if non existing) or edited (if already existing) in the `.kiota` folder next to `workspace.json`. API Manifest represents a snapshot of API dependencies and permissions required to access those APIs. This file will represent 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 description location and the properties of the client will be generated and would trigger an update to the [API Manifest][https://www.ietf.org/archive/id/draft-miller-api-manifest-01.html]. Once the `workspace.json` file is generated and the OpenAPI description file is saved locally, the code generation will be executed and then the API Manifest would become available. diff --git a/specs/cli/workspace-init.md b/specs/cli/workspace-init.md index 7d7902ec6f..7a196f5026 100644 --- a/specs/cli/workspace-init.md +++ b/specs/cli/workspace-init.md @@ -30,5 +30,6 @@ _The resulting `workspace.json` file will look like this:_ ## File structure ```bash / - └─workspace.json + └─.kiota + └─workspace.json ``` \ No newline at end of file diff --git a/specs/cli/workspace-migrate.md b/specs/cli/workspace-migrate.md index f2766f491e..470bdf07a9 100644 --- a/specs/cli/workspace-migrate.md +++ b/specs/cli/workspace-migrate.md @@ -166,6 +166,8 @@ _The resulting `workspace.json` file will look like this:_ └─.kiota └─definitions └─GraphClient.yaml + └─apimanifest.json + └─workspace.json └─generated └─graph └─csharp @@ -174,7 +176,5 @@ _The resulting `workspace.json` file will look like this:_ └─python └─... # Generated code files └─graph_client.py - └─kiota-lock.json - └─apimanifest.json - └─workspace.json + └─kiota-lock.json ``` \ No newline at end of file