Skip to content

Commit e4f62d0

Browse files
garrytrindergarrytrinder
authored
Update minimal permissions snippets. Closes #140 (#144)
1 parent 5c55cfb commit e4f62d0

File tree

4 files changed

+102
-52
lines changed

4 files changed

+102
-52
lines changed

‎CHANGELOG.md

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

1212
- Snippets: All snippets that reference schemas updated to use `v0.22.0` schema
1313
- Snippets: Added `logLevel`, `newVersionNotification`, `showSkipMessages` properties to `devproxy-config-file`
14+
- Snippets: Renamed `devproxy-plugin-minimal-permissions` to `devproxy-plugin-graph-minimal-permissions`
15+
- Snippets: Renamed `devproxy-plugin-minimal-permissions-guidance` to `devproxy-plugin-graph-minimal-permissions-guidance`
16+
17+
### Added:
18+
19+
- Snippets: `devproxy-plugin-minimal-permissions-guidance-config` - MinimalPermissionsGuidancePlugin config section
20+
- Snippets: `devproxy-plugin-minimal-permissions` - MinimalPermissionsPlugin instance
1421

1522
## [0.10.0] - 2024-10-01
1623

‎README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,10 @@ Shown when the active document is a Dev Proxy configuration file
100100
| `devproxy-plugin-generic-random-error-file-schema` | GenericRandomErrorPlugin errors file schema |
101101
| `devproxy-plugin-graph-beta-support-guidance` | GraphBetaSupportGuidancePlugin instance |
102102
| `devproxy-plugin-graph-client-request-id-guidance` | GraphClientRequestIdGuidancePlugin instance |
103+
| `devproxy-plugin-graph-minimal-permissions-guidance` | GraphMinimalPermissionsGuidancePlugin instance |
104+
| `devproxy-plugin-graph-minimal-permissions-guidance-config` | GraphMinimalPermissionsGuidancePlugin config section |
105+
| `devproxy-plugin-graph-minimal-permissions` | GraphMinimalPermissionsPlugin instance |
106+
| `devproxy-plugin-graph-minimal-permissions-config` | GraphMinimalPermissionsPlugin config section |
103107
| `devproxy-plugin-graph-mock-response` | GraphMockResponsePlugin instance |
104108
| `devproxy-plugin-graph-mock-response-config` | GraphMockResponsePlugin config section |
105109
| `devproxy-plugin-graph-random-error` | GraphRandomErrorPlugin instance |
@@ -110,9 +114,8 @@ Shown when the active document is a Dev Proxy configuration file
110114
| `devproxy-plugin-http-file-generator-config` | HttpFileGeneratorPlugin config section |
111115
| `devproxy-plugin-latency` | LatencyPlugin instance |
112116
| `devproxy-plugin-latency-config` | LatencyPlugin config section |
113-
| `devproxy-plugin-graph-minimal-permissions-guidance` | MinimalPermissionsGuidancePlugin instance |
114-
| `devproxy-plugin-graph-minimal-permissions-guidance-config` | MinimalPermissionsGuidancePlugin config section |
115-
| `devproxy-plugin-graph-minimal-permissions` | MinimalPermissionsPlugin instance |
117+
| `devproxy-plugin-minimal-permissions` | MinimalPermissionsPlugin instance |
118+
| `devproxy-plugin-minimal-permissions-config` | MinimalPermissionsPlugin config section |
116119
| `devproxy-plugin-mock-generator` | MockGeneratorPlugin instance |
117120
| `devproxy-plugin-mock-request` | MockResponsePlugin instance |
118121
| `devproxy-plugin-mock-request-config` | MockResponsePlugin config section |

‎src/constants.ts

