@techdocs/cli

{ "schemas": [ { "packageName": "@backstage/cli", "value": { "$schema": "https://backstage.io/schema/config-v1", "title": "@backstage/cli", "type": "object", "properties": { "app": { "type": "object", "properties": { "baseUrl": { "type": "string", "visibility": "frontend" }, "title": { "type": "string", "visibility": "frontend" }, "datadogRum": { "type": "object", "description": "Datadog RUM events configuration", "properties": { "env": { "type": "string", "visibility": "frontend", "description": "Environment for Datadog RUM events" }, "clientToken": { "type": "string", "visibility": "frontend", "description": "clientToken for Datadog RUM events" }, "applicationId": { "type": "string", "visibility": "frontend", "description": "applicationId for Datadog RUM events" }, "site": { "type": "string", "visibility": "frontend", "description": "site for Datadog RUM events" }, "sessionSampleRate": { "type": "number", "visibility": "frontend", "description": "sample rate of Datadog RUM events" }, "sessionReplaySampleRate": { "type": "number", "visibility": "frontend", "description": "sample rate of session replays based upon already sampled Datadog RUM events" } }, "required": [ "clientToken", "applicationId" ] }, "listen": { "type": "object", "description": "Listening configuration for local development", "properties": { "host": { "type": "string", "visibility": "frontend", "description": "The host that the frontend should be bound to. Only used for local development." }, "port": { "type": "number", "visibility": "frontend", "description": "The port that the frontend should be bound to. Only used for local development." } } }, "https": { "type": "object", "description": "Only used for local development. The https object is passed to webpack in order to enable using https on localhost.", "properties": { "certificate": { "type": "object", "description": "Parent object containing certificate and the private key", "required": [ "key", "cert" ], "properties": { "key": { "type": "string", "visibility": "secret", "description": "Https Certificate private key. Use $file to load in a file" }, "cert": { "type": "string", "visibility": "secret", "description": "Https Certificate. Use $file to load in a file" } } } } } } } } }, "path": "../cli/package.json" }, { "path": "../core-app-api/config.d.ts", "value": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "app": { "type": "object", "properties": { "baseUrl": { "type": "string", "description": "The public absolute root URL that the frontend.", "visibility": "frontend" }, "title": { "type": "string", "description": "The title of the app, as shown in the Backstage web interface.", "visibility": "frontend" }, "support": { "type": "object", "properties": { "url": { "type": "string", "description": "The primary support url.", "visibility": "frontend" }, "items": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the support item grouping.", "visibility": "frontend" }, "icon": { "type": "string", "description": "An optional icon for the support item grouping.", "visibility": "frontend" }, "links": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "visibility": "frontend" }, "title": { "type": "string", "visibility": "frontend" } }, "required": [ "url" ] }, "description": "A list of support links for the Backstage instance inside this grouping." } }, "required": [ "title", "links" ] }, "description": "A list of categorized support item groupings." } }, "required": [ "url", "items" ], "description": "Information about support of this Backstage instance and how to contact the integrator team." }, "routes": { "type": "object", "properties": { "bindings": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean", "const": false } ] }, "description": "Maps external route references to regular route references. Both the key and the value is expected to be on the form `<pluginId>.<routeId>`. If the value is `false`, the route will be disabled even if it has a default mapping.", "deepVisibility": "frontend" } } } }, "required": [ "baseUrl" ], "description": "Generic frontend configuration." }, "backend": { "type": "object", "properties": { "baseUrl": { "type": "string", "description": "The public absolute root URL that the backend is reachable at, from the browser's perspective.", "visibility": "frontend" } }, "required": [ "baseUrl" ], "description": "Generic backend configuration." }, "organization": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the organization that the app belongs to.", "visibility": "frontend" } }, "description": "Configuration that provides information about the organization that the app is for." }, "homepage": { "type": "object", "properties": { "clocks": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "visibility": "frontend" }, "timezone": { "type": "string", "visibility": "frontend" } }, "required": [ "label", "timezone" ] } } }, "description": "This config was used by the HomepageTimer but has been replaced by the HeaderWorldClock in the home plugin", "deprecated": "in favor of the HeaderWorldClock which is found in the home plugin" }, "auth": { "type": "object", "properties": { "environment": { "type": "string", "description": "The 'environment' attribute added as an optional parameter to have configurable environment value for `auth.providers`. default value: 'development' optional values: 'development' | 'production'", "visibility": "frontend" } }, "description": "Configuration that provides information on available configured authentication providers." }, "enableExperimentalRedirectFlow": { "type": "boolean", "description": "Enable redirect authentication flow type, instead of a popup for authentication.", "visibility": "frontend" }, "discovery": { "type": "object", "properties": { "endpoints": { "type": "array", "items": { "type": "object", "properties": { "target": { "anyOf": [ { "type": "string" }, { "type": "object", "properties": { "external": { "type": "string", "visibility": "frontend" } } } ], "description": "The target baseUrl to use for the plugin\n\nCan be either a string or an object with internal and external keys. (Internal is used for the backend, external for the frontend) Targets with `{{pluginId}}` or `{{ pluginId }} in the url will be replaced with the pluginId.", "visibility": "frontend" }, "plugins": { "type": "array", "items": { "type": "string" }, "description": "Array of plugins which use the target baseUrl. Use `'*'` to configure a fallback target for all plugins without an explicit target.", "visibility": "frontend" } }, "required": [ "target", "plugins" ] }, "description": "Endpoints\n\nA list of target baseUrls and the associated plugins.", "visibility": "frontend" } }, "description": "Discovery options.", "visibility": "frontend" } }, "required": [ "app", "backend" ] }, "packageName": "@backstage/core-app-api" }, { "path": "../core-components/config.d.ts", "value": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "auth": { "type": "object", "properties": { "autologout": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Enable or disable the autologout feature", "visibility": "frontend" }, "idleTimeoutMinutes": { "type": "number", "description": "Number of minutes after which the inactive user is logged out automatically. Default is 60 minutes (1 hour)", "visibility": "frontend" }, "promptBeforeIdleSeconds": { "type": "number", "description": "Number of seconds before the idle timeout where the user will be asked if it's still active. A dialog will be shown. Default is 10 seconds. Set to 0 seconds to disable the prompt.", "visibility": "frontend" }, "useWorkerTimers": { "type": "boolean", "description": "Enable/disable the usage of worker thread timers instead of main thread timers. Default is true. If you experience some browser incompatibility, you may try to set this to false.", "visibility": "frontend" }, "logoutIfDisconnected": { "type": "boolean", "description": "Enable/disable the automatic logout also on users that are logged in but with no Backstage tabs open. Default is true.", "visibility": "frontend" } }, "description": "Autologout feature configuration" } } } } }, "packageName": "@backstage/core-components" }, { "path": "../../plugins/permission-common/config.d.ts", "value": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "permission": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether authorization is enabled in Backstage. Defaults to false, which means authorization requests will be automatically allowed without invoking the authorization policy.", "visibility": "frontend" }, "EXPERIMENTAL_enableBatchedRequests": { "type": "boolean", "visibility": "frontend" } }, "description": "Configuration options for Backstage permissions and authorization" } } }, "packageName": "@backstage/plugin-permission-common" }, { "path": "../../plugins/techdocs/config.d.ts", "value": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "techdocs": { "type": "object", "properties": { "builder": { "type": "string", "enum": [ "local", "external" ], "description": "Documentation building process depends on the builder attr", "visibility": "frontend" }, "legacyUseCaseSensitiveTripletPaths": { "type": "boolean", "description": "Allows fallback to case-sensitive triplets in case of migration issues.", "visibility": "frontend" }, "sanitizer": { "type": "object", "properties": { "allowedIframeHosts": { "type": "array", "items": { "type": "string" }, "description": "Allows iframe tag only for listed hosts Example: allowedIframeHosts: [\"example.com\"] this will allow all iframes with the host `example.com` in the src attribute", "visibility": "frontend" }, "allowedCustomElementTagNameRegExp": { "type": "string", "description": "Allows listed custom element tag name regex Example: allowedCustomElementTagNameRegExp: '^backstage-' this will allow all custom elements with tag name matching `^backstage-` like <backstage-custom-element /> etc.", "visibility": "frontend" }, "allowedCustomElementAttributeNameRegExp": { "type": "string", "description": "Allows listed custom element attribute name regex Example: allowedCustomElementAttributeNameRegExp: 'attribute1|attribute2' this will allow all custom element attributes matching `attribute1` or `attribute2` like <backstage-custom-element attribute1=\"yes\" attribute2/>", "visibility": "frontend" }, "additionalAllowedURIProtocols": { "type": "array", "items": { "type": "string" }, "description": "Allows listed protocols in attributes with URI values Example: additionalAllowedURIProtocols: ['vscode'] this will allow all attributes with URI values to have `vscode` protocol like `vscode://some/path` in addition to the default protocols matched by DOMPurify's IS_ALLOWED_URI RegExp:", "visibility": "frontend" } } } }, "description": "Configuration options for the techdocs plugin" } } }, "packageName": "@backstage/plugin-techdocs" }, { "path": "../integration/config.d.ts", "value": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "integrations": { "type": "object", "properties": { "azure": { "type": "array", "items": { "type": "object", "properties": { "host": { "type": "string", "description": "The hostname of the given Azure instance", "visibility": "frontend" }, "credentials": { "type": "array", "items": { "type": "object", "properties": { "organizations": { "type": "array", "items": { "type": "string" } }, "clientId": { "type": "string" }, "clientSecret": { "type": "string", "visibility": "secret" }, "tenantId": { "type": "string" }, "personalAccessToken": { "type": "string", "visibility": "secret" }, "managedIdentityClientId": { "type": "string" } } }, "description": "The credentials to use for requests. If multiple credentials are specified the first one that matches the organization is used. If no organization matches the first credential without an organization is used.\n\nIf no credentials are specified at all, either a default credential (for Azure DevOps) or anonymous access (for Azure DevOps Server) is used." }, "commitSigningKey": { "type": "string", "description": "PGP signing key for signing commits.", "visibility": "secret" } }, "required": [ "host" ] }, "description": "Integration configuration for Azure" }, "azureBlobStorage": { "type": "array", "items": { "type": "object", "properties": { "accountName": { "type": "string", "description": "The name of the Azure Storage Account, e.g., \"mystorageaccount\"." }, "accountKey": { "type": "string", "description": "The primary or secondary key for the Azure Storage Account. Only required if connectionString or SAS token are not specified.", "visibility": "secret" }, "sasToken": { "type": "string", "description": "A Shared Access Signature (SAS) token for limited access to resources.", "visibility": "secret" }, "connectionString": { "type": "string", "description": "A full connection string for the Azure Storage Account. This includes the account name, key, and endpoint details.", "visibility": "secret" }, "endpointSuffix": { "type": "string", "description": "Optional endpoint suffix for custom domains or sovereign clouds. e.g., \"core.windows.net\" for public Azure or \"core.usgovcloudapi.net\" for US Government cloud." }, "endpoint": { "type": "string", "description": "Optional endpoint URL for custom domain. Uses default if not provided.", "visibility": "frontend" }, "aadCredential": { "type": "object", "properties": { "clientId": { "type": "string", "description": "The client ID of the Azure AD application." }, "tenantId": { "type": "string", "description": "The tenant ID for Azure AD." }, "clientSecret": { "type": "string", "description": "The client secret for the Azure AD application.", "visibility": "secret" } }, "required": [ "clientId", "tenantId", "clientSecret" ], "description": "Optional credential to use for Azure Active Directory authentication." } } }, "description": "Integration configuration for Azure Blob Storage" }, "bitbucketCloud": { "type": "array", "items": { "type": "object", "properties": { "username": { "type": "string", "description": "The username to use for authenticated requests." }, "token": { "type": "string", "description": "Token used to authenticate requests.", "visibility": "secret" }, "appPassword": { "type": "string", "description": "Bitbucket Cloud app password used to authenticate requests.", "visibility": "secret", "deprecated": "Use `token` instead." }, "clientId": { "type": "string", "description": "OAuth client ID for Bitbucket Cloud.", "visibility": "secret" }, "clientSecret": { "type": "string", "description": "OAuth client secret for Bitbucket Cloud.", "visibility": "secret" }, "commitSigningKey": { "type": "string", "description": "PGP signing key for signing commits.", "visibility": "secret" } } }, "description": "Integration configuration for Bitbucket Cloud" }, "bitbucketServer": { "type": "array", "items": { "type": "object", "properties": { "host": { "type": "string", "description": "The hostname of the given Bitbucket Server instance", "visibility": "frontend" }, "token": { "type": "string", "description": "Token used to authenticate requests.", "visibility": "secret" }, "username": { "type": "string", "description": "Username used to authenticate requests with Basic Auth.", "visibility": "secret" }, "password": { "type": "string", "description": "Password (or token as password) used to authenticate requests with Basic Auth.", "visibility": "secret" }, "apiBaseUrl": { "type": "string", "description": "The base url for the Bitbucket Server API, for example https://<host>/rest/api/1.0", "visibility": "frontend" }, "commitSigningKey": { "type": "string", "description": "PGP signing key for signing commits.", "visibility": "secret" } }, "required": [ "host" ] }, "description": "Integration configuration for Bitbucket Server" }, "gerrit": { "type": "array", "items": { "type": "object", "properties": { "host": { "type": "string", "description": "The hostname of the given Gerrit instance", "visibility": "frontend" }, "baseUrl": { "type": "string", "description": "The base url for the Gerrit instance.", "visibility": "frontend" }, "gitilesBaseUrl": { "type": "string", "description": "The gitiles base url.", "visibility": "frontend" }, "cloneUrl": { "type": "string", "description": "The base url for cloning repos.", "visibility": "frontend" }, "disableEditUrl": { "type": "boolean", "description": "Disable the edit url feature.", "visibility": "frontend" }, "username": { "type": "string", "description": "The username to use for authenticated requests.", "visibility": "secret" }, "password": { "type": "string", "description": "Gerrit password used to authenticate requests. This can be either a password or a generated access token.", "visibility": "secret" }, "commitSigningKey": { "type": "string", "description": "PGP signing key for signing commits.", "visibility": "secret" } }, "required": [ "host", "gitilesBaseUrl" ] }, "description": "Integration configuration for Gerrit" }, "github": { "type": "array", "items": { "type": "object", "properties": { "host": { "type": "string", "description": "The hostname of the given GitHub instance", "visibility": "frontend" }, "token": { "type": "string", "description": "Token used to authenticate requests.", "visibility": "secret" }, "apiBaseUrl": { "type": "string", "description": "The base url for the GitHub API, for example https://api.github.com", "visibility": "frontend" }, "rawBaseUrl": { "type": "string", "description": "The base url for GitHub raw resources, for example https://raw.githubusercontent.com", "visibility": "frontend" }, "apps": { "type": "array", "items": { "type": "object", "properties": { "appId": { "type": [ "number", "string" ], "description": "The numeric GitHub App ID, string for environment variables" }, "privateKey": { "type": "string", "description": "The private key to use for auth against the app", "visibility": "secret" }, "webhookSecret": { "type": "string", "description": "The secret used for webhooks", "visibility": "secret" }, "clientId": { "type": "string", "description": "The client ID to use" }, "clientSecret": { "type": "string", "description": "The client secret to use", "visibility": "secret" }, "allowedInstallationOwners": { "type": "array", "items": { "type": "string" }, "description": "List of installation owners allowed to be used by this GitHub app. The GitHub UI does not provide a way to list the installations. However you can list the installations with the GitHub API. You can find the list of installations here: https://api.github.com/app/installations The relevant documentation for this is here. https://docs.github.com/en/rest/reference/apps#list-installations-for-the-authenticated-app--code-samples" }, "publicAccess": { "type": "boolean", "description": "If true, then an installation token will be issued for access when no other token is available." } }, "required": [ "appId", "privateKey", "clientId", "clientSecret" ] }, "description": "GitHub Apps configuration" } }, "required": [ "host" ] }, "description": "Integration configuration for GitHub" }, "gitlab": { "type": "array", "items": { "type": "object", "properties": { "host": { "type": "string", "description": "The host of the target that this matches on, e.g. \"gitlab.com\".", "visibility": "frontend" }, "apiBaseUrl": { "type": "string", "description": "The base URL of the API of this provider, e.g. \"https://gitlab.com/api/v4\", with no trailing slash.\n\nMay be omitted specifically for public GitLab; then it will be deduced.", "visibility": "frontend" }, "token": { "type": "string", "description": "The authorization token to use for requests to this provider.\n\nIf no token is specified, anonymous access is used.", "visibility": "secret" }, "baseUrl": { "type": "string", "description": "The baseUrl of this provider, e.g. \"https://gitlab.com\", which is passed into the GitLab client.\n\nIf no baseUrl is provided, it will default to https://${host}.", "visibility": "frontend" }, "commitSigningKey": { "type": "string", "description": "PGP signing key for signing commits.", "visibility": "secret" }, "retry": { "type": "object", "properties": { "maxRetries": { "type": "number", "description": "Maximum number of retries for failed requests.", "visibility": "frontend" }, "retryStatusCodes": { "type": "array", "items": { "type": "number" }, "description": "HTTP status codes that should trigger a retry.", "visibility": "frontend" }, "maxApiRequestsPerMinute": { "type": "number", "description": "Maximum number of API requests allowed per minute. Set to -1 to disable rate limiting.", "visibility": "frontend" } }, "description": "Retry configuration for requests.", "visibility": "frontend" } }, "required": [ "host" ] }, "description": "Integration configuration for GitLab" }, "googleGcs": { "type": "object", "properties": { "clientEmail": { "type": "string", "description": "Service account email used to authenticate requests." }, "privateKey": { "type": "string", "description": "Service account private key used to authenticate requests.", "visibility": "secret" } }, "description": "Integration configuration for Google Cloud Storage" }, "awsS3": { "type": "array", "items": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "AWS Endpoint. The endpoint URI to send requests to. The default endpoint is built from the configured region.", "visibility": "frontend" }, "s3ForcePathStyle": { "type": "boolean", "description": "Whether to use path style URLs when communicating with S3. Defaults to false. This allows providers like LocalStack, Minio and Wasabi (and possibly others) to be used.", "visibility": "frontend" }, "accessKeyId": { "type": "string", "description": "Account access key used to authenticate requests." }, "secretAccessKey": { "type": "string", "description": "Account secret key used to authenticate requests.", "visibility": "secret" }, "roleArn": { "type": "string", "description": "ARN of the role to be assumed" }, "externalId": { "type": "string", "description": "External ID to use when assuming role" } } }, "description": "Integration configuration for AWS S3 Service" }, "gitea": { "type": "array", "items": { "type": "object", "properties": { "host": { "type": "string", "description": "The hostname of the given Gitea instance", "visibility": "frontend" }, "baseUrl": { "type": "string", "description": "The base url for the Gitea instance.", "visibility": "frontend" }, "username": { "type": "string", "description": "The username to use for authenticated requests.", "visibility": "secret" }, "password": { "type": "string", "description": "Gitea password used to authenticate requests. This can be either a password or a generated access token.", "visibility": "secret" }, "commitSigningKey": { "type": "string", "description": "PGP signing key for signing commits.", "visibility": "secret" } }, "required": [ "host" ] }, "description": "Integration configuration for Gitea" }, "harness": { "type": "array", "items": { "type": "object", "properties": { "host": { "type": "string", "description": "The hostname of the given Harness Code instance", "visibility": "frontend" }, "apiKey": { "type": "string", "description": "The apikey to use for authenticated requests.", "visibility": "secret" }, "token": { "type": "string", "description": "Harness Code token used to authenticate requests. This can be either a generated access token.", "visibility": "secret" } }, "required": [ "host" ] }, "description": "Integration configuration for Harness Code" } }, "description": "Configuration for integrations towards various external repository provider systems", "visibility": "frontend" } } }, "packageName": "@backstage/integration" }, { "path": "../../plugins/catalog/config.d.ts", "value": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "catalog": { "type": "object", "properties": { "experimentalPagination": { "anyOf": [ { "type": "boolean" }, { "type": "object", "properties": { "limit": { "type": "number" } } } ], "deepVisibility": "frontend" } } } } }, "packageName": "@backstage/plugin-catalog" }, { "path": "../frontend-app-api/config.d.ts", "value": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "app": { "type": "object", "properties": { "packages": { "anyOf": [ { "type": "string", "const": "all" }, { "type": "object", "properties": { "include": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": { "type": "string" } } } } ], "description": "Controls what packages are loaded by the new frontend system.", "visibility": "frontend", "deepVisibility": "frontend" }, "routes": { "type": "object", "properties": { "bindings": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "boolean", "const": false } ] }, "description": "Maps external route references to regular route references. Both the key and the value is expected to be on the form `<pluginId>.<routeId>`. If the value is `false`, the route will be disabled even if it has a default mapping.", "deepVisibility": "frontend" } } }, "extensions": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "object", "additionalProperties": { "anyOf": [ { "type": "boolean" }, { "type": "object", "properties": { "attachTo": { "type": "object", "properties": { "id": { "type": "string" }, "input": { "type": "string" } }, "required": [ "id", "input" ] }, "disabled": { "type": "boolean" }, "config": {} } } ] } } ] }, "deepVisibility": "frontend" }, "pluginOverrides": { "type": "array", "items": { "type": "object", "properties": { "match": { "type": "object", "properties": { "pluginId": { "type": "string", "description": "A pattern that is matched against the plugin ID." }, "packageName": { "type": "string", "description": "A pattern that is matched against the package name." } }, "description": "The criteria for matching plugins to override." }, "info": { "type": "object", "properties": { "description": { "type": "string", "description": "Override the description of the plugin." }, "ownerEntityRefs": { "type": "array", "items": { "type": "string" }, "description": "Override the owner entity references of the plugin." }, "links": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string" } }, "required": [ "title", "url" ] }, "description": "Override the links of the plugin." } }, "description": "Overrides individual top-level fields of the plugin info." } }, "required": [ "info" ] }, "description": "This section enables you to override certain properties of specific or groups of plugins.", "deepVisibility": "