Skip to content

Commit

Permalink
fixing some missing changes from kiota-config to workspace
Browse files Browse the repository at this point in the history
  • Loading branch information
maisarissi committed Mar 22, 2024
1 parent 5eb2627 commit 95bed89
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion specs/cli/client-add.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
3 changes: 2 additions & 1 deletion specs/cli/workspace-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,6 @@ _The resulting `workspace.json` file will look like this:_
## File structure
```bash
/
└─workspace.json
└─.kiota
└─workspace.json
```
6 changes: 3 additions & 3 deletions specs/cli/workspace-migrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,8 @@ _The resulting `workspace.json` file will look like this:_
└─.kiota
└─definitions
└─GraphClient.yaml
└─apimanifest.json
└─workspace.json
└─generated
└─graph
└─csharp
Expand All @@ -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
```

0 comments on commit 95bed89

Please sign in to comment.