Skip to content

Commit 8add797

Browse files
authored
Add ApiCenterMinimalPermissionsPlugin snippets. Closes #96 (#102)
Closes #96 - Update MinimalPermissionsGuidancePlugin constant - Update snippets table in readme
1 parent 3fb94a0 commit 8add797

File tree

4 files changed

+43
-6
lines changed

4 files changed

+43
-6
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [0.5.0] - 2024-06-27
99

10+
### Added:
11+
12+
- Snippets: `devproxy-plugin-api-center-minimal-permissions` - ApiCenterMinimalPermissionsPlugin instance
13+
- Snippets: `devproxy-plugin-api-center-minimal-permissions-config` - ApiCenterMinimalPermissionsPlugin config section
14+
1015
### Changed:
1116

1217
- Snippets: All snippets that reference schemas updated to use `v0.19.0` schema

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ The following sections describe the features that the extension contributes to V
5757
| `devproxy-request` | Dev Proxy request |
5858
| `devproxy-response` | Dev Proxy response |
5959
| `devproxy-response-header` | Dev Proxy response header |
60+
| `devproxy-plugin-api-center-minimal-permissions` | ApiCenterMinimalPermissionsPlugin instance |
61+
| `devproxy-plugin-api-center-minimal-permissions-config` | ApiCenterMinimalPermissionsPlugin config section |
6062
| `devproxy-plugin-api-center-onboarding` | ApiCenterOnboardingPlugin instance |
6163
| `devproxy-plugin-api-center-onboarding-config` | ApiCenterOnboardingPlugin config section |
6264
| `devproxy-plugin-api-center-production-version` | ApiCenterProductionVersionPlugin instance |
@@ -88,7 +90,6 @@ The following sections describe the features that the extension contributes to V
8890
| `devproxy-plugin-latency` | LatencyPlugin instance |
8991
| `devproxy-plugin-latency-config` | LatencyPlugin config section |
9092
| `devproxy-plugin-graph-minimal-permissions-guidance` | MinimalPermissionsGuidancePlugin instance |
91-
| `devproxy-plugin-graph-minimal-permissions-guidance-config` | MinimalPermissionsGuidancePlugin config section |
9293
| `devproxy-plugin-graph-minimal-permissions` | MinimalPermissionsPlugin instance |
9394
| `devproxy-plugin-graph-minimal-permissions-config` | MinimalPermissionsPlugin config section |
9495
| `devproxy-plugin-mock-generator` | MockGeneratorPlugin instance |

src/constants.ts

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
import { PluginDocs, PluginSnippets } from './types';
22

33
export const pluginSnippets: PluginSnippets = {
4+
ApiCenterMinimalPermissionsPlugin: {
5+
instance: 'devproxy-plugin-api-center-minimal-permissions',
6+
config: {
7+
name: 'devproxy-plugin-api-center-minimal-permissions-onboarding-config',
8+
required: true,
9+
}
10+
},
411
ApiCenterOnboardingPlugin: {
512
instance: 'devproxy-plugin-api-center-onboarding',
613
config: {
@@ -87,11 +94,7 @@ export const pluginSnippets: PluginSnippets = {
8794
},
8895
},
8996
MinimalPermissionsGuidancePlugin: {
90-
instance: 'devproxy-plugin-minimal-permissions-guidance',
91-
config: {
92-
name: 'devproxy-plugin-minimal-permissions-guidance-config',
93-
required: false,
94-
},
97+
instance: 'devproxy-plugin-minimal-permissions-guidance'
9598
},
9699
MinimalPermissionsPlugin: {
97100
instance: 'devproxy-plugin-minimal-permissions',
@@ -148,6 +151,10 @@ export const pluginSnippets: PluginSnippets = {
148151
};
149152

150153
export const pluginDocs: PluginDocs = {
154+
ApiCenterMinimalPermissionsPlugin: {
155+
name: 'API Center Minimal Permissions Plugin',
156+
url: 'https://learn.microsoft.com/microsoft-cloud/dev/dev-proxy/technical-reference/apicenterminimalpermissionsplugin',
157+
},
151158
ApiCenterOnboardingPlugin: {
152159
name: 'API Center Onboarding Plugin',
153160
url: 'https://learn.microsoft.com/microsoft-cloud/dev/dev-proxy/technical-reference/apicenteronboardingplugin',

src/snippets.json

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,30 @@
9393
],
9494
"description": "Dev Proxy response header"
9595
},
96+
"ApiCenterMinimalPermissionsPlugin": {
97+
"prefix": "devproxy-plugin-api-center-minimal-permissions",
98+
"body": [
99+
"{",
100+
"\t\"name\": \"ApiCenterOnboardingPlugin\",",
101+
"\t\"enabled\": true,",
102+
"\t\"pluginPath\": \"~appFolder/plugins/dev-proxy-plugins.dll\",",
103+
"\t\"configSection\": \"apiCenterMinimalPermissionsPlugin\"",
104+
"}"
105+
],
106+
"description": "ApiCenterMinimalPermissionsPlugin instance"
107+
},
108+
"ApiCenterMinimalPermissionsPluginConfig": {
109+
"prefix": "devproxy-plugin-api-center-minimal-permissions-config",
110+
"body": [
111+
"\"apiCenterMinimalPermissionsPlugin\": {",
112+
"\t\"subscriptionId\": \"cdae2297-7aa6-4195-bbb1-dcd89153cc72\",",
113+
"\t\"resourceGroupName\": \"resource-group-name\",",
114+
"\t\"serviceName\": \"apic-instance\",",
115+
"\t\"workspaceName\": \"default\"",
116+
"}"
117+
],
118+
"description": "ApiCenterMinimalPermissionsPlugin config section"
119+
},
96120
"ApiCenterOnboardingPlugin": {
97121
"prefix": "devproxy-plugin-api-center-onboarding",
98122
"body": [

0 commit comments

Comments
 (0)