Credential

Defines a credential and where it should be placed

Application DependenciesCloud NativeIntegrationResearchSpecificationsWorkload Specifications

Properties

Name Type Description
description string A user-friendly description of this credential
env string The environment variable name for this credential
path string The path inside the invocation image for mounting credentials
required boolean Indicates whether this credential must be supplied
applyTo array An optional list of actions handling this credential
View JSON Schema on GitHub

JSON Schema

application-research-credential-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Credential",
  "title": "Credential",
  "type": "object",
  "description": "Defines a credential and where it should be placed",
  "properties": {
    "description": {
      "type": "string",
      "description": "A user-friendly description of this credential"
    },
    "env": {
      "type": "string",
      "description": "The environment variable name for this credential"
    },
    "path": {
      "type": "string",
      "description": "The path inside the invocation image for mounting credentials"
    },
    "required": {
      "type": "boolean",
      "description": "Indicates whether this credential must be supplied",
      "default": false
    },
    "applyTo": {
      "type": "array",
      "description": "An optional list of actions handling this credential",
      "items": {
        "type": "string"
      }
    }
  }
}