Skip to main content

ui:options Examples

EntityPicker​

The input props that can be specified under ui:options for the EntityPicker field extension.

allowArbitraryValues​

Whether to allow arbitrary user input. Defaults to true.

allowArbitraryValues provides input validation when selecting an entity as the values you enter will correspond to a valid entity.

  • Adding a valid entity with allowArbitraryValues as false
entity:
  title: Entity
  type: string
  description: Entity of the component
  ui:field: EntityPicker
  ui:options:
    allowArbitraryValues: false
  • Adding an arbitrary entity with allowArbitraryValues as true (default value)
entity:
  title: Entity
  type: string
  description: Entity of the component
  ui:field: EntityPicker
  ui:options:
    allowArbitraryValues: true

allowedKinds​

DEPRECATED: Use catalogFilter instead.

catalogFilter​

catalogFilter supports filtering options by any field(s) of an entity.

  • Get all entities of kind Group
entity:
  title: Entity
  type: string
  description: Entity of the component
  ui:field: EntityPicker
  ui:options:
    catalogFilter:
      - kind: Group
  • Get entities of kind Group and spec.type team
entity:
  title: Entity
  type: string
  description: Entity of the component
  ui:field: EntityPicker
  ui:options:
    catalogFilter:
      - kind: Group
        spec.type: team

For the full details on the spec.* values see here.

defaultKind​

The default entity kind.

system:
  title: System
  type: string
  description: System of the component
  ui:field: EntityPicker
  ui:options:
    catalogFilter:
      kind: System
    defaultKind: System

defaultNamespace​

The ID of a namespace that the entity belongs to. The default value is default.

  • Listing all entities in the default namespace (default value)
entity:
  title: Entity
  type: string
  description: Entity of the component
  ui:field: EntityPicker
  ui:options:
    defaultNamespace: default
  • Listing all entities in the payment namespace
entity:
  title: Entity
  type: string
  description: Entity of the component
  ui:field: EntityPicker
  ui:options:
    defaultNamespace: payment

MultiEntityPicker​

The input props that can be specified under ui:options for the MultiEntityPicker field extension.

allowArbitraryValues​

Whether to allow arbitrary user input. Defaults to true.

allowArbitraryValues provides input validation when selecting an entity as the values you enter will correspond to a valid entity.

  • Adding a valid entity with allowArbitraryValues as false
entity:
  title: Entities
  type: array
  description: Entities of the component
  ui:field: MultiEntityPicker
  ui:options:
    allowArbitraryValues: false
  • Adding an arbitrary entity with allowArbitraryValues as true (default value)
entity:
  title: Entities
  type: array
  description: Entities of the component
  ui:field: MultiEntityPicker
  ui:options:
    allowArbitraryValues: true

catalogFilter​

catalogFilter supports filtering options by any field(s) of an entity.

  • Get all entities of kind Group
entity:
  title: Entities
  type: array
  description: Entities of the component
  ui:field: MultiEntityPicker
  ui:options:
    catalogFilter:
      - kind: Group
  • Get entities of kind Group and spec.type team
entity:
  title: Entities
  type: array
  description: Entities of the component
  ui:field: MultiEntityPicker
  ui:options:
    catalogFilter:
      - kind: Group
        spec.type: team

For the full details on the spec.* values see here.

defaultKind​

The default entity kind.

system:
  title: System
  type: array
  description: Systems of the component
  ui:field: MultiEntityPicker
  ui:options:
    catalogFilter:
      kind: System
    defaultKind: System

defaultNamespace​

The ID of a namespace that the entity belongs to. The default value is default.

  • Listing all entities in the default namespace (default value)
entity:
  title: Entity
  type: array
  description: Entities of the component
  ui:field: MultiEntityPicker
  ui:options:
    defaultNamespace: default
  • Listing all entities in the payment namespace
entity:
  title: Entity
  type: array
  description: Entities of the component
  ui:field: MultiEntityPicker
  ui:options:
    defaultNamespace: payment

OwnerPicker​

The input props that can be specified under ui:options for the OwnerPicker field extension.

allowArbitraryValues​

Whether to allow arbitrary user input. Defaults to true.

allowArbitraryValues provides input validation when selecting an owner as the values you enter will correspond to a valid owner.

  • Adding a valid owner with allowArbitraryValues as false