Lines changed: 34 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -20,56 +20,70 @@ export const pluginSnippets: PluginSnippets = {
2020
config: {
2121
name: 'devproxy-plugin-api-center-production-version-config',
2222
required: true,
23-
},
23+
}
2424
},
2525
CachingGuidancePlugin: {
2626
instance: 'devproxy-plugin-caching-guidance',
2727
config: {
2828
name: 'devproxy-plugin-caching-guidance-config',
2929
required: false,
30-
},
30+
}
3131
},
3232
CrudApiPlugin: {
3333
instance: 'devproxy-plugin-crud-api',
3434
config: {
3535
name: 'devproxy-plugin-crud-api-config',
3636
required: true,
37-
},
37+
}
3838
},
3939
DevToolsPlugin: {
4040
instance: 'devproxy-plugin-dev-tools',
4141
config: {
4242
name: 'devproxy-plugin-dev-tools-config',
4343
required: false,
44-
},
44+
}
4545
},
4646
EntraMockResponsePlugin: {
4747
instance: 'devproxy-plugin-entra-mock-response',
4848
config: {
4949
name: 'devproxy-plugin-entra-mock-response-config',
5050
required: true,
51-
},
51+
}
5252
},
5353
ExecutionSummaryPlugin: {
5454
instance: 'devproxy-plugin-execution-summary',
5555
config: {
5656
name: 'devproxy-plugin-execution-summary-config',
5757
required: false,
58-
},
58+
}
5959
},
6060
GenericRandomErrorPlugin: {
6161
instance: 'devproxy-plugin-generic-random-error',
6262
config: {
6363
name: 'devproxy-plugin-generic-random-error-config',
6464
required: true,
65-
},
65+
}
6666
},
6767
GraphBetaSupportGuidancePlugin: {
6868
instance: 'devproxy-plugin-graph-beta-support-guidance',
6969
},
7070
GraphClientRequestIdGuidancePlugin: {
7171
instance: 'devproxy-plugin-graph-client-request-id-guidance',
7272
},
73+
GraphMinimalPermissionsPlugin: {
74+
instance: 'devproxy-plugin-graph-minimal-permissions',
75+
config: {
76+
name: 'devproxy-plugin-graph-minimal-permissions-config',
77+
required: false,
78+
}
79+
},
80+
GraphMinimalPermissionsGuidancePlugin: {
81+
instance: 'devproxy-plugin-graph-minimal-permissions-guidance',
82+
config: {
83+
name: 'devproxy-plugin-graph-minimal-permissions-guidance-config',
84+
required: false
85+
}
86+
},
7387
GraphMockResponsePlugin: {
7488
instance: 'devproxy-plugin-graph-mock-response',
7589
},
@@ -78,7 +92,7 @@ export const pluginSnippets: PluginSnippets = {
7892
config: {
7993
name: 'devproxy-plugin-graph-random-error-config',
8094
required: false,
81-
},
95+
}
8296
},
8397
GraphSdkGuidancePlugin: {
8498
instance: 'devproxy-plugin-graph-sdk-guidance',
@@ -91,28 +105,21 @@ export const pluginSnippets: PluginSnippets = {
91105
config: {
92106
name: 'devproxy-plugin-http-file-generator-config',
93107
required: false,
94-
},
108+
}
95109
},
96110
LatencyPlugin: {
97111
instance: 'devproxy-plugin-latency',
98112
config: {
99113
name: 'devproxy-plugin-latency-config',
100114
required: false,
101-
},
102-
},
103-
MinimalPermissionsGuidancePlugin: {
104-
instance: 'devproxy-plugin-minimal-permissions-guidance',
105-
config: {
106-
name: 'devproxy-plugin-minimal-permissions-guidance-config',
107-
required: false
108115
}
109116
},
110117
MinimalPermissionsPlugin: {
111118
instance: 'devproxy-plugin-minimal-permissions',
112119
config: {
113120
name: 'devproxy-plugin-minimal-permissions-config',
114121
required: false,
115-
},
122+
}
116123
},
117124
MockGeneratorPlugin: {
118125
instance: 'devproxy-plugin-mock-generator',
@@ -122,7 +129,7 @@ export const pluginSnippets: PluginSnippets = {
122129
config: {
123130
name: 'devproxy-plugin-mock-request-config',
124131
required: true,
125-
},
132+
}
126133
},
127134
MockResponsePlugin: {
128135
instance: 'devproxy-plugin-mock-response',
@@ -148,7 +155,7 @@ export const pluginSnippets: PluginSnippets = {
148155
config: {
149156
name: 'devproxy-plugin-rate-limiting-config',
150157
required: false,
151-
},
158+
}
152159
},
153160
RetryAfterPlugin: {
154161
instance: 'devproxy-plugin-retry-after',
@@ -209,6 +216,14 @@ export const pluginDocs: PluginDocs = {
209216
name: 'Graph Client Request ID Guidance Plugin',
210217
url: 'https://learn.microsoft.com/microsoft-cloud/dev/dev-proxy/technical-reference/graphclientrequestidguidanceplugin',
211218
},
219+
GraphMinimalPermissionsPlugin: {
220+
name: 'Graph Minimal Permissions Plugin',
221+
url: 'https://learn.microsoft.com/microsoft-cloud/dev/dev-proxy/technical-reference/graphminimalpermissionsplugin',
222+
},
223+
GraphMinimalPermissionsGuidancePlugin: {
224+
name: 'Graph Minimal Permissions Guidance Plugin',
225+
url: 'https://learn.microsoft.com/microsoft-cloud/dev/dev-proxy/technical-reference/graphminimalpermissionsguidanceplugin',
226+
},
212227
GraphMockResponsePlugin: {
213228
name: 'Graph Mock Response Plugin',
214229
url: 'https://learn.microsoft.com/microsoft-cloud/dev/dev-proxy/technical-reference/graphmockresponseplugin',
@@ -233,10 +248,6 @@ export const pluginDocs: PluginDocs = {
233248
name: 'Latency Plugin',
234249
url: 'https://learn.microsoft.com/microsoft-cloud/dev/dev-proxy/technical-reference/latencyplugin',
235250
},
236-
MinimalPermissionsGuidancePlugin: {
237-
name: 'Minimal Permissions Guidance Plugin',
238-
url: 'https://learn.microsoft.com/microsoft-cloud/dev/dev-proxy/technical-reference/minimalpermissionsguidanceplugin',
239-
},
240251
MinimalPermissionsPlugin: {
241252
name: 'Minimal Permissions Plugin',
242253
url: 'https://learn.microsoft.com/microsoft-cloud/dev/dev-proxy/technical-reference/minimalpermissionsplugin',

‎src/snippets.json

Lines changed: 55 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@
439439
"\t\t\"https://graph.microsoft.us/beta/*\",",
440440
"\t\t\"https://dod-graph.microsoft.us/beta/*\",",
441441
"\t\t\"https://microsoftgraph.chinacloudapi.cn/beta/*\"",
442-
"\t]",
442+
"\t]",
443443
"}"
444444
],
445445
"description": "GraphBetaSupportGuidancePlugin instance"
@@ -465,6 +465,51 @@
465465
],
466466
"description": "GraphClientRequestIdGuidancePlugin instance"
467467
},
468+
"GraphMinimalPermissionsGuidancePlugin": {
469+
"prefix": "devproxy-plugin-graph-minimal-permissions-guidance",
470+
"body": [
471+
"{",
472+
"\t\"name\": \"GraphMinimalPermissionsGuidancePlugin\",",
473+
"\t\"enabled\": true,",
474+
"\t\"pluginPath\": \"~appFolder/plugins/dev-proxy-plugins.dll\"",
475+
"}"
476+
],
477+
"description": "GraphMinimalPermissionsGuidancePlugin instance"
478+
},
479+
"GraphMinimalPermissionsGuidancePluginConfig": {
480+
"prefix": "devproxy-plugin-graph-minimal-permissions-guidance-config",
481+
"body": [
482+
"\"graphMinimalPermissionsGuidancePlugin\": {",
483+
"\t\"permissionsToIgnore\": [",
484+
"\t\t\"profile\",",
485+
"\t\t\"openid\",",
486+
"\t\t\"offline_access\",",
487+
"\t\t\"email\"",
488+
"\t]",
489+
"}"
490+
],
491+
"description": "GraphMinimalPermissionsGuidancePlugin config section"
492+
},
493+
"GraphMinimalPermissionsPlugin": {
494+
"prefix": "devproxy-plugin-graph-minimal-permissions",
495+
"body": [
496+
"{",
497+
"\t\"name\": \"GraphMinimalPermissionsPlugin\",",
498+
"\t\"enabled\": true,",
499+
"\t\"pluginPath\": \"~appFolder/plugins/dev-proxy-plugins.dll\"",
500+
"}"
501+
],
502+
"description": "GraphMinimalPermissionsPlugin instance"
503+
},
504+
"GraphMinimalPermissionsPluginConfig": {
505+
"prefix": "devproxy-plugin-graph-minimal-permissions-config",
506+
"body": [
507+
"\"graphMinimalPermissionsPlugin\": {",
508+
"\t\"type\": \"delegated\"",
509+
"}"
510+
],
511+
"description": "GraphMinimalPermissionsPlugin config section"
512+
},
468513
"GraphMockResponsePlugin": {
469514
"prefix": "devproxy-plugin-graph-mock-response",
470515
"body": [
@@ -612,41 +657,25 @@
612657
],
613658
"description": "LatencyPlugin config section"
614659
},
615-
"MinimalPermissionsGuidancePlugin": {
616-
"prefix": "devproxy-plugin-graph-minimal-permissions-guidance",
660+
"MinimalPermissionsPlugin": {
661+
"prefix": "devproxy-plugin-minimal-permissions",
617662
"body": [
618663
"{",
619-
"\t\"name\": \"MinimalPermissionsGuidancePlugin\",",
664+
"\t\"name\": \"MinimalPermissionsPlugin\",",
620665
"\t\"enabled\": true,",
621666
"\t\"pluginPath\": \"~appFolder/plugins/dev-proxy-plugins.dll\"",
622667
"}"
623668
],
624-
"description": "MinimalPermissionsGuidancePlugin instance"
625-
},
626-
"MinimalPermissionsGuidancePluginConfig": {
627-
"prefix": "devproxy-plugin-graph-minimal-permissions-guidance-config",
628-
"body": [
629-
"\"minimalPermissionsGuidancePlugin\": {",
630-
"\t\"permissionsToIgnore\": [",
631-
"\t\t\"profile\",",
632-
"\t\t\"openid\",",
633-
"\t\t\"offline_access\",",
634-
"\t\t\"email\"",
635-
"\t]",
636-
"}"
637-
],
638-
"description": "MinimalPermissionsGuidancePlugin config section"
669+
"description": "MinimalPermissionsPlugin instance"
639670
},
640-
"MinimalPermissionsPlugin": {
641-
"prefix": "devproxy-plugin-graph-minimal-permissions",
671+
"MinimalPermissionsPluginConfig": {
672+
"prefix": "devproxy-plugin-minimal-permissions-config",
642673
"body": [
643-
"{",
644-
"\t\"name\": \"MinimalPermissionsPlugin\",",
645-
"\t\"enabled\": true,",
646-
"\t\"pluginPath\": \"~appFolder/plugins/dev-proxy-plugins.dll\"",
674+
"\"minimalPermissionsPlugin\": {",
675+
"\t\"apiSpecsFolderPath\": \"./api-specs\"",
647676
"}"
648677
],
649-
"description": "MinimalPermissionsPlugin instance"
678+
"description": "MinimalPermissionsPlugin config section"
650679
},
651680
"MockGeneratorPlugin": {
652681
"prefix": "devproxy-plugin-mock-generator",

0 commit comments

Comments
 (0)