Add $schema property to all config section snippets. Closes #195 (#198)

Closes #195

Author: garrytrinder

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Snippets: All snippets that reference schemas updated to use `v0.25.0` schema
 - Code action: Updated update schema code action to reflect the move to dotnet organisation in Github
 - Snippets: `rate` property added to `devproxy-plugin-generic-random-error-config` and `devproxy-plugin-graph-random-error-config`
+- Snippets: `$schema` property added to all config section snippets
 
 ### Fixed: 
 

src/snippets.json

@@ -42,7 +42,7 @@
     "prefix": "devproxy-mocks-file",
     "body": [
       "{",
-      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/mockresponseplugin.schema.json\",",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/mockresponseplugin.mocksfile.schema.json\",",
       "\t\"mocks\": [",
       "\t\t$1",
       "\t]",
@@ -53,7 +53,7 @@
   "MocksFileSchema": {
     "prefix": "devproxy-mocks-file-schema",
     "body": [
-      "\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/mockresponseplugin.schema.json\","
+      "\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/mockresponseplugin.mocksfile.schema.json\","
     ],
     "description": "Dev Proxy mocks file schema"
   },
@@ -126,6 +126,7 @@
     "prefix": "devproxy-plugin-auth-config-apikey",
     "body": [
       "\"auth\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/authplugin.schema.json\",",
       "\t\"type\": \"apiKey\",",
       "\t\"apiKey\": {",
       "\t\t\"parameters\": [",
@@ -150,6 +151,7 @@
     "prefix": "devproxy-plugin-auth-config-oauth2",
     "body": [
       "\"auth\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/authplugin.schema.json\",",
       "\t\"type\": \"oauth2\",",
       "\t\"oauth2\": {",
       "\t\t\"metadataUrl\": \"https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration\",",
@@ -192,6 +194,7 @@
     "prefix": "devproxy-plugin-api-center-minimal-permissions-config",
     "body": [
       "\"apiCenterMinimalPermissionsPlugin\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/apicenterminimalpermissionsplugin.schema.json\",",
       "\t\"subscriptionId\": \"cdae2297-7aa6-4195-bbb1-dcd89153cc72\",",
       "\t\"resourceGroupName\": \"resource-group-name\",",
       "\t\"serviceName\": \"apic-instance\",",
@@ -216,6 +219,7 @@
     "prefix": "devproxy-plugin-api-center-onboarding-config",
     "body": [
       "\"apiCenterOnboardingPlugin\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/apicenteronboardingplugin.schema.json\",",
       "\t\"subscriptionId\": \"cdae2297-7aa6-4195-bbb1-dcd89153cc72\",",
       "\t\"resourceGroupName\": \"resource-group-name\",",
       "\t\"serviceName\": \"apic-instance\",",
@@ -241,6 +245,7 @@
     "prefix": "devproxy-plugin-api-center-production-version-config",
     "body": [
       "\"apiCenterProductionVersionPlugin\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/apicenterproductionversionplugin.schema.json\",",
       "\t\"subscriptionId\": \"cdae2297-7aa6-4195-bbb1-dcd89153cc72\",",
       "\t\"resourceGroupName\": \"resource-group-name\",",
       "\t\"serviceName\": \"apic-instance\",",
@@ -264,6 +269,7 @@
     "prefix": "devproxy-plugin-caching-guidance-config",
     "body": [
       "\"cachingGuidance\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/cachingguidanceplugin.schema.json\",",
       "\t\"cacheThresholdSeconds\": 5",
       "}"
     ],
@@ -285,6 +291,7 @@
     "prefix": "devproxy-plugin-crud-api-config",
     "body": [
       "\"customersApi\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/crudapiplugin.schema.json\",",
       "\t\"apiFile\": \"customers-api.json\"",
       "}"
     ],
@@ -294,7 +301,7 @@
     "prefix": "devproxy-plugin-crud-api-file",
     "body": [
       "{",
-      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/crudapiplugin.schema.json\",",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/crudapiplugin.apifile.schema.json\",",
       "\t\"actions\": [",
       "\t\t$1",
       "\t],",
@@ -307,7 +314,7 @@
   "CrudApiPluginFileSchema": {
     "prefix": "devproxy-plugin-crud-api-file-schema",
     "body": [
-      "\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/crudapiplugin.schema.json\","
+      "\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/crudapiplugin.apifile.schema.json\","
     ],
     "description": "CrudApiPlugin API file schema"
   },
@@ -338,6 +345,7 @@
     "prefix": "devproxy-plugin-dev-tools-config",
     "body": [
       "\"devTools\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/devtoolsplugin.schema.json\",",
       "\t\"preferredBrowser\": \"Edge\"",
       "}"
     ],
@@ -359,6 +367,7 @@
     "prefix": "devproxy-plugin-entra-mock-response-config",
     "body": [
       "\"entraMockResponsePlugin\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/mockresponseplugin.schema.json\",",
       "\t\"mocksFile\": \"mocks.json\"",
       "}"
     ],
@@ -379,6 +388,7 @@
     "prefix": "devproxy-plugin-execution-summary-config",
     "body": [
       "\"executionSummaryPlugin\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/executionsummaryplugin.schema.json\",",
       "\t\"groupBy\": \"url\"",
       "}"
     ],
@@ -400,7 +410,8 @@
     "prefix": "devproxy-plugin-generic-random-error-config",
     "body": [
       "\"genericRandomErrorPlugin\": {",
-      "\t\"errorsFile\": \"errors.json\"",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/genericrandomerrorplugin.schema.json\",",
+      "\t\"errorsFile\": \"errors.json\",",
       "\t\"rate\": 50",
       "}"
     ],
@@ -410,7 +421,7 @@
     "prefix": "devproxy-plugin-generic-random-error-file",
     "body": [
       "{",
-      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/genericrandomerrorplugin.schema.json\",",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/genericrandomerrorplugin.errorsfile.schema.json\",",
       "\t\"errors\": [",
       "\t\t$1",
       "\t]",
@@ -421,7 +432,7 @@
   "GenericRandomErrorPluginFileSchema": {
     "prefix": "devproxy-plugin-generic-random-error-file-schema",
     "body": [
-      "\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/genericrandomerrorplugin.schema.json\","
+      "\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/genericrandomerrorplugin.errorsfile.schema.json\","
     ],
     "description": "GenericRandomErrorPlugin errors file schema"
   },
@@ -478,6 +489,7 @@
     "prefix": "devproxy-plugin-graph-minimal-permissions-guidance-config",
     "body": [
       "\"graphMinimalPermissionsGuidancePlugin\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/graphminimalpermissionsguidanceplugin.schema.json\",",
       "\t\"permissionsToIgnore\": [",
       "\t\t\"profile\",",
       "\t\t\"openid\",",
@@ -503,6 +515,7 @@
     "prefix": "devproxy-plugin-graph-minimal-permissions-config",
     "body": [
       "\"graphMinimalPermissionsPlugin\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/graphmininalpermissionsplugin.schema.json\",",
       "\t\"type\": \"delegated\"",
       "}"
     ],
@@ -534,6 +547,7 @@
     "prefix": "devproxy-plugin-graph-mock-response-config",
     "body": [
       "\"graphMockResponsePlugin\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/mockresponseplugin.schema.json\",",
       "\t\"mocksFile\": \"mocks.json\"",
       "}"
     ],
@@ -564,6 +578,7 @@
     "prefix": "devproxy-plugin-graph-random-error-config",
     "body": [
       "\"graphRandomErrorPlugin\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/graphrandomerrorplugin.schema.json\",",
       "\t\"allowedErrors\": [ 429, 500, 502, 503, 504, 507 ]",
       "\t\"rate\": 50",
       "}"
@@ -627,6 +642,7 @@
     "prefix": "devproxy-plugin-http-file-generator-config",
     "body": [
       "\"httpFileGeneratorPlugin\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/httpfilegeneratorplugin.schema.json\",",
       "\t\"includeOptionsRequests\": false",
       "}"
     ],
@@ -648,6 +664,7 @@
     "prefix": "devproxy-plugin-latency-config",
     "body": [
       "\"latencyPlugin\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/latencyplugin.schema.json\",",
       "\t\"minMs\": 200,",
       "\t\"maxMs\": 10000",
       "}"
@@ -669,6 +686,7 @@
     "prefix": "devproxy-plugin-minimal-permissions-config",
     "body": [
       "\"minimalPermissionsPlugin\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/minimalpermissionsplugin.schema.json\",",
       "\t\"apiSpecsFolderPath\": \"./api-specs\"",
       "}"
     ],
@@ -701,6 +719,7 @@
     "prefix": "devproxy-plugin-mock-request-config",
     "body": [
       "\"mockRequestPlugin\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/mockrequestplugin.schema.json\",",
       "\t\"mockFile\": \"mock-request.json\"",
       "}"
     ],
@@ -722,6 +741,7 @@
     "prefix": "devproxy-plugin-mock-response-config",
     "body": [
       "\"mockResponsePlugin\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/mockresponseplugin.schema.json\",",
       "\t\"mocksFile\": \"mocks.json\"",
       "}"
     ],
@@ -730,7 +750,7 @@
   "MockResponsePluginFileSchema": {
     "prefix": "devproxy-plugin-mock-response-schema",
     "body": [
-      "\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/mockresponseplugin.schema.json\","
+      "\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/mockresponseplugin.mocksfile.schema.json\","
     ],
     "description": "MockResponsePlugin schema"
   },
@@ -792,6 +812,7 @@
     "prefix": "devproxy-plugin-open-api-spec-generator-config",
     "body": [
       "\"openApiSpecGeneratorPlugin\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/openapispecgeneratorplugin.schema.json\",",
       "\t\"includeOptionsRequests\": false,",
       "\t\"specVersion\": \"v3_0\",",
       "\t\"specFormat\": \"Json\"",
@@ -814,6 +835,7 @@
     "prefix": "devproxy-plugin-rate-limiting-config",
     "body": [
       "\"rateLimiting\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/ratelimitingplugin.schema.json\",",
       "\t\"costPerRequest\": 2,",
       "\t\"rateLimit\": 120,",
       "\t\"retryAfterSeconds\": 5",
@@ -825,7 +847,7 @@
     "prefix": "devproxy-plugin-rate-limiting-file",
     "body": [
       "{",
-      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/ratelimitingplugin.schema.json\",",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/ratelimitingplugin.customresponsefile.schema.json\",",
       "\t\"body\": {",
       "\t\t$1",
       "\t},",
@@ -840,7 +862,7 @@
   "RateLimitingFileSchema": {
     "prefix": "devproxy-plugin-rate-limiting-file-schema",
     "body": [
-      "\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/ratelimitingplugin.schema.json\","
+      "\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/ratelimitingplugin.customresponsefile.schema.json\","
     ],
     "description": "Dev Proxy rate limiting file schema"
   },
@@ -871,6 +893,7 @@
     "prefix": "devproxy-plugin-rewrite-config",
     "body": [
       "\"rewritePlugin\": {",
+      "\t\"\\$schema\": \"https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.25.0/rewriteplugin.schema.json\",",
       "\t\"rewritesFile\": \"rewrites.json\"",
       "}"
     ],