-
Notifications
You must be signed in to change notification settings - Fork 6
Schemas for connection config, and test script #512
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
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
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
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
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
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,152 @@ | ||
| { | ||
| "$id": "connection_config.schema.json", | ||
| "$schema": "https://json-schema.org/draft/2020-12/schema", | ||
| "type": "object", | ||
| "unevaluatedProperties": false, | ||
| "description": "Configuration for a connection to a data source or destination", | ||
| "properties": { | ||
| "project": { | ||
| "type": "string", | ||
| "description": "CDF project used for the connection." | ||
| }, | ||
| "base-url": { | ||
| "type": "string", | ||
| "description": "CDF base URL used for the connection, for example https://api.cognitedata.com or https://az-eastus-1.cognitedata.com" | ||
| }, | ||
| "integration": { | ||
| "type": "object", | ||
| "description": "Name of the integration to use for remote config and status reporting.", | ||
| "unevaluatedProperties": false, | ||
| "properties": { | ||
| "external-id": { | ||
| "type": "string", | ||
| "description": "External ID of the integration to use for remote config and status reporting." | ||
| } | ||
| }, | ||
| "required": [ | ||
| "external-id" | ||
| ] | ||
| }, | ||
| "authentication": { | ||
| "type": "object", | ||
| "unevaluatedProperties": false, | ||
| "description": "Authentication configuration for the CDF connection.", | ||
| "discriminatorProp": "type", | ||
einarmo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "oneOf": [ | ||
| { | ||
| "type": "object", | ||
| "description": "Configuration for connecting to CDF using client credentials.", | ||
| "unevaluatedProperties": false, | ||
| "title": "Client Credentials", | ||
| "properties": { | ||
| "type": { | ||
| "type": "string", | ||
| "const": "client-credentials", | ||
| "description": "Type of authentication, must be 'client-credentials' for connecting to CDF using client credentials." | ||
| }, | ||
| "client-id": { | ||
| "type": "string", | ||
| "description": "Client ID" | ||
| }, | ||
| "scopes": { | ||
| "type": "string", | ||
| "description": "Space separated list of scopes to request when obtaining access tokens, for example https://api.cognitedata.com/.default." | ||
| }, | ||
| "client-secret": { | ||
| "type": "string", | ||
| "description": "Client secret" | ||
| }, | ||
| "token-url": { | ||
| "type": "string", | ||
| "description": "Token URL for obtaining access tokens, for example https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/token" | ||
| }, | ||
| "resource": { | ||
| "type": "string", | ||
| "description": "Resource identifier passed along with token requests." | ||
| }, | ||
| "audience": { | ||
| "type": "string", | ||
| "description": "Audience identifier passed along with token requests." | ||
| } | ||
| }, | ||
| "required": [ | ||
| "type", | ||
| "client-id", | ||
| "scopes", | ||
| "client-secret", | ||
| "token-url" | ||
| ] | ||
| }, | ||
| { | ||
| "type": "object", | ||
| "description": "Configuration for connecting to CDF using a certificate.", | ||
| "unevaluatedProperties": false, | ||
| "title": "Client Certificate", | ||
| "properties": { | ||
| "type": { | ||
| "type": "string", | ||
| "const": "client-certificate", | ||
| "description": "Type of authentication, must be 'client-certificate' for connecting to CDF using a client certificate." | ||
| }, | ||
| "client-id": { | ||
| "type": "string", | ||
| "description": "Client ID" | ||
| }, | ||
| "scopes": { | ||
| "type": "string", | ||
| "description": "Space separated list of scopes to request when obtaining access tokens, for example https://api.cognitedata.com/.default." | ||
| }, | ||
| "path": { | ||
| "type": "string", | ||
| "description": "Path to the client certificate file." | ||
| }, | ||
| "authority-url": { | ||
| "type": "string", | ||
| "description": "Authority URL for obtaining access tokens." | ||
| }, | ||
| "password": { | ||
| "type": "string", | ||
| "description": "Password for the client certificate, if it is encrypted." | ||
| } | ||
| }, | ||
| "required": [ | ||
| "type", | ||
| "client-id", | ||
| "scopes", | ||
| "path", | ||
| "authority-url" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "connection": { | ||
| "type": "object", | ||
| "description": "Additional configuration for the connection.", | ||
| "unevaluatedProperties": false, | ||
| "properties": { | ||
| "retries": { | ||
| "$ref": "retries_config.schema.json" | ||
| }, | ||
| "ssl-certificates": { | ||
| "type": "object", | ||
| "description": "Configuration for SSL certificates to use for the connection.", | ||
| "unevaluatedProperties": false, | ||
| "properties": { | ||
| "verify": { | ||
| "type": "boolean", | ||
| "description": "Whether to verify SSL certificates for the connection.", | ||
| "default": true | ||
| }, | ||
| "allow-list": { | ||
| "type": "array", | ||
| "description": "List of SSL certificate thumbprints to allow for the connection, even if they are not valid according to the system's certificate store.", | ||
| "items": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
File renamed without changes.
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
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,26 @@ | ||
| { | ||
| "$id": "retries_config.schema.json", | ||
| "$schema": "https://json-schema.org/draft/2020-12/schema", | ||
| "type": "object", | ||
| "unevaluatedProperties": false, | ||
| "description": "Configuration for retries", | ||
| "properties": { | ||
| "max-retries": { | ||
| "type": "integer", | ||
| "description": "Maximum number of retries before giving up. Setting to -1 will retry indefinitely.", | ||
| "default": 10, | ||
| "minimum": -1 | ||
| }, | ||
| "max-backoff": { | ||
| "type": "string", | ||
| "description": "Maximum delay between retries, on the form 12s, 15m, 1h, etc.", | ||
| "default": "30s" | ||
| }, | ||
einarmo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "timeout": { | ||
| "type": "string", | ||
| "description": "Timeout in seconds for each retry attempt, on the form 12s, 15m, 1h, etc.", | ||
| "default": "30s", | ||
| "pattern": "^([0-9]+)[ \t]*(s|m|h|d)$" | ||
| } | ||
| } | ||
| } | ||
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,53 @@ | ||
| { | ||
| "$id": "schedule_config.schema.json", | ||
| "$schema": "https://json-schema.org/draft/2020-12/schema", | ||
| "type": "object", | ||
| "unevaluatedProperties": false, | ||
| "description": "Configuration for scheduling task runs", | ||
| "discriminatorProp": "type", | ||
einarmo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "oneOf": [ | ||
| { | ||
| "type": "object", | ||
| "description": "Configuration for a schedule that runs at a fixed interval", | ||
| "unevaluatedProperties": false, | ||
| "title": "Interval", | ||
| "properties": { | ||
| "type": { | ||
| "type": "string", | ||
| "const": "interval", | ||
| "description": "Type of schedule, must be 'interval' for a schedule that runs at a fixed interval" | ||
| }, | ||
| "expression": { | ||
| "type": "string", | ||
| "description": "Interval between task runs, on the form 12s, 15m, 1h, etc.", | ||
| "pattern": "^([0-9]+)[ \t]*(s|m|h|d)$" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "type", | ||
| "expression" | ||
| ] | ||
| }, | ||
| { | ||
| "type": "object", | ||
| "description": "Configuration for a schedule that runs according to a cron expression", | ||
| "unevaluatedProperties": false, | ||
| "title": "Cron", | ||
| "properties": { | ||
| "type": { | ||
| "type": "string", | ||
| "const": "cron", | ||
| "description": "Type of schedule, must be 'cron' for a schedule that runs according to a cron expression" | ||
| }, | ||
| "expression": { | ||
| "type": "string", | ||
| "description": "Cron expression defining when to run the task, on the form '0 0 * * *' (every day at midnight), '*/15 * * * *' (every 15 minutes), etc." | ||
| } | ||
| }, | ||
| "required": [ | ||
| "type", | ||
| "expression" | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
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
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,18 @@ | ||
| #!/bin/bash | ||
|
|
||
| set -e -x | ||
|
|
||
| target_schemas=( | ||
| "schema/base_config.schema.json" | ||
| "schema/unstable/connection_config.schema.json" | ||
| "schema/unstable/schedule_config.schema.json" | ||
| "schema/unstable/extractor_config.schema.json" | ||
| ) | ||
|
|
||
| for schema in "${target_schemas[@]}"; do | ||
| echo "Processing $schema" | ||
| publish-extractor schema --schema "$schema" --output bundled.schema.json | ||
| echo "Generating docs for $schema" | ||
| publish-extractor docs --schema bundled.schema.json | ||
| rm bundled.schema.json | ||
| done |
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.
Uh oh!
There was an error while loading. Please reload this page.