Skip to content

Commit 423cf3c

Browse files
committed
Update plugin edit
1 parent 9808162 commit 423cf3c

File tree

2 files changed

+6
-35
lines changed

2 files changed

+6
-35
lines changed

output/sampleplugin-openapi.yml

Lines changed: 0 additions & 34 deletions
This file was deleted.

specs/cli/plugin-edit.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ Once the `workspace.json` file and the API Manifest are updated, the code genera
1919
| `--include-path \| -i` | No | /repos/{owner}/{repo} | A glob pattern to include paths from generation. Accepts multiple values. Defaults to no value which includes everything. | Yes, without its value |
2020
| `--exclude-path \| -e` | No | /repos/{owner}/{repo}#DELETE | A glob pattern to exclude paths from generation. Accepts multiple values. Defaults to no value which excludes nothing. | Yes, without its value |
2121
| `--type \| -t` | Yes | openai | The target type of plugin for the generated output files. Accepts multiple values. Possible values are `apiplugin`, `openai` and `apimanifest`.| Yes |
22+
| `--authentication-type \| -at` | No | oauth2 | The authentication type that will be used to connect to the API. Accepts a single value corresponding to a supported OpenAPI security scheme. Possible values are `apikey`, `http`, `oauth2` and `openidconnect`.| |
23+
| `--authentication-ref-id \| -refid` | No | xxxxxxxx | The authentication reference id that will be used to connect to the API. Accepts a single string value.| |
2224
| `--skip-generation \| --sg` | No | true | When specified, the generation would be skipped. Defaults to false. | Yes |
2325
| `--output \| -o` | No | ./generated/plugins/github | The output directory or file path for the generated output files. This is relative to the current working directory. Defaults to `./output`. | Yes, without its value |
2426

@@ -39,6 +41,8 @@ _The resulting `workspace.json` file will look like this:_
3941
"clients": {...}, //if any
4042
"plugins": {
4143
"GitHub": {
44+
"authType": "OAuthPluginVault",
45+
"authReferenceId": "somerefid",
4246
"descriptionLocation": "https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.json",
4347
"includePatterns": ["/repos/{owner}/{repo}"],
4448
"excludePatterns": ["/repos/{owner}/{repo}#DELETE"],
@@ -79,7 +83,8 @@ _The resulting API Plugin named `github-apiplugin.json` will look like this:_
7983
{
8084
"type": "OpenApi",
8185
"auth": {
82-
"type": "None"
86+
"type": "OAuthPluginVault",
87+
"reference_id": "somerefid"
8388
},
8489
"spec": {
8590
"url": "githubreposowner-openapi.yml"

0 commit comments

Comments
 (0)