-
Notifications
You must be signed in to change notification settings - Fork 83
Adds v2.3.3 schemas #1626
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Adds v2.3.3 schemas #1626
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
38 changes: 38 additions & 0 deletions
38
schemas/v2.3.3/apicenterminimalpermissionsplugin.schema.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| { | ||
| "$schema": "https://json-schema.org/draft/2020-12/schema", | ||
| "title": "Dev Proxy ApiCenterMinimalPermissionsPlugin config schema", | ||
| "type": "object", | ||
| "properties": { | ||
| "$schema": { | ||
| "type": "string", | ||
| "description": "The JSON schema reference for validation." | ||
| }, | ||
| "resourceGroupName": { | ||
| "type": "string", | ||
| "description": "Name of the resource group where the Azure API Center is located." | ||
| }, | ||
| "serviceName": { | ||
| "type": "string", | ||
| "description": "Name of the Azure API Center instance that Dev Proxy should use to check if the APIs used in the app are registered." | ||
| }, | ||
| "subscriptionId": { | ||
| "type": "string", | ||
| "description": "ID of the Azure subscription where the Azure API Center instance is located." | ||
| }, | ||
| "workspace": { | ||
| "type": "string", | ||
| "description": "Name of the Azure API Center workspace to use. Default is 'default'.", | ||
| "default": "default" | ||
| }, | ||
| "schemeName": { | ||
| "type": "string", | ||
| "description": "The name of the security scheme definition. Used to determine minimal permissions required for API calls." | ||
| } | ||
| }, | ||
| "required": [ | ||
| "resourceGroupName", | ||
| "serviceName", | ||
| "subscriptionId" | ||
| ], | ||
| "additionalProperties": false | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,37 @@ | ||||||||||||||||
| { | ||||||||||||||||
| "$schema": "https://json-schema.org/draft/2020-12/schema", | ||||||||||||||||
| "title": "Dev Proxy ApiCenterOnboardingPlugin config schema", | ||||||||||||||||
| "type": "object", | ||||||||||||||||
| "properties": { | ||||||||||||||||
| "$schema": { | ||||||||||||||||
| "type": "string", | ||||||||||||||||
| "description": "The JSON schema reference for validation." | ||||||||||||||||
| }, | ||||||||||||||||
| "createApicEntryForNewApis": { | ||||||||||||||||
| "type": "boolean", | ||||||||||||||||
| "description": "Set to true to have Dev Proxy create new API entries for APIs detected but not yet registered in API Center. When false, Dev Proxy only lists unregistered APIs. Default is true." | ||||||||||||||||
| }, | ||||||||||||||||
| "resourceGroupName": { | ||||||||||||||||
| "type": "string", | ||||||||||||||||
| "description": "Name of the resource group where the Azure API Center is located." | ||||||||||||||||
| }, | ||||||||||||||||
| "serviceName": { | ||||||||||||||||
| "type": "string", | ||||||||||||||||
| "description": "Name of the Azure API Center instance that Dev Proxy should use to check if the APIs used in the app are registered." | ||||||||||||||||
| }, | ||||||||||||||||
| "subscriptionId": { | ||||||||||||||||
| "type": "string", | ||||||||||||||||
| "description": "ID of the Azure subscription where the Azure API Center instance is located." | ||||||||||||||||
| }, | ||||||||||||||||
| "workspace": { | ||||||||||||||||
| "type": "string", | ||||||||||||||||
| "description": "Name of the Azure API Center workspace to use. Default is 'default'." | ||||||||||||||||
|
Comment on lines
+26
to
+28
|
||||||||||||||||
| "workspace": { | |
| "type": "string", | |
| "description": "Name of the Azure API Center workspace to use. Default is 'default'." | |
| "workspaceName": { | |
| "type": "string", | |
| "description": "Name of the Azure API Center workspace to use. Default is 'default'.", | |
| "default": "default" |
33 changes: 33 additions & 0 deletions
33
schemas/v2.3.3/apicenterproductionversionplugin.schema.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,33 @@ | ||||||||||||||||
| { | ||||||||||||||||
| "$schema": "https://json-schema.org/draft/2020-12/schema", | ||||||||||||||||
| "title": "Dev Proxy ApiCenterProductionVersionPlugin config schema", | ||||||||||||||||
| "type": "object", | ||||||||||||||||
| "properties": { | ||||||||||||||||
| "$schema": { | ||||||||||||||||
| "type": "string", | ||||||||||||||||
| "description": "The JSON schema reference for validation." | ||||||||||||||||
| }, | ||||||||||||||||
| "resourceGroupName": { | ||||||||||||||||
| "type": "string", | ||||||||||||||||
| "description": "Name of the resource group where the Azure API Center is located." | ||||||||||||||||
| }, | ||||||||||||||||
| "serviceName": { | ||||||||||||||||
| "type": "string", | ||||||||||||||||
| "description": "Name of the Azure API Center instance that Dev Proxy should use to check if the APIs used in the app are registered." | ||||||||||||||||
| }, | ||||||||||||||||
| "subscriptionId": { | ||||||||||||||||
| "type": "string", | ||||||||||||||||
| "description": "ID of the Azure subscription where the Azure API Center instance is located." | ||||||||||||||||
| }, | ||||||||||||||||
| "workspace": { | ||||||||||||||||
| "type": "string", | ||||||||||||||||
| "description": "Name of the Azure API Center workspace to use. Default is 'default'." | ||||||||||||||||
|
Comment on lines
+22
to
+24
|
||||||||||||||||
| "workspace": { | |
| "type": "string", | |
| "description": "Name of the Azure API Center workspace to use. Default is 'default'." | |
| "workspaceName": { | |
| "type": "string", | |
| "description": "Name of the Azure API Center workspace to use. Default is 'default'.", | |
| "default": "default" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| { | ||
| "$schema": "https://json-schema.org/draft/2020-12/schema", | ||
| "title": "Dev Proxy AuthPlugin config schema", | ||
| "type": "object", | ||
| "properties": { | ||
| "$schema": { | ||
| "type": "string", | ||
| "description": "The JSON schema reference for validation." | ||
| }, | ||
| "apiKey": { | ||
| "type": "object", | ||
| "description": "Configuration for API key authentication and authorization.", | ||
| "properties": { | ||
| "allowedKeys": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "description": "List of allowed API keys." | ||
| }, | ||
| "parameters": { | ||
| "type": "array", | ||
| "description": "List of parameters that contain the API key.", | ||
| "items": { | ||
| "type": "object", | ||
| "properties": { | ||
| "in": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "header", | ||
| "query", | ||
| "cookie" | ||
| ], | ||
| "description": "Where the parameter is expected to be found. Allowed values: header, query, cookie." | ||
| }, | ||
| "name": { | ||
| "type": "string", | ||
| "description": "Name of the parameter." | ||
| } | ||
| }, | ||
| "required": [ | ||
| "in", | ||
| "name" | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| "required": [ | ||
| "allowedKeys", | ||
| "parameters" | ||
| ] | ||
| }, | ||
| "oauth2": { | ||
| "type": "object", | ||
| "description": "Configuration for OAuth2 authentication and authorization.", | ||
| "properties": { | ||
| "metadataUrl": { | ||
| "type": "string", | ||
| "description": "URL to the OpenID Connect metadata document." | ||
| }, | ||
| "allowedApplications": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "description": "List of allowed application IDs. Leave empty to not validate the application (appid or azp claim) for which the token is issued." | ||
| }, | ||
| "allowedAudiences": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "description": "List of allowed audiences. Leave empty to not validate the audience (aud claim) for which the token is issued." | ||
| }, | ||
| "allowedPrincipals": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "description": "List of allowed principals. Leave empty to not validate the principal (oid claim) for which the token is issued." | ||
| }, | ||
| "allowedTenants": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "description": "List of allowed tenants. Leave empty to not validate the tenant (tid claim) for which the token is issued." | ||
| }, | ||
| "issuer": { | ||
| "type": "string", | ||
| "description": "Allowed token issuer. Leave empty to not validate the token issuer." | ||
| }, | ||
| "roles": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "description": "List of allowed roles. Leave empty to not validate the roles (roles claim) on the token." | ||
| }, | ||
| "scopes": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| }, | ||
| "description": "List of allowed scopes. Leave empty to not validate the scopes (scp claim) on the token." | ||
| }, | ||
| "validateLifetime": { | ||
| "type": "boolean", | ||
| "description": "Set to false to disable validating the token lifetime. Default is true." | ||
| }, | ||
| "validateSigningKey": { | ||
| "type": "boolean", | ||
| "description": "Set to false to disable validating the token signature. Default is true." | ||
| } | ||
| }, | ||
| "required": [ | ||
| "metadataUrl" | ||
| ] | ||
| }, | ||
| "type": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "apiKey", | ||
| "oauth2" | ||
| ], | ||
| "description": "Type of authentication and authorization that Dev Proxy should use. Allowed values: apiKey, oauth2." | ||
| } | ||
| }, | ||
| "required": [ | ||
| "type" | ||
| ], | ||
| "additionalProperties": false | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| { | ||
| "$schema": "https://json-schema.org/draft/2020-12/schema", | ||
| "title": "Dev Proxy CachingGuidancePlugin config schema", | ||
| "type": "object", | ||
| "properties": { | ||
| "$schema": { | ||
| "type": "string", | ||
| "description": "The JSON schema reference for validation." | ||
| }, | ||
| "cacheThresholdSeconds": { | ||
| "type": "integer", | ||
| "description": "The number of seconds between the same request that triggers the guidance warning. Default is 5." | ||
| } | ||
| }, | ||
| "additionalProperties": false | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This schema defines
workspace, but the plugin configuration property isWorkspaceName(so JSON should beworkspaceName). With the current schema, users will configureworkspaceand Dev Proxy will ignore it and use the default workspace. Rename the property toworkspaceName(and keep the existing default of "default").