owner:
  title: Owner
  type: string
  description: Owner of the component
  ui:field: OwnerPicker
  ui:options:
    allowArbitraryValues: false
  • Adding an arbitrary owner with allowArbitraryValues as true (default value)
owner:
  title: Owner
  type: string
  description: Owner of the component
  ui:field: OwnerPicker
  ui:options:
    allowArbitraryValues: true

allowedKinds​

DEPRECATED: Use catalogFilter instead.

catalogFilter​

catalogFilter supports filtering options by any field(s) of an entity.

  • Get all entities of kind Group
owner:
  title: Owner
  type: string
  description: Owner of the component
  ui:field: OwnerPicker
  ui:options:
    catalogFilter:
      - kind: Group
  • Get entities of kind Group and spec.type team
owner:
  title: Owner
  type: string
  description: Owner of the component
  ui:field: OwnerPicker
  ui:options:
    catalogFilter:
      - kind: Group
        spec.type: team

For the full details on the spec.* values see here.

defaultNamespace​

The ID of a namespace that the owner belongs to. The default value is default.

  • Listing owners in the default namespace (default value)
owner:
  title: Owner
  type: string
  description: Owner of the component
  ui:field: OwnerPicker
  ui:options:
    catalogFilter:
      - kind: Group
    defaultNamespace: default
  • Listing owners in the payment namespace
owner:
  title: Owner
  type: string
  description: Owner of the component
  ui:field: OwnerPicker
  ui:options:
    catalogFilter:
      - kind: Group
    defaultNamespace: payment

RepoUrlPicker​

The input props that can be specified under ui:options for the RepoUrlPicker field extension.

allowedHosts​

The allowedHosts part should be set to where you wish to enable this template to publish to. And it can be any host that is listed in your integrations' config in app-config.yaml.

  • Publish only to repositories from github.com
repoUrl:
  title: Repository Location
  type: string
  ui:field: RepoUrlPicker
  ui:options:
    allowedHosts:
      - github.com

allowedOrganizations​

List of allowed organizations in the given SCM platform. You can restrict the template to publish to a set of organizations.

  • Publish only to repositories from organization my_organization
repoUrl:
  title: Repository Location
  type: string
  ui:field: RepoUrlPicker
  ui:options:
    allowedOrganizations:
      - my_organization

allowedProjects​

List of allowed projects in the given SCM platform. You can restrict the template to publish to a set of projects.

  • Publish only to repositories from project project_1
repoUrl:
  title: Repository Location
  type: string
  ui:field: RepoUrlPicker
  ui:options:
    allowedProjects:
      - project_1

allowedRepos​

List of allowed repos in the given SCM platform. You can restrict the template to publish to a set of repository names.

  • Publish to only repo_1 and repo_2 repositories
repoUrl:
  title: Repository Location
  type: string
  ui:field: RepoUrlPicker
  ui:options:
    allowedRepos:
      - repo_1
      - repo_2

allowedOwners​

List of allowed owners in the given SCM platform. You can restrict the template to publish to repositories owned by specific users/groups by setting the allowedOwners option.

  • Publish to only repositories from owner owner_1 and owner_2
repoUrl:
  title: Repository Location
  type: string
  ui:field: RepoUrlPicker
  ui:options:
    allowedOwners:
      - owner_1
      - owner_2

requestUserCredentials​

If defined will request user credentials to auth against the given SCM platform.

repoUrl:
  title: Repository Location
  type: string
  ui:field: RepoUrlPicker
  ui:options:
    requestUserCredentials:
      secretsKey: USER_OAUTH_TOKEN
      additionalScopes:
        github:
          - workflow:write

secretsKey is the key used within the template secrets context to store the credential and additionalScopes is any additional permission scopes to request.

The supported additionalScopes values are gerrit, github, gitlab, bitbucket, and azure.

RepoBranchPicker​

The input props that can be specified under ui:options for the RepoBranchPicker field extension.

requestUserCredentials​

If defined will request user credentials to auth against the given SCM platform.

repoUrl:
  title: Repository Branch
  type: string
  ui:field: RepoBranchPicker
  ui:options:
    requestUserCredentials:
      secretsKey: USER_OAUTH_TOKEN
      additionalScopes:
        github:
          - workflow:write

secretsKey is the key used within the template secrets context to store the credential and additionalScopes is any additional permission scopes to request.

The supported additionalScopes values are gerrit, github, gitlab, bitbucket, and azure.

If you're also using the RepoUrlPicker field extension, you should simply duplicate this part from there.