Skip to content

Commit

Permalink
Updates spec
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew Omondi committed May 13, 2024
1 parent 40cc752 commit 39b4804
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion specs/cli/client-add.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

When executing, a new API entry will be added and will use the `--client-name` parameter as the key for the map. When loading the OpenAPI description, it will store the location of the description in the `descriptionLocation` property. If `--include-path` or `--exclude-path` are provided, they will be stored in the `includePatterns` and `excludePatterns` properties respectively.

Every time an API client is added, a copy of the OpenAPI description file will be stored in the `./.kiota/documents/{client-name}/{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.
Every time an API client is added, a copy of the OpenAPI description file will be stored in the `./.kiota/documents/{client-name}/openapi.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 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].

Expand Down
2 changes: 1 addition & 1 deletion specs/cli/client-edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ _The resulting `apimanifest.json` file will look like this:_
└─workspace.json
└─documents
└─GraphClient
└─GraphClient.yaml
└─openapi.yaml
└─generated
└─graph
└─csharp
Expand Down
2 changes: 1 addition & 1 deletion specs/cli/plugin-add.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ _The resulting API Manifest named `apimanifest.json` in the `./kiota` folder (co
└─apimanifest.json # Single artifact with all APIs dependencies info across clients and plugins
└─documents
└─github
└─GitHub.json # OpenAPI document
└─openapi.json # OpenAPI document
└─overlay.json # Overlay to be applied on top of OpenAPI document
└─generated
└─plugins
Expand Down
2 changes: 1 addition & 1 deletion specs/cli/plugin-edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ _The resulting API Manifest named `apimanifest.json` in the `./kiota` folder (co
└─apimanifest.json
└─documents
└─github
└─GitHub.json # OpenAPI document
└─openapi.json # OpenAPI document
└─overlay.json # Overlay to be applied on top of OpenAPI document
└─generated
└─plugins
Expand Down

0 comments on commit 39b4804

Please sign in to comment.