import * as openapi_fetch from 'openapi-fetch'; import { Client } from 'openapi-fetch'; // Copyright (C) ConfigHub, Inc. // SPDX-License-Identifier: MIT /** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ interface paths { "/_component": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Bulk delete multiple components * @description Delete multiple components selected by query parameters */ delete: operations["BulkDeleteComponents"]; options?: never; head?: never; /** * Bulk patch multiple components * @description Apply JSON merge patch to multiple components selected by query parameters */ patch: operations["BulkPatchComponents"]; trace?: never; }; "/_service_account": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Bulk delete multiple service accounts * @description Delete multiple service accounts selected by query parameters */ delete: operations["BulkDeleteServiceAccounts"]; options?: never; head?: never; /** * Bulk patch multiple service accounts * @description Apply JSON merge patch to multiple service accounts selected by query parameters */ patch: operations["BulkPatchServiceAccounts"]; trace?: never; }; "/_space": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Bulk create (clone) multiple spaces * @description Clone multiple spaces selected by query parameters with optional name prefixes */ post: operations["BulkCreateSpaces"]; /** * Bulk delete multiple spaces * @description Delete multiple spaces selected by query parameters */ delete: operations["BulkDeleteSpaces"]; options?: never; head?: never; /** * Bulk patch multiple spaces * @description Apply JSON merge patch to multiple spaces selected by query parameters */ patch: operations["BulkPatchSpaces"]; trace?: never; }; "/attest": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Record Attestations across Spaces * @description Record an Attestation in each Space selected by WhereSpace, SpaceFilterID, ChangeOrderID and TargetStage, covering one Revision of each Unit WhereUnit selects there, named by Revision. When ChangeOrderID is given it defaults to the Revision a Release of the change would bundle, which the ChangeOrder's release Tag marks, or to the one its end Tag marks for a Unit the release Tag does not mark, so the approval satisfies its entry and release gates alike; it defaults to the head Revision otherwise. Each Space is recorded on its own and reported on its own. */ post: operations["Attest"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/attestation": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List of Attestations across spaces * @description Retrieves a list of Attestations across spaces in the Organization */ get: operations["ListAllAttestations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/attribute": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List of Attributes across spaces * @description Retrieves a list of Attributes across spaces in the Organization */ get: operations["ListAllAttributes"]; put?: never; /** * Bulk create (clone) multiple attributes * @description Clone multiple attributes selected by query parameters to destination spaces. A clone keeps the name of the Attribute it clones */ post: operations["BulkCreateAttributes"]; /** * Bulk delete multiple attributes * @description Delete multiple attributes selected by query parameters */ delete: operations["BulkDeleteAttributes"]; options?: never; head?: never; /** * Bulk patch multiple attributes * @description Apply JSON merge patch to multiple attributes selected by query parameters */ patch: operations["BulkPatchAttributes"]; trace?: never; }; "/attribute/move": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Move attributes to another space * @description Move the selected Attributes to another Space. The Space an Attribute leaves and the one it arrives in are refreshed if they selected it before or select it after, which recomputes their AttributeIDs and rebuilds their function executors. Requires Manage permission on each one moved and CreateChildren permission on the destination Space. Every check runs over the whole selection before anything is moved. */ post: operations["BulkMoveAttributes"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/change_order": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List of ChangeOrders across spaces * @description Retrieves a list of ChangeOrders across spaces in the Organization */ get: operations["ListAllChangeOrders"]; put?: never; /** * Bulk create (clone) multiple change orders * @description Clone multiple change orders selected by query parameters with optional name prefixes and destination spaces */ post: operations["BulkCreateChangeOrders"]; /** * Bulk delete multiple change orders * @description Delete multiple change orders selected by query parameters */ delete: operations["BulkDeleteChangeOrders"]; options?: never; head?: never; /** * Bulk patch multiple change orders * @description Apply JSON merge patch to multiple change orders selected by query parameters */ patch: operations["BulkPatchChangeOrders"]; trace?: never; }; "/change_order/refresh_stage": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Refresh the Stage of multiple change orders * @description Work out the ChangeOrder's Stage again from the Releases, live status, Attestations and validation results it depends on, for when one of them changed without the Stage being worked out, such as a Space taking the change by an upgrade or a resolve rather than a promotion. Requires Use permission on the ChangeOrder. Each ChangeOrder selected by query parameters is refreshed on its own. */ post: operations["BulkRefreshChangeOrderStages"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/change_set": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List of ChangeSets across spaces * @description Retrieves a list of ChangeSets across spaces in the Organization */ get: operations["ListAllChangeSets"]; put?: never; /** * Bulk create (clone) multiple change sets * @description Clone multiple change sets selected by query parameters with optional name prefixes and destination spaces */ post: operations["BulkCreateChangeSets"]; /** * Bulk delete multiple change sets * @description Delete multiple change sets selected by query parameters */ delete: operations["BulkDeleteChangeSets"]; options?: never; head?: never; /** * Bulk patch multiple change sets * @description Apply JSON merge patch to multiple change sets selected by query parameters */ patch: operations["BulkPatchChangeSets"]; trace?: never; }; "/change_set/move": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Move change sets to another space * @description Move the selected ChangeSets, with their start and end Tags, to another Space. The Revisions and Units in a ChangeSet stay where they are. Requires Manage permission on each one moved and CreateChildren permission on the destination Space. Every check runs over the whole selection before anything is moved. */ post: operations["BulkMoveChangeSets"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/change_workflow": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List of ChangeWorkflows across spaces * @description Retrieves a list of ChangeWorkflows across spaces in the Organization */ get: operations["ListAllChangeWorkflows"]; put?: never; /** * Bulk create (clone) multiple change workflows * @description Clone multiple change workflows selected by query parameters with optional name prefixes and destination spaces */ post: operations["BulkCreateChangeWorkflows"]; /** * Bulk delete multiple change workflows * @description Delete multiple change workflows selected by query parameters */ delete: operations["BulkDeleteChangeWorkflows"]; options?: never; head?: never; /** * Bulk patch multiple change workflows * @description Apply JSON merge patch to multiple change workflows selected by query parameters */ patch: operations["BulkPatchChangeWorkflows"]; trace?: never; }; "/change_workflow/move": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Move change workflows to another space * @description Move the selected ChangeWorkflows to another Space. ChangeOrders that use one refer to it by ID. Requires Manage permission on each one moved and CreateChildren permission on the destination Space. Every check runs over the whole selection before anything is moved. */ post: operations["BulkMoveChangeWorkflows"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/channel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List of Channels across spaces * @description Retrieves a list of Channels across spaces in the Organization */ get: operations["ListAllChannels"]; put?: never; /** * Bulk create (clone) multiple channels * @description Clone multiple channels selected by query parameters with optional name prefixes and destination spaces */ post: operations["BulkCreateChannels"]; /** * Bulk delete multiple channels * @description Delete multiple channels selected by query parameters */ delete: operations["BulkDeleteChannels"]; options?: never; head?: never; /** * Bulk patch multiple channels * @description Apply JSON merge patch to multiple channels selected by query parameters */ patch: operations["BulkPatchChannels"]; trace?: never; }; "/channel/move": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Move channels to another space * @description Move the selected Channels, with their command runs, to another Space. A Channel a client holds the lease of is not moved: its polls name the Space it is in. Requires Manage permission on each one moved and CreateChildren permission on the destination Space. Every check runs over the whole selection before anything is moved. */ post: operations["BulkMoveChannels"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/command": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List the commands declared across the Organization */ get: operations["ListAllCommands"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/command_run": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List command runs across the Organization */ get: operations["ListAllCommandRuns"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/component": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List Components * @description List Components */ get: operations["ListComponents"]; put?: never; /** * Create Component * @description Create Component */ post: operations["CreateComponent"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/component/{component_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Component * @description Get Component */ get: operations["GetComponent"]; /** * Update Component * @description Update Component */ put: operations["UpdateComponent"]; post?: never; /** * Delete Component * @description Delete Component */ delete: operations["DeleteComponent"]; options?: never; head?: never; /** * Patch Component * @description Patch Component */ patch: operations["PatchComponent"]; trace?: never; }; "/component/{component_id}/document": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the document of a Component to edit * @description Returns the Component as the document its backing Unit would hold: the fields a write can set, with the entities it refers to named rather than identified by ID, and its Version. */ get: operations["GetComponentDocument"]; put?: never; /** * Update a Component from an edit of its document * @description Applies the change from Base, the document as read, to Document, as edited, as a patch of the Component: a field the edit leaves alone keeps what the Component holds, and a field it removes is cleared. A Version other than the Component's is a conflict. */ post: operations["UpdateComponentDocument"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/demote": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Undo an aborted ChangeOrder in the Spaces it reached * @description Restores each Unit the ChangeOrder's start Tag marks to the Revision it was at before the change, in every Space the ChangeOrder reached, or those WhereSpace, SpaceFilterID and TargetStage select. The ChangeOrder must have an AbortedReason. A Unit already restored is passed over, and a Unit the ChangeOrder carried nothing for is marked without a Revision being made. Revisions made after the change that restoring drops are reported. Demoting again changes nothing. */ post: operations["Demote"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/diff": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Get the difference between two configurations * @description Returns what changed from one configuration to another, path by path with the values on both sides. Each side is a Unit, at a Revision or its head, or configuration given inline, such as a local file or an unsaved edit. The two sides may be Units in different Spaces, and must be of one toolchain. It changes nothing; it is a POST because inline configuration does not fit in a query string. */ post: operations["DiffConfigurations"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/filter": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List of Filters across spaces * @description Retrieves a list of Filters across spaces in the Organization */ get: operations["ListAllFilters"]; put?: never; /** * Bulk create (clone) multiple filters * @description Clone multiple filters selected by query parameters with optional name prefixes and destination spaces */ post: operations["BulkCreateFilters"]; /** * Bulk delete multiple filters * @description Delete multiple filters selected by query parameters */ delete: operations["BulkDeleteFilters"]; options?: never; head?: never; /** * Bulk patch multiple filters * @description Apply JSON merge patch to multiple filters selected by query parameters */ patch: operations["BulkPatchFilters"]; trace?: never; }; "/filter/move": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Move filters to another space * @description Move the selected Filters to another Space. Spaces, Views and Triggers that use a Filter refer to it by ID, and keep using it. Requires Manage permission on each one moved and CreateChildren permission on the destination Space. Every check runs over the whole selection before anything is moved. */ post: operations["BulkMoveFilters"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/function": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List retrieves a map of Functions across the Organization * @description List retrieves a map of Functions across the Organization */ get: operations["ListOrgFunctions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/function/invoke": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Invoke Functions across Org * @description Invoke Functions across Units in the Organization */ post: operations["InvokeFunctionsOnOrg"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/group": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List Groups * @description List Groups */ get: operations["ListGroups"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/group/{group_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Group * @description Get Group */ get: operations["GetGroup"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/group/{group_id}/user/{user_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Add a bot User to a Group * @description Add the User of a ServiceAccount in the caller's Organization to the Group. Other Users' Group memberships are managed in the identity provider. An organization admin or manager may. So may a member of the Group who has Manage permission on the bot User's ServiceAccount. Adding a bot that is already a member does nothing. Returns the bot User with its GroupIDs. */ post: operations["AddGroupBotUser"]; /** * Remove a bot User from a Group * @description Remove the User of a ServiceAccount in the caller's Organization from the Group. An organization admin or manager may. So may a member of the Group who has Manage permission on the bot User's ServiceAccount. Removing a bot that is not a member does nothing. Returns the bot User with its GroupIDs. */ delete: operations["RemoveGroupBotUser"]; options?: never; head?: never; patch?: never; trace?: never; }; "/info": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get info about this api server * @description Get info about this api server */ get: operations["apiInfo"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/invocation": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List of Invocations across spaces * @description Retrieves a list of Invocations across spaces in the Organization */ get: operations["ListAllInvocations"]; put?: never; /** * Bulk create (clone) multiple invocations * @description Clone multiple invocations selected by query parameters with optional name prefixes and destination spaces */ post: operations["BulkCreateInvocations"]; /** * Bulk delete multiple invocations * @description Delete multiple invocations selected by query parameters */ delete: operations["BulkDeleteInvocations"]; options?: never; head?: never; /** * Bulk patch multiple invocations * @description Apply JSON merge patch to multiple invocations selected by query parameters */ patch: operations["BulkPatchInvocations"]; trace?: never; }; "/invocation/move": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Move invocations to another space * @description Move the selected Invocations to another Space. An Invocation's built-in functions run on its Space's executor, so a move to a Space with different Attributes re-validates them there, and is refused while a Trigger runs the Invocation. Requires Manage permission on each one moved and CreateChildren permission on the destination Space. Every check runs over the whole selection before anything is moved. */ post: operations["BulkMoveInvocations"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/link": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List of Links across spaces * @description Retrieves a list of Links across spaces in the Organization */ get: operations["SearchListLinks"]; put?: never; /** * Bulk create (copy) multiple links * @description Copy existing links with retargeted From and/or To units. Select source links via where/filter, then retarget using reverse, from_downstream_where (optionally with to_downstream_where), or where_space/filter_space parameters. With from_refs, create the NeedsProvides links the configuration of the Kubernetes/YAML units where_unit and filter_unit select calls for instead; with from_backing_units, create links from the ConfigHub/YAML units they select. */ post: operations["BulkCreateLinks"]; /** * Bulk delete multiple links * @description Delete multiple links selected by query parameters */ delete: operations["BulkDeleteLinks"]; options?: never; head?: never; /** * Bulk patch multiple links * @description Apply JSON merge patch to multiple links selected by query parameters */ patch: operations["BulkPatchLinks"]; trace?: never; }; "/me": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the current user's information * @description Get the current user's information */ get: operations["GetMe"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/me/browser-session": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create a single-use link that signs a browser in as the current user * @description Returns a short-lived, single-use URL. Opening it exchanges the ticket for a session cookie. Intended for instances with no identity provider, where the browser has no other way to authenticate. */ post: operations["CreateBrowserSession"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/oauth_client": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List OAuth clients * @description List the OAuth clients owned by the caller's organization. */ get: operations["ListOAuthClients"]; put?: never; /** * Register an OAuth client * @description Register a per-app OAuth public client for the caller's organization (RFC 7591). */ post: operations["CreateOAuthClient"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/oauth_client/{oauth_client}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get an OAuth client * @description Get a single OAuth client owned by the caller's organization. */ get: operations["GetOAuthClient"]; put?: never; post?: never; /** * Delete an OAuth client * @description Delete an OAuth client owned by the caller's organization. */ delete: operations["DeleteOAuthClient"]; options?: never; head?: never; patch?: never; trace?: never; }; "/organization": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List Organizations * @description List Organizations */ get: operations["ListOrganizations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/organization/{organization_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Organization * @description Get Organization */ get: operations["GetOrganization"]; /** * Update Organization * @description Update Organization */ put: operations["UpdateOrganization"]; post?: never; delete?: never; options?: never; head?: never; /** * Patch Organization * @description Patch Organization */ patch: operations["PatchOrganization"]; trace?: never; }; "/organization/{organization_id}/organization_member": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List OrganizationMembers * @description List OrganizationMembers */ get: operations["ListOrganizationMembers"]; put?: never; /** * Create OrganizationMember * @description Create OrganizationMember */ post: operations["CreateOrganizationMember"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/organization/{organization_id}/organization_member/{organization_member_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get OrganizationMember * @description Get OrganizationMember */ get: operations["GetOrganizationMember"]; put?: never; post?: never; /** * Delete OrganizationMember * @description Delete OrganizationMember */ delete: operations["DeleteOrganizationMember"]; options?: never; head?: never; patch?: never; trace?: never; }; "/promote": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Promote changes into downstream variants * @description Moves changes from upstream Spaces into the downstream variants selected by WhereSpace, SpaceFilterID, ChangeOrderID and TargetStage, and makes them match: Units are upgraded, emptied, revived and cloned, clones are placed in the variant's namespace, and their Links are copied. With a ChangeOrder only its range is promoted, and with a ChangeWorkflow the Stage's entry gates are enforced. Promoting again changes nothing. */ post: operations["Promote"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/release": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List of Releases across spaces * @description Retrieves a list of Releases across spaces in the Organization. By default, returns at most one Release per space: the highest-numbered one that matches. Set `distinct_on=Off` to receive every matching Release instead -- paginate with `limit` and the continue token to walk the full result set (`distinct_on=Off` requires an explicit `limit` and a non-empty `where` or `filter`, since without deduplication or a filter there is nothing bounding the result set) */ get: operations["ListAllReleases"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/resource": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List of Resources across spaces * @description Retrieves a list of Resources of Units across spaces in the Organization */ get: operations["ListAllResources"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/review_comment": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List of ReviewComments across spaces * @description Retrieves a list of ReviewComments across spaces in the Organization */ get: operations["ListAllReviewComments"]; put?: never; post?: never; /** * Bulk delete multiple review comments * @description Delete multiple review comments selected by query parameters, among those the caller made or whose space the caller manages */ delete: operations["BulkDeleteReviewComments"]; options?: never; head?: never; /** * Bulk patch multiple review comments * @description Apply JSON merge patch to multiple review comments selected by query parameters. Only Text can change, and only on comments the caller made or whose space the caller manages. */ patch: operations["BulkPatchReviewComments"]; trace?: never; }; "/revision": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List of Revisions across spaces * @description Retrieves a list of Revisions across spaces in the Organization. By default, returns at most one revision per unit (the most recent). Set `distinct_on=Off` to receive every matching revision instead, undeduped -- paginate with `limit`/`offset` to walk the full result set (`distinct_on=Off` requires an explicit `limit` and a non-empty `where` or `filter`, since without deduplication or a filter there is nothing bounding the result set) */ get: operations["ListAllRevisions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/revision_data": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the config data of many Revisions across spaces * @description Returns the configuration of every Revision the where clause selects, across every Space in the organization, in one request, with each Revision's DataHash and DataSize. This is what a diff over many Units needs: fetching each Revision separately would be two requests per Unit. */ get: operations["SearchRevisionData"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/revision_mutation_sources": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the mutation sources of many Revisions across spaces * @description Returns what set each value in the configuration of every Revision the where clause selects, across every Space in the organization, in one request. The bulk counterpart of the per-Revision mutation-sources subresource. */ get: operations["SearchRevisionMutationSources"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/service_account": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List ServiceAccounts * @description List ServiceAccounts */ get: operations["ListServiceAccounts"]; put?: never; /** * Create ServiceAccount * @description Create ServiceAccount */ post: operations["CreateServiceAccount"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/service_account/{service_account_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get ServiceAccount * @description Get ServiceAccount */ get: operations["GetServiceAccount"]; /** * Update ServiceAccount * @description Update ServiceAccount */ put: operations["UpdateServiceAccount"]; post?: never; /** * Delete ServiceAccount * @description Delete ServiceAccount */ delete: operations["DeleteServiceAccount"]; options?: never; head?: never; /** * Patch ServiceAccount * @description Patch ServiceAccount */ patch: operations["PatchServiceAccount"]; trace?: never; }; "/service_account/{service_account_id}/user_key": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List a service account's public keys * @description List the public keys registered for a service account. Keys are returned unredacted, deliberately: they are public material, and an operator noticing a key nobody registered is how an injected one is caught. Requires View permission on the service account. */ get: operations["ListServiceAccountUserKeys"]; put?: never; /** * Register a public key for a service account * @description Register a public key for a service account. The holder of the matching private key then authenticates as the service account by signing a short-lived assertion (RFC 7523 private_key_jwt), so no secret is exchanged and none is stored. Requires Impersonate permission on the service account, which Manage does not include; a service account cannot register a key for itself. */ post: operations["CreateServiceAccountUserKey"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/service_account/{service_account_id}/user_key/{user_key_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a service account's public key * @description Get one of the public keys registered for a service account, unredacted. Requires View permission on the service account. */ get: operations["GetServiceAccountUserKey"]; put?: never; post?: never; /** * Remove a public key from a service account * @description Remove one of a service account's public keys. This is the second half of rotation, and the response to a compromised private key. Requires Impersonate permission on the service account. */ delete: operations["DeleteServiceAccountUserKey"]; options?: never; head?: never; patch?: never; trace?: never; }; "/service_account/{service_account_id}/user_token": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List a service account's long-lived tokens * @description List the long-lived tokens issued to a service account, revoked ones included. The tokens themselves are not returned; each entry carries the jti, who issued it, when it was last used, and whether it has been revoked. Requires View permission on the service account. */ get: operations["ListServiceAccountUserTokens"]; put?: never; /** * Issue a long-lived token for a service account * @description Issue a token with no expiry (or the given ExpiresAt) that authenticates as the service account, for consumers that can hold only a static credential, such as a registry Secret. The token is returned once and never stored; its record can be revoked or deleted. Requires Impersonate permission on the service account, which Manage does not include; a service account cannot issue a token for itself. */ post: operations["CreateServiceAccountUserToken"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/service_account/{service_account_id}/user_token/{user_token_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a service account's long-lived token * @description Get the record of one long-lived token issued to a service account. The token itself is not returned. Requires View permission on the service account. */ get: operations["GetServiceAccountUserToken"]; put?: never; post?: never; /** * Delete a service account's long-lived token * @description Delete one token's record. A token that is still live stops working within a minute on every server, as a revoked one does, and is refused afterwards as unknown. Revoke instead to keep the record. Requires Impersonate permission on the service account. */ delete: operations["DeleteServiceAccountUserToken"]; options?: never; head?: never; patch?: never; trace?: never; }; "/service_account/{service_account_id}/user_token/{user_token_id}/revoke": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Revoke a service account's long-lived token * @description Revoke one token. The token stops working within a minute on every server; the record stays, marked revoked, and is returned. Revoking a revoked token is not an error. Requires Impersonate permission on the service account. */ post: operations["RevokeServiceAccountUserToken"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List Spaces * @description List Spaces */ get: operations["ListSpaces"]; put?: never; /** * Create Space * @description Create Space */ post: operations["CreateSpace"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Space * @description Get Space */ get: operations["GetSpace"]; /** * Update Space * @description Update Space */ put: operations["UpdateSpace"]; post?: never; /** * Delete Space * @description Delete Space */ delete: operations["DeleteSpace"]; options?: never; head?: never; /** * Patch Space * @description Patch Space */ patch: operations["PatchSpace"]; trace?: never; }; "/space/{space_id}/attestation": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List ExtendedAttestations * @description List ExtendedAttestations */ get: operations["ListExtendedAttestations"]; put?: never; /** * Record an Attestation * @description Record an Attestation in the Space, covering one Revision of each Unit WhereUnit selects, named by Revision. Units with no such Revision are reported as skipped. When nothing is covered, nothing is recorded. With RevokedAttestationID, withdraw an earlier Attestation instead; a revocation covers no Revisions of its own. Requires Approve permission on the Space. */ post: operations["CreateAttestation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/attestation/{attestation_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get ExtendedAttestation * @description Get ExtendedAttestation */ get: operations["GetExtendedAttestation"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/attribute": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List Attributes * @description List Attributes */ get: operations["ListAttributes"]; put?: never; /** * Create Attribute * @description Create Attribute */ post: operations["CreateAttribute"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/attribute/{attribute_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Attribute * @description Get Attribute */ get: operations["GetAttribute"]; /** * Update Attribute * @description Update Attribute */ put: operations["UpdateAttribute"]; post?: never; /** * Delete Attribute * @description Delete Attribute */ delete: operations["DeleteAttribute"]; options?: never; head?: never; /** * Patch Attribute * @description Patch Attribute */ patch: operations["PatchAttribute"]; trace?: never; }; "/space/{space_id}/attribute/{attribute_id}/document": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the document of a Attribute to edit * @description Returns the Attribute as the document its backing Unit would hold: the fields a write can set, with the entities it refers to named rather than identified by ID, and its Version. */ get: operations["GetAttributeDocument"]; put?: never; /** * Update a Attribute from an edit of its document * @description Applies the change from Base, the document as read, to Document, as edited, as a patch of the Attribute: a field the edit leaves alone keeps what the Attribute holds, and a field it removes is cleared. A Version other than the Attribute's is a conflict. */ post: operations["UpdateAttributeDocument"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/change_order": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List ChangeOrders * @description List ChangeOrders */ get: operations["ListChangeOrders"]; put?: never; /** * Create ChangeOrder * @description Create ChangeOrder */ post: operations["CreateChangeOrder"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/change_order/{change_order_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get ChangeOrder * @description Get ChangeOrder */ get: operations["GetChangeOrder"]; /** * Update ChangeOrder * @description Update ChangeOrder */ put: operations["UpdateChangeOrder"]; post?: never; /** * Delete ChangeOrder * @description Delete ChangeOrder */ delete: operations["DeleteChangeOrder"]; options?: never; head?: never; /** * Patch ChangeOrder * @description Patch ChangeOrder */ patch: operations["PatchChangeOrder"]; trace?: never; }; "/space/{space_id}/change_order/{change_order_id}/refresh_stage": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Refresh the selected ChangeOrder's Stage * @description Work out the ChangeOrder's Stage again from the Releases, live status, Attestations and validation results it depends on, for when one of them changed without the Stage being worked out, such as a Space taking the change by an upgrade or a resolve rather than a promotion. Requires Use permission on the ChangeOrder. */ post: operations["RefreshChangeOrderStage"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/change_set": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List ChangeSets * @description List ChangeSets */ get: operations["ListChangeSets"]; put?: never; /** * Create ChangeSet * @description Create ChangeSet */ post: operations["CreateChangeSet"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/change_set/{change_set_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get ChangeSet * @description Get ChangeSet */ get: operations["GetChangeSet"]; /** * Update ChangeSet * @description Update ChangeSet */ put: operations["UpdateChangeSet"]; post?: never; /** * Delete ChangeSet * @description Delete ChangeSet */ delete: operations["DeleteChangeSet"]; options?: never; head?: never; /** * Patch ChangeSet * @description Patch ChangeSet */ patch: operations["PatchChangeSet"]; trace?: never; }; "/space/{space_id}/change_workflow": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List ChangeWorkflows * @description List ChangeWorkflows */ get: operations["ListChangeWorkflows"]; put?: never; /** * Create ChangeWorkflow * @description Create ChangeWorkflow */ post: operations["CreateChangeWorkflow"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/change_workflow/{change_workflow_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get ChangeWorkflow * @description Get ChangeWorkflow */ get: operations["GetChangeWorkflow"]; /** * Update ChangeWorkflow * @description Update ChangeWorkflow */ put: operations["UpdateChangeWorkflow"]; post?: never; /** * Delete ChangeWorkflow * @description Delete ChangeWorkflow */ delete: operations["DeleteChangeWorkflow"]; options?: never; head?: never; /** * Patch ChangeWorkflow * @description Patch ChangeWorkflow */ patch: operations["PatchChangeWorkflow"]; trace?: never; }; "/space/{space_id}/change_workflow/{change_workflow_id}/document": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the document of a ChangeWorkflow to edit * @description Returns the ChangeWorkflow as the document its backing Unit would hold: the fields a write can set, with the entities it refers to named rather than identified by ID, and its Version. */ get: operations["GetChangeWorkflowDocument"]; put?: never; /** * Update a ChangeWorkflow from an edit of its document * @description Applies the change from Base, the document as read, to Document, as edited, as a patch of the ChangeWorkflow: a field the edit leaves alone keeps what the ChangeWorkflow holds, and a field it removes is cleared. A Version other than the ChangeWorkflow's is a conflict. */ post: operations["UpdateChangeWorkflowDocument"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/channel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List Channels * @description List Channels */ get: operations["ListChannels"]; put?: never; /** * Create Channel * @description Create Channel */ post: operations["CreateChannel"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/channel/{channel_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Channel * @description Get Channel */ get: operations["GetChannel"]; /** * Update Channel * @description Update Channel */ put: operations["UpdateChannel"]; post?: never; /** * Delete Channel * @description Delete Channel */ delete: operations["DeleteChannel"]; options?: never; head?: never; /** * Patch Channel * @description Patch Channel */ patch: operations["PatchChannel"]; trace?: never; }; "/space/{space_id}/channel/{channel_id}/command_run/{command_run_id}/result": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Report a command run's result * @description Reported by the Channel's client once it has executed the run: Completed with a Result, or Failed or Rejected with an ErrorMessage. A run already terminal is returned unchanged. */ post: operations["ReportCommandRunResult"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/channel/{channel_id}/document": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the document of a Channel to edit * @description Returns the Channel as the document its backing Unit would hold: the fields a write can set, with the entities it refers to named rather than identified by ID, and its Version. */ get: operations["GetChannelDocument"]; put?: never; /** * Update a Channel from an edit of its document * @description Applies the change from Base, the document as read, to Document, as edited, as a patch of the Channel: a field the edit leaves alone keeps what the Channel holds, and a field it removes is cleared. A Version other than the Channel's is a conflict. */ post: operations["UpdateChannelDocument"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/channel/{channel_id}/lease": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Acquire a Channel's lease * @description Takes the lease on the Channel, under which the client polls it, reports results and advances its bookmark. Takes Claim on the Channel. A lease held and fresh is 409; a stale one is taken over, and the runs it had been delivered return to Pending. */ post: operations["AcquireChannelLease"]; /** * Release a Channel's lease * @description Releases the lease the token names, returning its Delivered runs to Pending. Any other token is a no-op. */ delete: operations["ReleaseChannelLease"]; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/channel/{channel_id}/poll": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Poll a Channel * @description Under the lease, waits up to TimeoutSeconds for something to deliver: up to MaxRuns Pending runs, oldest first, and the events after the Channel's bookmark that match its subscriptions, which advances the bookmark. Each poll renews the lease. 204 when nothing arrived in time; 409 when the lease is not held by the token, after which the client acquires it again. */ post: operations["PollChannel"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/command": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List the commands runnable in the Space * @description The commands the Space's Channels declare, with each one's signature and the Channel that declares it. */ get: operations["ListCommands"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/command_run": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List the Space's command runs */ get: operations["ListCommandRuns"]; put?: never; /** * Run a command on a Channel * @description Creates a run of the command on a Channel of the Space: the one named by ChannelID, or else the one Channel in the Space that declares the command. Running a command takes Use on the Channel. The run is returned Pending; read it back with GET, with ?wait= to hold until it completes. A command that does not resolve to one Channel is refused with a CommandRunRefusal, whose Reason says why. */ post: operations["CreateCommandRun"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/command_run/{command_run_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a command run * @description Reads the run. With ?wait=, holds until the run reaches a terminal status or the wait elapses, at most 25 seconds; a caller that waits longer asks again. */ get: operations["GetCommandRun"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/command_run/{command_run_id}/cancel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Cancel a Pending command run * @description Marks a Pending run Canceled. A run that has been delivered cannot be canceled; it completes or times out. */ post: operations["CancelCommandRun"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/document": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the document of a Space to edit * @description Returns the Space as the document its backing Unit would hold: the fields a write can set, with the entities it refers to named rather than identified by ID, and its Version. */ get: operations["GetSpaceDocument"]; put?: never; /** * Update a Space from an edit of its document * @description Applies the change from Base, the document as read, to Document, as edited, as a patch of the Space: a field the edit leaves alone keeps what the Space holds, and a field it removes is cleared. A Version other than the Space's is a conflict. */ post: operations["UpdateSpaceDocument"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/filter": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List Filters * @description List Filters */ get: operations["ListFilters"]; put?: never; /** * Create Filter * @description Create Filter */ post: operations["CreateFilter"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/filter/{filter_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Filter * @description Get Filter */ get: operations["GetFilter"]; /** * Update Filter * @description Update Filter */ put: operations["UpdateFilter"]; post?: never; /** * Delete Filter * @description Delete Filter */ delete: operations["DeleteFilter"]; options?: never; head?: never; /** * Patch Filter * @description Patch Filter */ patch: operations["PatchFilter"]; trace?: never; }; "/space/{space_id}/filter/{filter_id}/document": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the document of a Filter to edit * @description Returns the Filter as the document its backing Unit would hold: the fields a write can set, with the entities it refers to named rather than identified by ID, and its Version. */ get: operations["GetFilterDocument"]; put?: never; /** * Update a Filter from an edit of its document * @description Applies the change from Base, the document as read, to Document, as edited, as a patch of the Filter: a field the edit leaves alone keeps what the Filter holds, and a field it removes is cleared. A Version other than the Filter's is a conflict. */ post: operations["UpdateFilterDocument"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/function": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List retrieves a map of Functions * @description List retrieves a map of Functions */ get: operations["ListFunctions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/function/invoke": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Invoke Functions * @description Invoke Functions */ post: operations["InvokeFunctions"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/invocation": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List Invocations * @description List Invocations */ get: operations["ListInvocations"]; put?: never; /** * Create Invocation * @description Create Invocation */ post: operations["CreateInvocation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/invocation/{invocation_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Invocation * @description Get Invocation */ get: operations["GetInvocation"]; /** * Update Invocation * @description Update Invocation */ put: operations["UpdateInvocation"]; post?: never; /** * Delete Invocation * @description Delete Invocation */ delete: operations["DeleteInvocation"]; options?: never; head?: never; /** * Patch Invocation * @description Patch Invocation */ patch: operations["PatchInvocation"]; trace?: never; }; "/space/{space_id}/invocation/{invocation_id}/document": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the document of a Invocation to edit * @description Returns the Invocation as the document its backing Unit would hold: the fields a write can set, with the entities it refers to named rather than identified by ID, and its Version. */ get: operations["GetInvocationDocument"]; put?: never; /** * Update a Invocation from an edit of its document * @description Applies the change from Base, the document as read, to Document, as edited, as a patch of the Invocation: a field the edit leaves alone keeps what the Invocation holds, and a field it removes is cleared. A Version other than the Invocation's is a conflict. */ post: operations["UpdateInvocationDocument"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/link": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List Links * @description List Links */ get: operations["ListLinks"]; put?: never; /** * Create Link * @description Create Link */ post: operations["CreateLink"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/link/{link_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Link * @description Get Link */ get: operations["GetLink"]; /** * Update Link * @description Update Link */ put: operations["UpdateLink"]; post?: never; /** * Delete Link * @description Delete Link */ delete: operations["DeleteLink"]; options?: never; head?: never; /** * Patch Link * @description Patch Link */ patch: operations["PatchLink"]; trace?: never; }; "/space/{space_id}/link/{link_id}/document": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the document of a Link to edit * @description Returns the Link as the document its backing Unit would hold: the fields a write can set, with the entities it refers to named rather than identified by ID, and its Version. */ get: operations["GetLinkDocument"]; put?: never; /** * Update a Link from an edit of its document * @description Applies the change from Base, the document as read, to Document, as edited, as a patch of the Link: a field the edit leaves alone keeps what the Link holds, and a field it removes is cleared. A Version other than the Link's is a conflict. */ post: operations["UpdateLinkDocument"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/release": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List ExtendedReleases * @description List ExtendedReleases */ get: operations["ListExtendedReleases"]; put?: never; /** * Publish a Release * @description Publish a Release for the consuming Target, bundling the Units/Revisions of the Space in the path. Optionally pins each Unit to a tagged Revision via TagID. When the bundle is identical to the Space's latest published Release, no Release is created: the response carries that latest Release and a Message saying so. */ post: operations["PublishRelease"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/release/{release_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get ExtendedRelease * @description Get ExtendedRelease */ get: operations["GetExtendedRelease"]; /** * Update the selected Release * @description Update the selected Release's Labels, Annotations, and DeleteGates. The bundled content of a Release is never updated, and neither are the read-only fields describing it: withdraw the Release to take it out of service, and publish a new one to change what is bundled or what the bundle is named. */ put: operations["UpdateRelease"]; post?: never; /** * Delete the selected Release * @description Delete the selected Release, removing it and its stored bundle. Deleting changes what is served to the cluster behind the release Target, so it requires TargetEditChildren on the Release's Space as well as Edit on the Release. */ delete: operations["DeleteRelease"]; options?: never; head?: never; /** * Patch the selected Release * @description Apply a JSON merge patch to the selected Release's Labels, Annotations, and DeleteGates. Patching is how a Label, Annotation, or DeleteGate is removed: send null for its key. The read-only fields of a Release, including the bundled content, the name it is stored under, and the Published flag, cannot be patched. */ patch: operations["PatchRelease"]; trace?: never; }; "/space/{space_id}/release/{release_id}/data": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Download the selected Release's bundle * @description Download the gzip tarball a Release published. The bundle is not part of the Release entity -- a list of Releases should not carry a copy of every tarball -- and the response carries the Digest as an ETag. */ get: operations["DownloadReleaseData"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/release/{release_id}/withdraw": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Withdraw the selected Release * @description Withdraw the selected Release, clearing its Published flag so it is no longer available for download. The Release itself is retained; delete it to remove it entirely. Withdrawing changes what is served to the cluster behind the release Target, so it requires TargetEditChildren on the Release's Space as well as Edit on the Release. */ post: operations["WithdrawRelease"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/tag": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List Tags * @description List Tags */ get: operations["ListTags"]; put?: never; /** * Create Tag * @description Create Tag */ post: operations["CreateTag"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/tag/{tag_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Tag * @description Get Tag */ get: operations["GetTag"]; /** * Update Tag * @description Update Tag */ put: operations["UpdateTag"]; post?: never; /** * Delete Tag * @description Delete Tag */ delete: operations["DeleteTag"]; options?: never; head?: never; /** * Patch Tag * @description Patch Tag */ patch: operations["PatchTag"]; trace?: never; }; "/space/{space_id}/target": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List Targets * @description List Targets */ get: operations["ListTargets"]; put?: never; /** * Create Target * @description Create Target */ post: operations["CreateTarget"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/target/{target_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Target * @description Get Target */ get: operations["GetTarget"]; /** * Update Target * @description Update Target */ put: operations["UpdateTarget"]; post?: never; /** * Delete Target * @description Delete Target */ delete: operations["DeleteTarget"]; options?: never; head?: never; /** * Patch Target * @description Patch Target */ patch: operations["PatchTarget"]; trace?: never; }; "/space/{space_id}/target/{target_id}/document": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the document of a Target to edit * @description Returns the Target as the document its backing Unit would hold: the fields a write can set, with the entities it refers to named rather than identified by ID, and its Version. */ get: operations["GetTargetDocument"]; put?: never; /** * Update a Target from an edit of its document * @description Applies the change from Base, the document as read, to Document, as edited, as a patch of the Target: a field the edit leaves alone keeps what the Target holds, and a field it removes is cleared. A Version other than the Target's is a conflict. */ post: operations["UpdateTargetDocument"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/trigger": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List Triggers * @description List Triggers */ get: operations["ListTriggers"]; put?: never; /** * Create Trigger * @description Create Trigger */ post: operations["CreateTrigger"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/trigger/{trigger_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Trigger * @description Get Trigger */ get: operations["GetTrigger"]; /** * Update Trigger * @description Update Trigger */ put: operations["UpdateTrigger"]; post?: never; /** * Delete Trigger * @description Delete Trigger */ delete: operations["DeleteTrigger"]; options?: never; head?: never; /** * Patch Trigger * @description Patch Trigger */ patch: operations["PatchTrigger"]; trace?: never; }; "/space/{space_id}/trigger/{trigger_id}/document": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the document of a Trigger to edit * @description Returns the Trigger as the document its backing Unit would hold: the fields a write can set, with the entities it refers to named rather than identified by ID, and its Version. */ get: operations["GetTriggerDocument"]; put?: never; /** * Update a Trigger from an edit of its document * @description Applies the change from Base, the document as read, to Document, as edited, as a patch of the Trigger: a field the edit leaves alone keeps what the Trigger holds, and a field it removes is cleared. A Version other than the Trigger's is a conflict. */ post: operations["UpdateTriggerDocument"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/unit": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List Units * @description List Units */ get: operations["ListUnits"]; put?: never; /** * Create Unit * @description Create Unit */ post: operations["CreateUnit"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/unit/{unit_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Unit * @description Get Unit */ get: operations["GetUnit"]; /** * Update Unit * @description Update Unit */ put: operations["UpdateUnit"]; post?: never; /** * Delete Unit * @description Delete Unit */ delete: operations["DeleteUnit"]; options?: never; head?: never; /** * Patch Unit * @description Patch Unit */ patch: operations["PatchUnit"]; trace?: never; }; "/space/{space_id}/unit/{unit_id}/blame": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get what set each field of a Unit * @description Returns, for every field of a Unit's configuration, what set the value that is there -- the change, who made it, when and why -- following each merge and Link resolve upstream to where the value was set, and everything else recorded about the field: whether it is protected or guarded, the conflicts and Link findings about it, the failed validation checks that name it, and whether a NeedsProvides Link needs or provides it. A field the Unit does not have is listed, with Absent, when a conflict names it. */ get: operations["GetUnitBlame"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/unit/{unit_id}/conflicts": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Apply or dismiss a unit's outstanding merge conflicts * @description Act on the parts of the last merge's patch that were not applied. Apply replays the withheld change with every path eligible; Dismiss drops it without changing the configuration data. Either way the selected conflicts leave the Unit's outstanding set. Requires Edit permission. */ post: operations["ResolveUnitConflicts"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/unit/{unit_id}/data": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Download config data * @description Download the config data of a unit. The response carries the DataHash as an ETag; send it back as If-None-Match to get a 304 when the configuration has not changed. */ get: operations["DownloadUnitData"]; /** * Upload config data * @description Replace the config data of a unit. The request body is the configuration itself. This is the only way configuration reaches a Unit other than a clone, which copies it server-side: Data is not part of the Unit entity, so no metadata write can carry one or destroy one. Send If-Match with the DataHash a read served to make the write conditional on the configuration still being that one. Requires Edit permission. */ put: operations["UploadUnitData"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/unit/{unit_id}/diff": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the difference between two Revisions of a Unit * @description Returns what changed in a Unit's configuration between two Revisions, path by path, with the values on both sides. Array elements are matched by merge key and resources across renames, as merges match them. from and to take the Revision selectors `unit update --restore` accepts; to defaults to HeadRevisionNum and from to the Revision before to, so a request with neither answers what the last change did. */ get: operations["GetUnitDiff"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/unit/{unit_id}/guard": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Set path guards on a unit * @description Set or remove guards on the unit's PathAnnotations. A guard names a reason a path's value is what it is, so a later operation can be required to know about that reason before overwriting it. An operation that is not cleared for the guards at a path does not write it, and reports what it withheld as a conflict; editing the guards at a path that already has some needs a clearance for them, and so does changing whether one is inherited. A guard set through Set stays with this unit; one set through SetInherited is copied to its clones and carried by merges to the units downstream. A guard may name a path or resource the unit does not have, since it is policy about the configuration rather than a statement about its current contents. Creates a new revision only if the guards actually change. Requires Edit permission. */ post: operations["SetUnitGuard"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/unit/{unit_id}/mutation": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List ExtendedMutations * @description List ExtendedMutations */ get: operations["ListExtendedMutations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/unit/{unit_id}/mutation/{mutation_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get ExtendedMutation * @description Get ExtendedMutation */ get: operations["GetExtendedMutation"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/unit/{unit_id}/mutation_sources": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get mutation sources * @description Read what set each value in a Unit's configuration, by resource and path. MutationSources is the largest column on the table -- larger than the configuration itself -- so it is a subresource rather than a field. */ get: operations["GetUnitMutationSources"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/unit/{unit_id}/path": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get everything recorded about one field of a Unit * @description Returns everything recorded about one field of a Unit's configuration: the field as the Unit's blame reports it, its own annotations, whether the Unit's last Release includes its value, each change from this Unit out to where the value was set with the Mutation and Revision it was read from, the comments the configuration has about the field, and the latest thread of ReviewComments about it. With history, it also returns every change the Unit recorded to the field. A field that names nothing is a 404; one that names several fields, or a value holding several, is a 400 whose message lists them. */ get: operations["GetUnitPath"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/unit/{unit_id}/protection": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Set path protection on a unit (deprecated) * @deprecated * @description Deprecated: use POST /space/{space_id}/unit/{unit_id}/guard with the Override guard. A local override a merge must not overwrite is an Override guard, and this edits it: a path set protected gets the unit's Override guard -- Override=Upstream for a unit with an upstream unit, Override=External for one without -- and a path set unprotected loses its Override guard. The empty path is the resource as a whole. UnprotectAll removes every Override guard the unit has. The edit is cleared for Override guards only, so a path that carries another guard of its own is refused. Creates a new revision only if the guards actually change, and returns the unit's MutationSources, whose Protected values are no longer read. Requires Edit permission. */ post: operations["SetUnitProtection"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/unit/{unit_id}/resource": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List ExtendedResources * @description List ExtendedResources */ get: operations["ListExtendedResources"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/unit/{unit_id}/resource/{resource_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get ExtendedResource * @description Get ExtendedResource */ get: operations["GetExtendedResource"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/unit/{unit_id}/review_comment": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List ReviewComments * @description List ReviewComments */ get: operations["ListReviewComments"]; put?: never; /** * Create ReviewComment * @description Create ReviewComment */ post: operations["CreateReviewComment"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/unit/{unit_id}/review_comment/{review_comment_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get ReviewComment * @description Get ReviewComment */ get: operations["GetReviewComment"]; /** * Update ReviewComment * @description Update ReviewComment */ put: operations["UpdateReviewComment"]; post?: never; /** * Delete ReviewComment * @description Delete ReviewComment */ delete: operations["DeleteReviewComment"]; options?: never; head?: never; /** * Patch ReviewComment * @description Patch ReviewComment */ patch: operations["PatchReviewComment"]; trace?: never; }; "/space/{space_id}/unit/{unit_id}/revision": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List ExtendedRevisions * @description List ExtendedRevisions */ get: operations["ListExtendedRevisions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/unit/{unit_id}/revision/{revision_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get ExtendedRevision * @description Get ExtendedRevision */ get: operations["GetExtendedRevision"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/unit/{unit_id}/revision/{revision_id}/data": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Download the selected Revision's data * @description Download the selected Revision's data */ get: operations["DownloadRevisionData"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/unit/{unit_id}/revision/{revision_id}/mutation_sources": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the selected Revision's mutation sources * @description Read what set each value in the Revision's configuration, by resource and path. A Revision snapshots its MutationSources so a restore can rewind them with the data. */ get: operations["GetRevisionMutationSources"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/view": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List Views * @description List Views */ get: operations["ListViews"]; put?: never; /** * Create View * @description Create View */ post: operations["CreateView"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{space_id}/view/{view_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get View * @description Get View */ get: operations["GetView"]; /** * Update View * @description Update View */ put: operations["UpdateView"]; post?: never; /** * Delete View * @description Delete View */ delete: operations["DeleteView"]; options?: never; head?: never; /** * Patch View * @description Patch View */ patch: operations["PatchView"]; trace?: never; }; "/space/{space_id}/view/{view_id}/document": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the document of a View to edit * @description Returns the View as the document its backing Unit would hold: the fields a write can set, with the entities it refers to named rather than identified by ID, and its Version. */ get: operations["GetViewDocument"]; put?: never; /** * Update a View from an edit of its document * @description Applies the change from Base, the document as read, to Document, as edited, as a patch of the View: a field the edit leaves alone keeps what the View holds, and a field it removes is cleared. A Version other than the View's is a conflict. */ post: operations["UpdateViewDocument"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/tag": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List of Tags across spaces * @description Retrieves a list of Tags across spaces in the Organization */ get: operations["ListAllTags"]; put?: never; /** * Bulk create (clone) multiple tags * @description Clone multiple tags selected by query parameters with optional name prefixes and destination spaces */ post: operations["BulkCreateTags"]; /** * Bulk delete multiple tags * @description Delete multiple tags selected by query parameters */ delete: operations["BulkDeleteTags"]; options?: never; head?: never; /** * Bulk patch multiple tags * @description Apply JSON merge patch to multiple tags selected by query parameters */ patch: operations["BulkPatchTags"]; trace?: never; }; "/tag/move": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Move tags to another space * @description Move the selected Tags to another Space. The Revisions a Tag marks keep their marks. A Tag that a ChangeSet, ChangeOrder, or Release owns cannot be moved on its own. Requires Manage permission on each one moved and CreateChildren permission on the destination Space. Every check runs over the whole selection before anything is moved. */ post: operations["BulkMoveTags"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/target": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List of Targets across spaces * @description Retrieves a list of Targets across spaces in the Organization */ get: operations["ListAllTargets"]; put?: never; /** * Bulk create (clone) multiple targets * @description Clone multiple targets selected by query parameters with optional name prefixes and destination spaces. Each clone lists the Triggers its WhereTrigger and TriggerFilterID select. */ post: operations["BulkCreateTargets"]; /** * Bulk delete multiple targets * @description Delete multiple targets selected by query parameters */ delete: operations["BulkDeleteTargets"]; options?: never; head?: never; /** * Bulk patch multiple targets * @description Apply JSON merge patch to multiple targets selected by query parameters */ patch: operations["BulkPatchTargets"]; trace?: never; }; "/target/move": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Move targets to another space * @description Move the selected Targets to another Space. Units and Spaces that use a Target refer to it by ID, and its Releases stay in the Spaces that published them. Requires Manage permission on each one moved and CreateChildren permission on the destination Space. Every check runs over the whole selection before anything is moved. */ post: operations["BulkMoveTargets"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/trigger": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List of Triggers across spaces * @description Retrieves a list of Triggers across spaces in the Organization */ get: operations["ListAllTriggers"]; put?: never; /** * Bulk create (clone) multiple triggers * @description Clone multiple triggers selected by query parameters with optional name prefixes and destination spaces */ post: operations["BulkCreateTriggers"]; /** * Bulk delete multiple triggers * @description Delete multiple triggers selected by query parameters */ delete: operations["BulkDeleteTriggers"]; options?: never; head?: never; /** * Bulk patch multiple triggers * @description Apply JSON merge patch to multiple triggers selected by query parameters */ patch: operations["BulkPatchTriggers"]; trace?: never; }; "/trigger/move": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Move triggers to another space * @description Move the selected Triggers to another Space, with their backing Units. The Space a Trigger leaves and the one it arrives in have their Triggers refreshed, as deleting it from one and creating it in the other would. Other Spaces and Targets that select it keep invoking it until they are refreshed; each result lists those whose selection of it the move changes, as SelectionChanges, and a dry run does too. A Trigger that runs a built-in function itself cannot move to a Space whose Attributes differ. Requires Manage permission on each one moved and CreateChildren permission on the destination Space. Every check runs over the whole selection before anything is moved. */ post: operations["BulkMoveTriggers"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/unit": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List of Units across spaces * @description Retrieves a list of Units across spaces in the Organization */ get: operations["ListAllUnits"]; put?: never; /** * Bulk create (clone) multiple units * @description Clone multiple units selected by query parameters with optional name prefixes and destination spaces */ post: operations["BulkCreateUnits"]; /** * Bulk delete multiple units * @description Delete multiple units selected by query parameters */ delete: operations["BulkDeleteUnits"]; options?: never; head?: never; /** * Bulk patch multiple units * @description Apply JSON merge patch to multiple units selected by query parameters */ patch: operations["BulkPatchUnits"]; trace?: never; }; "/unit/move": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Move units to another space * @description Move the selected Units, and the Links from them, to another Space. Requires Manage permission on each Unit and CreateChildren permission on the destination Space. Every check runs over the whole selection before anything is moved. */ post: operations["BulkMoveUnits"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/unit/tag": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Bulk tag multiple units * @description Attach tags to specified unit revisions */ post: operations["BulkTagUnits"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/unit_blame": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get what set each field of many Units across spaces * @description Returns the blame of every Unit the where clause selects, across every Space in the organization, a page of Units at a time. This is the bulk counterpart of the single-Unit blame subresource. Scope it to one Space with a where clause for a variant, or to several for several variants: a field has the same REF in every variant of a Unit. A Unit whose blame cannot be read carries an Error and no fields. */ get: operations["SearchUnitBlame"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/unit_data": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the config data of many Units across spaces * @description Returns the configuration of every Unit the where clause selects, across every Space in the organization, in one request, with each Unit's DataHash and DataSize. This is the bulk counterpart of the single-Unit data endpoint; it exists as an endpoint of its own rather than as a mode on the Unit list so that no query parameter changes the shape of a response. Scope it to one Space with a where clause. */ get: operations["SearchUnitData"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/unit_diff": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the difference between two Revisions of many Units across spaces * @description Returns, for every Unit the where clause selects, across every Space in the organization, what changed in its configuration between the Revision from names and the Revision to names, path by path with the values on both sides. This is the bulk counterpart of the single-Unit diff subresource. from and to must each pick out a Revision in every Unit: HeadRevisionNum, LastReleasedRevisionNum, Tag:, ChangeSet:, ChangeOrder: or Release:, optionally prefixed with Before:. A Unit with no Revision a side names is absent on that side, and its diff runs against nothing. Scope it to one Space with a where clause. */ get: operations["SearchUnitDiff"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/unit_mutation_sources": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the mutation sources of many Units across spaces * @description Returns what set each value in the configuration of every Unit the where clause selects, across every Space in the organization, in one request. This is the bulk counterpart of the single-Unit mutation-sources subresource, and the Unit-level counterpart of /revision_mutation_sources, which cannot answer for a Unit's head because "each Unit's head Revision" is not expressible as a where clause over Revisions. Scope it to one Space with a where clause. */ get: operations["SearchUnitMutationSources"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/upload": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Upload a bundle of configuration * @description Takes a bundle of rendered configuration files, or pulls one from an OCI registry, splits it into resources, and makes a Space's Units, Links, and Invocations match it. Creates what is missing, 3-way merges what changed, and empties the Units of resources the bundle no longer contains, so uploading the same bundle again changes nothing. Every resource becomes its own Unit. */ post: operations["Upload"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/user": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List Users * @description List Users */ get: operations["ListUsers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/user/{user_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get User * @description Get User */ get: operations["GetUser"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/view": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List of Views across spaces * @description Retrieves a list of Views across spaces in the Organization */ get: operations["ListAllViews"]; put?: never; /** * Bulk create (clone) multiple views * @description Clone multiple views selected by query parameters with optional name prefixes and destination spaces */ post: operations["BulkCreateViews"]; /** * Bulk delete multiple views * @description Delete multiple views selected by query parameters */ delete: operations["BulkDeleteViews"]; options?: never; head?: never; /** * Bulk patch multiple views * @description Apply JSON merge patch to multiple views selected by query parameters */ patch: operations["BulkPatchViews"]; trace?: never; }; "/view/move": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Move views to another space * @description Move the selected Views to another Space. Requires Manage permission on each one moved and CreateChildren permission on the destination Space. Every check runs over the whole selection before anything is moved. */ post: operations["BulkMoveViews"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; } interface components { schemas: { /** @description Information provided to clients by the server. */ ApiInfo: { readonly AuthIssuer?: string; /** @description Build identifier for support cases. */ readonly Build?: string; /** * @description The timestamp when ConfigHub was built in "2023-01-01T12:00:00Z" format for support cases. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly BuiltAt?: string; /** @description ClientID for identity provider service. */ readonly ClientID?: string; readonly DeviceAuthURL?: string; readonly DeviceTokenURL?: string; /** @description OCI registry host for pulling configuration artifacts. */ readonly OCIHost?: string; /** @description OCI registry port for pulling configuration artifacts. */ readonly OCIPort?: string; /** @description Whether the OCI registry is reached over https. It is the scheme of the instance's configured registry URL. Without one, it is true when the request arrived over https and absent otherwise, since a load balancer that terminates TLS without forwarding headers makes an https request look like plain http. When it is absent, as it also is from servers that predate it, a client uses the scheme it reached the API over. */ readonly OCITLS?: boolean | null; readonly TokenExchangeAudience?: string; readonly TokenExchangeEndpoint?: string; readonly UIURL?: string; /** @description Version of the server, either a release (e.g. v1.2.3) or a build from a working tree (e.g. v1.2-dev). Its first two numbers are the API version: pre-1.0, a change in the second is not backward compatible. Also sent on every response in the ConfigHub-Version header. */ readonly Version?: string; }; ArrayElementAliasMap: { [key: string]: { [key: string]: string; }; }; ArrayOrderMap: { [key: string]: string[]; }; AttestRequest: { /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeOrderID?: string; Claims?: { [key: string]: string; }; EvidenceAttestationIDs?: components["schemas"]["UUID"][]; /** * Format: date-time * @example 2006-01-02T15:04:05Z07:00 */ ExpiresAt?: string; Note?: string; Permissions?: components["schemas"]["Permissions"]; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ReleaseID?: string; Result?: string; Revision?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ RevokedAttestationID?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceFilterID?: string; TargetStage?: string; Type?: string; WhereSpace?: string; WhereUnit?: string; }; AttestResult: { Spaces?: components["schemas"]["AttestSpaceResult"][]; }; AttestSpaceResult: { Attestation?: components["schemas"]["Attestation"]; Error?: components["schemas"]["ResponseError"]; SkippedUnits?: components["schemas"]["AttestationSkippedUnit"][]; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; SpaceSlug?: string; Subjects?: components["schemas"]["AttestationSubject"][]; }; /** @description An Attestation records that a principal made a claim about specific Revisions, all in its Space: that they approve them, that a review or check passed or failed, or anything else its Type names. It is never updated; withdrawing one is a new Attestation naming it in RevokedAttestationID. */ Attestation: { /** * Format: uuid * @description Uniquely identifies the Attestation. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ AttestationID?: string; /** * Format: uuid * @description The ChangeOrder the Attestation was made in the context of. Context only: it does not change which Revisions are covered. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeOrderID?: string; /** @description Anything else the attester records, as string key/value pairs with the limits of Annotations. */ Claims?: { [key: string]: string; }; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description Other Attestations this one relied on. They may be in other Spaces. */ EvidenceAttestationIDs?: components["schemas"]["UUID"][]; /** * Format: date-time * @description When the Attestation stops satisfying requirements. Optional. * @example 2006-01-02T15:04:05Z07:00 */ ExpiresAt?: string; /** @description SHA256 hash of the claim encoded as hexadecimal: the statement (Type, Result, RevokedAttestationID, ChangeOrderID, ReleaseID, EvidenceAttestationIDs, Note, Claims and ExpiresAt), the User who recorded it, and the Revisions it covers. (readonly) */ readonly Hash?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description The attester's reason, in their own words. */ Note?: string; /** * Format: uuid * @description The Organization the Attestation belongs to. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Permissions to access this attestation. */ Permissions?: components["schemas"]["Permissions"]; /** * Format: uuid * @description A published Release the claim is about. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ReleaseID?: string; /** * @description The outcome: Pass or Fail. For an Approval, approve or reject. Defaults to Pass. * @enum {string} */ Result?: AttestationResult; /** * Format: uuid * @description An earlier Attestation in the same Space that this one withdraws. A revocation covers no Revisions of its own. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ RevokedAttestationID?: string; /** * Format: uuid * @description The Space the Attestation belongs to. Every Revision it covers is in this Space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space the Attestation belongs to. */ readonly SpaceSlug?: string; /** @description What is being claimed, such as Approval. Requirements select Attestations by it. Defaults to Approval. */ Type?: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: uuid * @description The authenticated User that created the Attestation. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UserID?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; AttestationCreateRequest: { /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeOrderID?: string; Claims?: { [key: string]: string; }; EvidenceAttestationIDs?: components["schemas"]["UUID"][]; /** * Format: date-time * @example 2006-01-02T15:04:05Z07:00 */ ExpiresAt?: string; Note?: string; Permissions?: components["schemas"]["Permissions"]; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ReleaseID?: string; Result?: string; Revision?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ RevokedAttestationID?: string; Type?: string; WhereUnit?: string; }; AttestationCreateResponse: { Attestation?: components["schemas"]["Attestation"]; SkippedUnits?: components["schemas"]["AttestationSkippedUnit"][]; Subjects?: components["schemas"]["AttestationSubject"][]; }; AttestationGateCaller: { /** @description How many of the Revisions evaluated the caller wrote part of. */ AuthoredRevisions?: number; /** @description A Pass the caller records would count on every Revision evaluated. */ Counts?: boolean; /** @description Why it would not: NotEligible, when the prerequisite names neither the caller nor a Group of theirs, or Author, when the caller wrote part of the change on some Revision. */ Reason?: string; }; AttestationGateEntry: { /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ AttestationID?: string; /** @description How many of the Revisions evaluated it counts on. A Fail that counts rejects them. */ CountedOn?: number; /** @description How many of the Revisions it counts on have the content the Space's latest Release already bundles for their Unit. */ CountedOnPreviouslyReleased?: number; /** @description It covers a Revision evaluated whose content the Space's latest Release does not already bundle, so it is a decision on what is being promoted or released. Every Attestation an entry or Final gate finds covers one. */ CoversNew?: boolean; /** * Format: date-time * @example 2006-01-02T15:04:05Z07:00 */ CreatedAt?: string; /** @description Why it counts on none of the Revisions it covers: Revoked, Expired, TooOld (older than MaxAge), NotEligible, Author, or FailIgnored (a Fail, under IgnoreFail). */ Reason?: string; /** @description Pass or Fail. */ Result?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UserID?: string; /** * Format: date-time * @description When it stops counting: the earlier of its ExpiresAt and its CreatedAt plus the prerequisite's MaxAge. Absent when neither is set. */ ValidUntil?: string | null; }; AttestationGateResult: { /** @description Every Attestation of Type covering a Revision evaluated, directly or carried forward from an earlier Revision of the same Unit with the same DataHash, and what became of it. */ Attestations?: components["schemas"]["AttestationGateEntry"][]; /** @description Users excluded from counting on some Revision because they wrote part of the change there. Empty with AllowAuthors. */ AuthorUserIDs?: components["schemas"]["UUID"][]; /** @description Whether a Pass recorded by the caller would count here. */ Caller?: components["schemas"]["AttestationGateCaller"]; /** @description The fewest attesters counted on any Revision evaluated: the gate's progress toward Required. */ Counted?: number; /** @description For a release gate, how many of the Revisions evaluated have the content the Space's latest Release already bundles for their Unit. */ PreviouslyReleased?: number; /** @description How many distinct attesters each Revision needs: Count, or the number of FromGroupIDs with DistinctGroups. */ Required?: number; /** @description How many Revisions were evaluated: one of each Unit the change changed in the Space, or each Revision a Release bundles. */ Revisions?: number; /** @description How many of them have what the prerequisite asks for. */ SatisfiedRevisions?: number; /** @description More Revisions fall short than Unsatisfied lists. */ Truncated?: boolean; /** @description The Attestation Type the prerequisite counts. */ Type?: string; /** @description The Revisions that fall short, at most 100. */ Unsatisfied?: components["schemas"]["AttestationGateRevision"][]; }; AttestationGateRevision: { /** @description Users excluded from counting on this Revision because they wrote part of the change on this Unit. Empty with AllowAuthors. */ AuthorUserIDs?: components["schemas"]["UUID"][]; /** @description Distinct attesters counted on this Revision. */ Counted?: number; /** @description The Space's latest Release already bundles this content for the Unit: it was released without what the prerequisite asks for. */ PreviouslyReleased?: boolean; /** @description AttestationsMissing or AttestationRejected. */ Reason?: string; /** Format: int64 */ RevisionNum?: number; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; UnitSlug?: string; }; AttestationSkippedUnit: { /** @description Why the Unit is not covered, in words. */ Message?: string; /** @description Why the Unit is not covered, as a code: NoTarget or NoRevision. */ Reason?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; UnitSlug?: string; }; AttestationSubject: { /** @description With a ChangeOrder, the caller wrote one of the Revisions of the change on this Unit in this Space, so the Attestation does not count here for a prerequisite that excludes authors. */ Authored?: boolean; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ RevisionID?: string; /** Format: int64 */ RevisionNum?: number; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; UnitSlug?: string; }; /** * @description Defines a dynamic configuration attribute that registers getter and setter functions * and their associated paths in a Space's FunctionExecutor. Attributes enable per-Space * customization of the function registry by specifying a set of paths within a resource * type that can be read and written using generated get- and set- functions. */ Attribute: { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** * Format: uuid * @description AttributeID uniquely identifies an attribute within the system. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ AttributeID?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly BackingUnitID?: string; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description DataType specifies the data type of the attribute value. Must be one of: string, int, bool. */ DataType: string; /** @description An optional set of gates that, if any is present, will block deletion. */ DeleteGates?: { [key: string]: boolean; }; /** @description Description describes the attribute and its generated functions. */ Description?: string; /** @description Friendly name for the entity. */ DisplayName?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description Hash is a SHA256 hash of the attribute's defining properties. (readonly) */ readonly Hash?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** * Format: uuid * @description Unique identifier for an organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Parameters specifies the function parameters for the getter and setter functions. */ Parameters?: components["schemas"]["FunctionParameter"][] | null; /** @description Permissions to access this attribute. */ Permissions?: components["schemas"]["Permissions"]; /** @description ResourceTypePaths maps resource types to their path-to-visitor-info mappings. */ ResourceTypePaths?: components["schemas"]["ResourceTypePathsEntry"][] | null; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: uuid * @description Unique identifier for a space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space this entity belongs to. (readonly) */ readonly SpaceSlug?: string; /** * @description ToolchainType specifies the type of toolchain this attribute works with. * @example Kubernetes/YAML */ ToolchainType: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UpstreamAttributeID?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; AttributeCreateOrUpdateResponse: { Attribute?: components["schemas"]["Attribute"]; Error?: components["schemas"]["ResponseError"]; }; AttributeDetails: { /** * Format: uuid * @description ID of the Link that bound this needed path to a provided value * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ BoundLinkID?: string; /** @description ProvidedProperties of the provided path that was bound to this needed path, for cross-link score comparison */ BoundProvidedProperties?: { [key: string]: string; }; /** @description Value a defaulting function writes at this path, if any */ DefaultValue?: unknown; /** @description Description of the attribute */ Description?: string; /** @description Whether this attribute is a needed value */ IsNeeded?: boolean; /** @description Whether this attribute is a provided value */ IsProvided?: boolean; /** @description Preferred properties for matching; more matches produce a stronger match preference */ NeededPreferred?: { [key: string]: string; }; /** @description Required properties that a provided value must have in order to match */ NeededRequired?: { [key: string]: string; }; /** @description Key/value properties describing what this provided value offers, for matching */ ProvidedProperties?: { [key: string]: string; }; }; AttributeInfo: { /** @description Name of the registered attribute */ AttributeName?: string; /** @description Data type if the attribute value. */ DataType?: string; /** @description Additional attribute details */ Details?: components["schemas"]["AttributeDetails"]; /** @description Path of the attribute */ Path?: string; /** @description Category of configuration element represented in the configuration data; Kubernetes resources are of category Resource, and application configuration files are of category AppConfig */ ResourceCategory?: string; /** @description Name of a resource in the system under management represented in the configuration data; Kubernetes resources are represented in the form /; not all ToolchainTypes necessarily use '/' as a separator between any scope(s) and name or other client-chosen ID */ ResourceName?: string; /** @description Name of a resource in the system under management represented in the configuration data with generated prefixes and suffixes stripped; empty if nothing to strip */ ResourceNameStableCore?: string; /** @description Name of a resource in the system under management represented in the configuration data, without any uniquifying scope, such as Namespace, Project, Account, Region, etc.; Kubernetes resources are represented in the form */ ResourceNameWithoutScope?: string; /** @description Type of a resource in the system under management represented in the configuration data; Kubernetes resources are represented in the form / (aka group-version-kind) */ ResourceType?: string; }; AttributeSelector: { Path?: string; WhereResource?: string; }; AttributeValue: { /** @description Name of the registered attribute */ AttributeName?: string; /** @description Line comment on the attribute at the specified Path */ Comment?: string; /** @description Data type if the attribute value. */ DataType?: string; /** @description Additional attribute details */ Details?: components["schemas"]["AttributeDetails"]; /** @description Name of the function invocation corresponding to the output */ FunctionName?: string; /** @description Index of the function invocation corresponding to the output. Useful in the case that multiple function invocations in the same executor call return AttributeValueList output. */ Index?: number; /** @description Issues found with the attribute */ Issues?: components["schemas"]["Issue"][]; /** @description Path of the attribute */ Path?: string; /** @description Category of configuration element represented in the configuration data; Kubernetes resources are of category Resource, and application configuration files are of category AppConfig */ ResourceCategory?: string; /** @description Name of a resource in the system under management represented in the configuration data; Kubernetes resources are represented in the form /; not all ToolchainTypes necessarily use '/' as a separator between any scope(s) and name or other client-chosen ID */ ResourceName?: string; /** @description Name of a resource in the system under management represented in the configuration data with generated prefixes and suffixes stripped; empty if nothing to strip */ ResourceNameStableCore?: string; /** @description Name of a resource in the system under management represented in the configuration data, without any uniquifying scope, such as Namespace, Project, Account, Region, etc.; Kubernetes resources are represented in the form */ ResourceNameWithoutScope?: string; /** @description Type of a resource in the system under management represented in the configuration data; Kubernetes resources are represented in the form / (aka group-version-kind) */ ResourceType?: string; /** @description Score of finding attributed to this Path */ Score?: string; /** @description Value of the attribute at the specified Path */ Value?: unknown; }; AttributeValueList: components["schemas"]["AttributeValue"][]; Binding: { /** @description Shared attribute name that matched the need to the provide */ AttributeName?: string; /** @description DataType of the bound value */ DataType?: string; /** @description Identifies a binding within its Link's ManualBindings, so that a merge of two versions of the Link matches bindings by Key rather than by position. Optional, and unique within the list when present. Letters, digits, '-' and '_', starting with a letter or digit; at most 128 characters. */ Key?: string; /** @description Resolved path within the needed resource */ NeededPath?: string; /** @description Resource in the downstream unit that needs the value */ NeededResource?: components["schemas"]["ResourceInfo"]; /** @description Resolved path within the provided resource */ ProvidedPath?: string; /** @description Resource in the upstream unit that provides the value */ ProvidedResource?: components["schemas"]["ResourceInfo"]; }; BindingList: components["schemas"]["Binding"][]; BlameConfigComments: { /** @description The comment on the lines below the field. */ Foot?: string; /** @description The comment on the lines above the field. On the row about a resource as a whole, the comment above the resource's document separator. */ Head?: string; /** @description The comment at the end of the field's line. */ Line?: string; }; BlameConflictDismissal: { /** @description For a dismissal of what one guard withheld, the guard's key. */ Guard?: string; /** @description The guard's value; empty for any value. */ GuardValue?: string; /** @description Where the dismissal is recorded: a path, which may name any list element or map key with *, or empty for the resource as a whole. */ Path?: string; /** @description The reason of the conflicts dismissed. */ Reason?: string; }; BlameField: { /** @description True for a field the unit does not have, listed because a conflict names it: a merge could not find the path, or the resource, to make an upstream change to. It has no value and no history. */ Absent?: boolean; /** @description The changes that put the value here, from this unit out to where it was set, following each merge and Link resolve upstream. The last is the answer. */ Chain?: components["schemas"]["BlameOrigin"][]; /** @description The conflict dismissals recorded for this row: at the field's path or by a pattern naming it, or, on the row about a resource as a whole, on the resource. The unit's path report lists every dismissal covering the field, its resource's included. */ ConflictDismissals?: components["schemas"]["BlameConflictDismissal"][]; /** @description The unit's outstanding conflicts about the field: upstream changes to it a merge or resolve dropped. */ Conflicts?: components["schemas"]["MutationConflict"][]; /** @description True for a field, or a resource, that the unit does not have because a change deleted it: the unit's record still names the deletion. It has no value; its chain is the change that deleted it, and Guards says whether a merge leaves it deleted. */ Deleted?: boolean; /** @description The unit's Link findings about the field: what a Link's resolve could not do here. */ Findings?: components["schemas"]["LinkFinding"][]; /** @description What there is to know about the field, one code each: Protected, Guarded, Conflict, ConflictDismissed, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed and Provided. */ Flags?: string[]; /** @description The guards on the field: its own, its ancestors' and its resource's, which an operation writing here has to be cleared for. */ Guards?: { [key: string]: string; }; /** @description The keys of Guards that are inherited: copied to the unit's clones and carried by merges to the units downstream of it. The others stay with this unit. */ InheritedGuards?: string[]; /** @description The unit's needed paths that are the field: a value it is to take from an upstream unit through a NeedsProvides Link. */ Needed?: components["schemas"]["BlameNeededPath"][]; /** @description The field's path, in the syntax functions and Links take. Empty on the row about the resource as a whole, which comes first among the resource's fields and carries what is recorded about the resource rather than one of its fields: the change that added or deleted it, whether it is protected as a whole, its guards, and its conflicts, findings and failed checks that name no path. */ Path?: string; /** @description Deprecated and always false: a local override a merge leaves alone is an Override guard, which Guards lists. */ Protected?: boolean; /** @description The unit's provided paths that are the field: a value it offers downstream units through NeedsProvides Links. */ Provided?: components["schemas"]["AttributeInfo"][]; /** @description The field's short reference: the same in every Revision of the unit and in every variant of it, so it lines up one field across variants. The path report takes it, or a prefix of it, in place of the resource and path. */ Ref?: string; /** @description The name of the resource the field is in. */ ResourceName?: string; /** @description The name of the resource without its scope, such as its namespace, which is how a resource a variant renamed is matched. */ ResourceNameWithoutScope?: string; /** @description Deprecated and always false: a resource held as a whole is one with a guard on the resource, which Guards lists for each of its fields. */ ResourceProtected?: boolean; /** @description The type of the resource the field is in. */ ResourceType?: string; /** * Format: uuid * @description The Space of the unit the field is in. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description The slug of the Space of the unit the field is in. */ SpaceSlug?: string; /** * Format: uuid * @description The unit the field is in. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; /** @description The slug of the unit the field is in. */ UnitSlug?: string; /** @description The unit's failed validating checks that name the field. */ Validation?: components["schemas"]["BlameValidation"][]; /** @description The field's value, as YAML. */ Value?: string; }; BlameNeededPath: { /** @description Name of the registered attribute */ AttributeName?: string; BoundLink?: string; /** @description Line comment on the attribute at the specified Path */ Comment?: string; /** @description Data type if the attribute value. */ DataType?: string; /** @description Additional attribute details */ Details?: components["schemas"]["AttributeDetails"]; /** @description Name of the function invocation corresponding to the output */ FunctionName?: string; /** @description Index of the function invocation corresponding to the output. Useful in the case that multiple function invocations in the same executor call return AttributeValueList output. */ Index?: number; /** @description Issues found with the attribute */ Issues?: components["schemas"]["Issue"][]; /** @description Path of the attribute */ Path?: string; /** @description Category of configuration element represented in the configuration data; Kubernetes resources are of category Resource, and application configuration files are of category AppConfig */ ResourceCategory?: string; /** @description Name of a resource in the system under management represented in the configuration data; Kubernetes resources are represented in the form /; not all ToolchainTypes necessarily use '/' as a separator between any scope(s) and name or other client-chosen ID */ ResourceName?: string; /** @description Name of a resource in the system under management represented in the configuration data with generated prefixes and suffixes stripped; empty if nothing to strip */ ResourceNameStableCore?: string; /** @description Name of a resource in the system under management represented in the configuration data, without any uniquifying scope, such as Namespace, Project, Account, Region, etc.; Kubernetes resources are represented in the form */ ResourceNameWithoutScope?: string; /** @description Type of a resource in the system under management represented in the configuration data; Kubernetes resources are represented in the form / (aka group-version-kind) */ ResourceType?: string; /** @description Score of finding attributed to this Path */ Score?: string; /** @description Value of the attribute at the specified Path */ Value?: unknown; }; BlameOrigin: { /** @description The ChangeOrders that made the Revision. */ ChangeOrderIDs?: components["schemas"]["UUID"][]; /** @description The slugs of the ChangeOrders that made the Revision. */ ChangeOrders?: string[]; /** @description The Revision's change description. */ Description?: string; /** @description The function the change ran, if it ran one. */ Function?: string; /** @description The slug of the Invocation the change ran. */ Invocation?: string; /** * Format: uuid * @description The Invocation the change ran, if it ran one. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ InvocationID?: string; /** @description The slug of the Link that made the change. */ Link?: string; /** * Format: uuid * @description The Link that made the change, if one did. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ LinkID?: string; /** @description The unit a Link's resolve read the value from, as space/unit or unit. */ LinkUpstream?: string; /** * Format: int64 * @description The number of the Revision of the upstream unit the Link's resolve read. */ LinkUpstreamRevisionNum?: number; /** * Format: uuid * @description The unit a Link's resolve read the value from, whether or not the chain could follow it there. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ LinkUpstreamUnitID?: string; /** * Format: int64 * @description The number of the Mutation that recorded the change; 0 for a change no Mutation recorded. */ MutationNum?: number; /** @description The Releases that bundle the Revision. */ ReleaseIDs?: components["schemas"]["UUID"][]; /** @description The numbers of the Releases that bundle the Revision. */ Releases?: string[]; /** * Format: uuid * @description The Revision the change made. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ RevisionID?: string; /** * Format: int64 * @description The number of the Revision the change made. */ RevisionNum?: number; /** @description What decided to make the change, most specific first: the Link or Trigger, the function, the external source, the Invocation, the merge, or otherwise the operation that made the Revision. For people to read; the fields beside it say the same for programs. */ SetBy?: string; /** @description The operation that made the Revision, such as UpdateUnit or TransformPaths. */ Source?: string; /** * Format: uuid * @description The Space of the unit the change was made in. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description The slug of the Space of the unit the change was made in. */ SpaceSlug?: string; /** @description The Tags that mark the Revision. */ TagIDs?: components["schemas"]["UUID"][]; /** @description The slugs of the Tags that mark the Revision. */ Tags?: string[]; /** @description The slug of the Trigger that made the change. */ Trigger?: string; /** * Format: uuid * @description The Trigger that made the change, if one did. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TriggerID?: string; /** * Format: uuid * @description The unit the change was made in. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; /** @description The slug of the unit the change was made in. */ UnitSlug?: string; /** @description The username of the user who made the change, or automation for a change made by no user. */ User?: string; /** * Format: uuid * @description The user who made the change; absent for one made by no user. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UserID?: string; /** * Format: date-time * @description When the Revision was made. * @example 2006-01-02T15:04:05Z07:00 */ When?: string; }; BlamePathChange: { /** @description The Mutation that recorded the change, with its Link, Trigger, Invocation and merge source. */ Mutation?: components["schemas"]["ExtendedMutation"]; /** @description What the unit's record says the change did to the field: Add, Update, Replace or Delete. Returned in History. */ MutationType?: string; /** @description The change, as a chain hop. */ Origin?: components["schemas"]["BlameOrigin"]; /** @description The Revision the change made, with its user, ChangeOrders, Releases and Tags. */ Revision?: components["schemas"]["ExtendedRevision"]; /** @description The value the change recorded for the field. Returned in History. */ Value?: string; }; BlameReviewThread: { /** * Format: uuid * @description The ChangeOrder the thread was made in review of, if any; the report's Names names it, unless it cannot be read. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeOrderID?: string; /** @description The comment that started the thread, then its replies, replies to replies included, oldest first. Hidden comments are left out; a thread whose first comment is hidden still has its replies. The report's Names names each comment's author by UserID, unless the author cannot be read. */ Comments?: components["schemas"]["ReviewComment"][] | null; }; BlameValidation: { /** @description The result's free-text messages, where the function gave no Issues. */ Details?: string[]; /** @description The validating function that failed. */ Function?: string; /** @description The check, as //, the key of ValidationErrors, ValidationWarnings and ValidationResults on the Unit. */ Gate?: string; /** @description What is wrong, as the function put it. */ Issues?: components["schemas"]["Issue"][]; /** @description What the result named, when it named an ancestor of the field, or the field by its position in an array rather than by its path. */ Path?: string; /** @description The severity the function gave the finding, if it gives one. */ Score?: string; /** * Format: uuid * @description The Trigger that ran the check. The gate names it by the slugs it had when it ran. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TriggerID?: string; /** @description What the function found at the path, when it reported it. */ Value?: unknown; /** @description True for a check of a Trigger with Warn set, whose failures do not block a release. */ Warning?: boolean; }; BrowserSessionResponse: { ExpiresIn?: number; Ticket?: string; URL?: string; }; /** @description Defines a change's identity as it moves between Spaces. */ ChangeOrder: { /** @description AbortedReason says why the ChangeOrder was given up on. Setting it is what aborts one: a ChangeOrder with a reason is Aborted whatever its Links say. */ AbortedReason?: string; /** * Format: uuid * @description AdoptedEndTagID is the Tag whose marks were taken as the ChangeOrder's boundary, when it was created with one, and empty when the boundary was each Unit's head Revision. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly AdoptedEndTagID?: string; /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** * Format: uuid * @description ChangeOrderID uniquely identifies a change order within the system. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeOrderID?: string; /** @description ChangeWorkflow governs how this ChangeOrder is promoted: the ordered stages it moves through and the gates that have to pass before it enters one. It is a copy taken when the workflow was associated, not a reference, so editing the ChangeWorkflow afterwards cannot change the rules a rollout already started under. Empty is a ChangeOrder no workflow governs, which is promoted ungated. */ readonly ChangeWorkflow?: components["schemas"]["ChangeWorkflowSpec"]; /** * Format: uuid * @description ChangeWorkflowID is the ChangeWorkflow this ChangeOrder is promoted under. It says which workflow the stored copy was taken from, and keeps saying so after that workflow has been edited or deleted, which is why it is not a foreign key. Every Space the ChangeOrder is headed for has to be selected by one of the workflow's Stages, since a Space in none of them cannot be promoted into; the ChangeOrder's own Space is exempt when the change is already there, as it is for UpgradeUnit and MergeUnits. Creating a ChangeOrder, or an update adding a Space to InScopeSpaceIDs, is refused otherwise. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeWorkflowID?: string; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description An optional set of gates that, if any is present, will block deletion. */ DeleteGates?: { [key: string]: boolean; }; /** @description Description is a human-readable description of the change. */ Description?: string; /** @description Friendly name for the entity. */ DisplayName?: string; /** * Format: uuid * @description EndTagID is the identifier of the set of Revisions that end the ChangeOrder. The ChangeOrder always mints this Tag itself; supplying one at creation adopts its marks as the boundary, and the supplied Tag is recorded as AdoptedEndTagID and never written to. Without one the boundary is each Unit's head Revision. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ EndTagID?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description InScopeSpaceIDs is where the ChangeOrder is headed: the Spaces it propagates into, recorded as a list rather than asked again on each read. When WhereSpace or SpaceFilterID is set, the server writes it from that selection, and a write naming a different list is refused; otherwise the client supplies it. Empty names a change without saying where it is headed, in which case the Spaces the ChangeOrder's Links reach when its scope is derived are recorded instead; an Invoke ChangeOrder has no Links to fall back on and requires a non-empty list. ResolvedSpaceIDs and ReleasedSpaceIDs are measured against it. Changing it re-derives what the ChangeOrder covers. */ InScopeSpaceIDs?: components["schemas"]["UUID"][]; /** * Format: uuid * @description InvocationID is the Invocation an Invoke ChangeOrder runs. Required for that UpdateType and refused for the others. Naming it here is what makes every Space in scope receive the same update: the invoke API takes what it runs from the ChangeOrder. Immutable. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ InvocationID?: string; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** * Format: uuid * @description Unique identifier for an organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Parameters supplies values for the declared Parameters of a parameterized Invocation, keyed by parameter name, validated against the declaration the way ParameterizedInvocations are on a direct call. One set for the whole ChangeOrder, not one per Space. Immutable. */ Parameters?: { [key: string]: unknown; }; /** @description Permissions to access this change order. */ Permissions?: components["schemas"]["Permissions"]; /** * @description How the ChangeOrder marks the Units its change does not change, and the default PriorRevisions for its promotions. Include (the default), Skip and Error mark such a Unit at the Revision its followers have taken, or at its LastReleasedRevisionNum when that is later, or at its head if it has neither, so promoting the change does not move it; a promotion then merges a changed Unit's Revisions from before the change (Include), passes over them for good (Skip), or refuses (Error). All marks every such Unit at its head, so promoting the change brings every Unit up to the Space it takes from. Immutable: the ChangeOrder's own Space is marked when it is created. * @enum {string} */ PriorRevisions?: ChangeOrderPriorRevisions; /** @description PromotionFailures records each promotion that did not complete: who ran it, when, into which Stage, and each Space it failed or was blocked in, with the Space's error or reason and the error of each Unit and Link whose write failed. The most recent entries are kept. Set by the server. (readonly) */ readonly PromotionFailures?: components["schemas"]["ChangeOrderPromotionFailure"][]; /** @description PromotionOverrides records each promotion forced into a Stage whose gates did not hold: who forced it, when, into which Stage and Spaces, why, and which gates failed. The most recent entries are kept. Set by the server. (readonly) */ readonly PromotionOverrides?: components["schemas"]["ChangeOrderPromotionOverride"][]; /** @description Promotions records each promotion that wrote the change into Spaces: who ran it, when, into which Stage, and which Spaces. A promotion entering several Stages records one entry per Stage. The most recent entries are kept. Set by the server. (readonly) */ readonly Promotions?: components["schemas"]["ChangeOrderPromotion"][]; /** * @description What a Release of the ChangeOrder does with a bundled Unit's Revisions from before the change: those after its LastReleasedRevisionNum, up to the one the start Tag marks. Include (the default) releases them; Error refuses the publish, naming them and the ChangeOrders they belong to. A publish's PriorRevisions overrides it. * @enum {string} */ ReleasePriorRevisions?: ChangeOrderReleasePriorRevisions; /** * Format: uuid * @description ReleaseTagID is the Tag a Release of the ChangeOrder is published at. It marks one Revision of each Unit that is not Unreleasable in every Space the change is in: the Revision the end Tag marks, or the head where the Unit does not carry it. It follows Revisions the resolve processor makes after the promotion, and can be moved with a tag move, until a Release in the Space has been published at it. Empty on ChangeOrders created before it existed. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly ReleaseTagID?: string; /** @description ReleasedRestoredSpaceIDs is where the undoing has been released: the Spaces in RestoredSpaceIDs whose Units are released at or past the Revision the restore Tag marks. Covering ReleasedSpaceIDs is what State reports as RestoreReleased. Derived when the ChangeOrder is read. */ readonly ReleasedRestoredSpaceIDs?: components["schemas"]["UUID"][]; /** @description ReleasedSpaceIDs is where the ChangeOrder has been released: the Spaces in scope whose Units in the Space's release are applied at or past the Revision the end Tag marks. A Space with no ReleaseTargetID is never here, since nothing releases it. Derived when the ChangeOrder is read. */ readonly ReleasedSpaceIDs?: components["schemas"]["UUID"][]; /** @description Releases names, for each Space in ReleasedSpaceIDs, the earliest published Release of the Space that carries the change, which is the Release the gates read. A Space whose Releases no longer carry the change, such as one whose Release was withdrawn, has no entry. Derived when the ChangeOrder is read. */ readonly Releases?: components["schemas"]["ChangeOrderRelease"][]; /** @description ResolvedSpaceIDs is where the ChangeOrder has been fully propagated to: the Spaces in scope whose Links of its UpdateType have all merged it, plus the Space it resides in. For an Invoke ChangeOrder it is the Spaces in scope where every Unit WhereUnit selects carries the end Tag, and its own Space counts only if it is one of them. Derived when the ChangeOrder is read. */ readonly ResolvedSpaceIDs?: components["schemas"]["UUID"][]; /** * Format: uuid * @description RestoreTagID is the Tag marking the Revisions that undid the ChangeOrder. The first restore mints it; every restore after that marks with the same Tag. Empty until something has been restored. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly RestoreTagID?: string; /** @description RestoredSpaceIDs is where the ChangeOrder has been undone: the Spaces whose Units all carry the restore Tag. Derived when the ChangeOrder is read. */ readonly RestoredSpaceIDs?: components["schemas"]["UUID"][]; /** @description ReviewRequests records whose review the change is waiting for: for each, the stage whose Spaces are to be reviewed (empty for the change order's own Space), the User, and when and by whom the review was requested. A request is not cleared when the review is given; whether a reviewer has reviewed is read from their Attestations. A merge patch replaces the list whole. At most 256. */ ReviewRequests?: components["schemas"]["ChangeOrderReviewRequest"][]; /** @description SkippedUnits names the Units of the ChangeOrder's Space that it carries no Revisions of, mapped to the reason as a code: NotFollowed (nothing follows the Unit by Links of the change order's UpdateType, and it was never cloned), FollowedByOtherLinks (it is followed downstream, but not by Links of that UpdateType), NotMarked (the end Tag marks no Revision of it), NoStartRevision (a Link to it has never merged or resolved, and it predates empty start Revisions), AlreadyTaken (the Spaces in scope have already taken it as far as the end, so it is marked, carrying no Revisions), or TakenPastEnd (the Spaces in scope have taken it past the end, so it is not marked). Written when the scope is derived. */ readonly SkippedUnits?: { [key: string]: string; }; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: uuid * @description SpaceFilterID references a Filter (with From=Space) selecting where the ChangeOrder is headed, ANDed with WhereSpace when both are set. While either is set, the server evaluates the selection into InScopeSpaceIDs. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceFilterID?: string; /** * Format: uuid * @description Unique identifier for a space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space this entity belongs to. (readonly) */ readonly SpaceSlug?: string; /** @description Stage is the stage of ChangeWorkflow the change order has reached, or Completed once the last stage satisfies Final. Set by the server. (readonly) */ readonly Stage?: string; /** * Format: uuid * @description StartTagID is the identifier of the set of Revisions immediately before the ChangeOrder, making it the half-open interval (start, end]. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly StartTagID?: string; /** @description State is how far the ChangeOrder has got: New until a Space other than its own has taken it, InProgress while some have and some have not, Resolved once every Space in scope has, Released once every Space in scope that has a ReleaseTargetID has released what it took (a Space with none has nothing to release), Aborted whenever AbortedReason is set, Restored once every Space that had taken it has been restored to the Revisions before it, and RestoreReleased once every Space that had released it has released the restored Revisions. Derived when the ChangeOrder is read. */ readonly State?: string; /** * Format: uuid * @description UnitFilterID references a Filter (with From=Unit) narrowing the same selection as WhereUnit, conjoined with it. Refused on the other UpdateTypes. Immutable. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitFilterID?: string; /** @description UpdateType is how this ChangeOrder propagates. UpgradeUnit, the clone lineage, is the default, and MergeUnits is the other Link type it follows; both take the change from Revisions the source Unit already has. Invoke is the third: the change is one Invocation run in each Space in scope, and the ChangeOrder is created before any of it has happened. Insert, Upsert, and TransformPaths carry a change to Units outside the ChangeOrder's scope into the Spaces in scope: every Space in scope resolves its Links of that type to those Units at the Revision each was at when the ChangeOrder was created. Those Links must not be AutoUpdate, and InScopeSpaceIDs, or a selection that fills it in, is required. */ UpdateType?: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: uuid * @description The User who created the ChangeOrder. Absent for ChangeOrders created before it was recorded. (readonly) * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UserID?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; /** * @description Filter expression selecting where the ChangeOrder is headed, ANDed with SpaceFilterID when both are set. While either is set, the server evaluates the selection into InScopeSpaceIDs when the ChangeOrder is created, when either field changes, and on an update or patch with refresh_spaces. The specified string is an expression for the purpose of filtering * the list of Spaces returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, TriggerOtherUnitIDs, UpdatedAt, UpstreamSpaceID. * * The whole string must be query-encoded. */ WhereSpace?: string; /** @description WhereUnit narrows which Units of each Space in scope an Invoke ChangeOrder covers, and is refused on the other UpdateTypes. It takes what the where parameter of the Unit list does, attributes of what a Unit refers to included, as in `Space.Labels.Environment = 'prod'`. Empty covers every Unit. Unlike InScopeSpaceIDs it is asked again on every read, so a Unit added to a Space afterwards counts against that Space. Immutable. */ WhereUnit?: string; }; ChangeOrderCreateOrUpdateResponse: { ChangeOrder?: components["schemas"]["ChangeOrder"]; Error?: components["schemas"]["ResponseError"]; }; ChangeOrderPromotion: { /** * Format: date-time * @example 2006-01-02T15:04:05Z07:00 */ PromotedAt?: string; SpaceIDs?: components["schemas"]["UUID"][]; Stage?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UserID?: string; }; ChangeOrderPromotionFailure: { /** * Format: date-time * @example 2006-01-02T15:04:05Z07:00 */ FailedAt?: string; Spaces?: components["schemas"]["ChangeOrderPromotionFailureSpace"][]; Stage?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UserID?: string; }; ChangeOrderPromotionFailureLink: { Error?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ LinkID?: string; Slug?: string; }; ChangeOrderPromotionFailureSpace: { Action?: string; Error?: string; Links?: components["schemas"]["ChangeOrderPromotionFailureLink"][]; Message?: string; Reason?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; SpaceSlug?: string; Stage?: string; Units?: components["schemas"]["ChangeOrderPromotionFailureUnit"][]; }; ChangeOrderPromotionFailureUnit: { Error?: string; Slug?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; }; ChangeOrderPromotionOverride: { FailedGates?: string[]; /** * Format: date-time * @example 2006-01-02T15:04:05Z07:00 */ OverriddenAt?: string; Reason?: string; SpaceIDs?: components["schemas"]["UUID"][]; Stage?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UserID?: string; }; ChangeOrderRelease: { /** * Format: uuid * @description The earliest published Release of the Space that carries the change. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ReleaseID?: string; /** * Format: int64 * @description The Release's number within its Target. */ ReleaseNum?: number; /** * Format: uuid * @description The Space the Release was published from. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; }; ChangeOrderReviewRequest: { /** * Format: date-time * @description When the review was requested, by the server's clock. A new request is stamped with the current time, and an existing one keeps its time; sending a later time than the one recorded re-requests the review, and stamps it with the current time. * @example 2006-01-02T15:04:05Z07:00 */ RequestedAt?: string; /** * Format: uuid * @description Who requested the review, or last re-requested it. Set by the server. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly RequestedByUserID?: string; /** @description The stage whose Spaces are to be reviewed, which is where an Attestation recorded with that TargetStage goes. Empty is the change order's own Space. */ Stage?: string; /** * Format: uuid * @description The User asked to review. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UserID: string; }; /** @description Defines an entity changeset. */ ChangeSet: { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** * Format: uuid * @description ChangeSetID uniquely identifies a changeset within the system. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeSetID?: string; /** @description ChangeWorkflow is a copy of the ChangeWorkflow ChangeWorkflowID names, taken when the ChangeSet was created, so editing the workflow afterwards does not change what closing this ChangeSet is judged against. Empty is a ChangeSet no workflow governs. (readonly) */ readonly ChangeWorkflow?: components["schemas"]["ChangeWorkflowSpec"]; /** * Format: uuid * @description ChangeWorkflowID is the ChangeWorkflow that gates closing this ChangeSet: its Final prerequisites, evaluated over every Space in InScopeSpaceIDs. The workflow must have no Stages, and its Final may not name Released or Healthy. Settable at creation and immutable afterwards. When a Unit in a Space that is a Variant of a Component joins the ChangeSet, the workflow must be one the Component allows, and is required if the Component requires one. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeWorkflowID?: string; /** @description CloseOverride records a close forced past the ChangeWorkflow's gates: who forced it, when, why, and which gates did not hold. (readonly) */ readonly CloseOverride?: components["schemas"]["ChangeSetCloseOverride"]; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description An optional set of gates that, if any is present, will block deletion. */ DeleteGates?: { [key: string]: boolean; }; /** @description Description is a human-readable description of the change. */ Description?: string; /** @description Friendly name for the entity. */ DisplayName?: string; /** * Format: uuid * @description EndTagID is the identifier of the set of revisions that end the ChangeSet. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly EndTagID?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description InScopeSpaceIDs are the Spaces of the Units the ChangeSet has been opened on. A Space is added when the first of its Units joins, and is not removed. Closing a ChangeSet governed by a ChangeWorkflow is gated over every one of them. (readonly) */ readonly InScopeSpaceIDs?: components["schemas"]["UUID"][]; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** * Format: uuid * @description Unique identifier for an organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Permissions to access this change set. */ Permissions?: components["schemas"]["Permissions"]; /** @description ReviewRequests records whose review the change is waiting for: for each, the User, and when and by whom the review was requested. A request is not cleared when the review is given; whether a reviewer has reviewed is read from their Attestations. A merge patch replaces the list whole. At most 256. */ ReviewRequests?: components["schemas"]["ChangeSetReviewRequest"][]; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: uuid * @description Unique identifier for a space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space this entity belongs to. (readonly) */ readonly SpaceSlug?: string; /** * Format: uuid * @description StartTagID is the identifier of the set of revisions that begin the ChangeSet. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly StartTagID?: string; /** @description StartTagIsPriorRevision reports whether the start Tag marks the Revision before the ChangeSet, making the ChangeSet the half-open interval (start, end]. False, the original meaning, means it marks the ChangeSet's first Revision. */ readonly StartTagIsPriorRevision?: boolean; /** @description State represents the current state of the ChangeSet. */ readonly State?: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: uuid * @description The User who created the ChangeSet. Absent for ChangeSets created before it was recorded. (readonly) * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UserID?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; ChangeSetCloseOverride: { FailedGates?: string[]; /** * Format: date-time * @example 2006-01-02T15:04:05Z07:00 */ OverriddenAt?: string; Reason?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UserID?: string; }; ChangeSetCloseResult: { /** * Format: uuid * @description The ChangeSet the write closed, or would have closed. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeSetID?: string; /** @description The close was forced past gates that did not hold, which the ChangeSet's CloseOverride records. */ Forced?: boolean; /** @description Each Final prerequisite of the ChangeSet's ChangeWorkflow, evaluated over each Space the ChangeSet was opened in. */ Gates?: components["schemas"]["PromoteGateResult"][]; }; ChangeSetCreateOrUpdateResponse: { ChangeSet?: components["schemas"]["ChangeSet"]; Error?: components["schemas"]["ResponseError"]; }; ChangeSetReviewRequest: { /** * Format: date-time * @description When the review was requested, by the server's clock. A new request is stamped with the current time, and an existing one keeps its time; sending a later time than the one recorded re-requests the review, and stamps it with the current time. * @example 2006-01-02T15:04:05Z07:00 */ RequestedAt?: string; /** * Format: uuid * @description Who requested the review, or last re-requested it. Set by the server. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly RequestedByUserID?: string; /** * Format: uuid * @description The User asked to review. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UserID: string; }; /** @description Declares how a change is promoted: the ordered stages it moves through, which Spaces each stage selects, and the gates that have to pass before it enters one. */ ChangeWorkflow: { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** @description The Attestations a stage, its releases, or Final may require. Declared once and named wherever they apply. */ AttestationPrerequisites?: components["schemas"]["ChangeWorkflowAttestationPrerequisite"][]; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly BackingUnitID?: string; /** * Format: uuid * @description ChangeWorkflowID uniquely identifies a change workflow within the system. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeWorkflowID?: string; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description CustomPrerequisites declares the checks a stage or Final may gate on beyond the built-in ones, each carrying a Name to gate on and a "cel:" Expression to evaluate. Declared once and named wherever they apply. */ CustomPrerequisites?: components["schemas"]["ChangeWorkflowPrerequisite"][]; /** @description An optional set of gates that, if any is present, will block deletion. */ DeleteGates?: { [key: string]: boolean; }; /** @description Friendly name for the entity. */ DisplayName?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description Final is what the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. In a workflow with no stages, which governs a ChangeSet, it is what every Space the ChangeSet was opened in must satisfy for it to close. */ Final?: components["schemas"]["ChangeWorkflowFinalStage"]; /** @description SHA256 hash of the change workflow's Stages, Final, CustomPrerequisites and AttestationPrerequisites encoded as hexadecimal. (readonly) */ readonly Hash?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** * Format: uuid * @description Unique identifier for an organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Permissions to access this change workflow. */ Permissions?: components["schemas"]["Permissions"]; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: uuid * @description Unique identifier for a space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space this entity belongs to. (readonly) */ readonly SpaceSlug?: string; /** @description Stages is the series a change is promoted through, in order. Ordered between stages and unordered within one. A workflow governing a ChangeOrder needs at least one; one governing a ChangeSet has none. */ Stages?: components["schemas"]["ChangeWorkflowStage"][]; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UpstreamChangeWorkflowID?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; ChangeWorkflowAttestationPrerequisite: { /** @description Count an attester who wrote a Revision of the change. By default one does not count. */ AllowAuthors?: boolean; /** @description How many distinct attesters must record a Pass on each Revision. 1 when zero. */ Count?: number; /** @description What the requirement is for, in the author's words. */ Description?: string; /** @description Require an attester from each group of FromGroupIDs, which it requires. A user in several of the groups covers only one of them, and Count does not apply. */ DistinctGroups?: boolean; /** @description The Groups whose members' Attestations count, beside the Users FromUserIDs names. Membership is read when the gate is evaluated, not when the Attestation was recorded. */ FromGroupIDs?: components["schemas"]["UUID"][]; /** @description The Users whose Attestations count. Empty is anyone who may record an Attestation in the Space. */ FromUserIDs?: components["schemas"]["UUID"][]; /** @description Count only passes. By default an unrevoked Fail from an eligible attester fails the requirement, however many passes there are. */ IgnoreFail?: boolean; /** @description How old an Attestation may be and still count, as a duration such as 72h. No limit when empty. */ MaxAge?: string; /** @description What a stage, its ReleasePrerequisites, or Final gates on. Unique among the workflow's prerequisites, and refused if it shadows a built-in name. */ Name: string; /** @description The Attestation Type that counts. Approval when empty. */ Type?: string; }; ChangeWorkflowCreateOrUpdateResponse: { ChangeWorkflow?: components["schemas"]["ChangeWorkflow"]; Error?: components["schemas"]["ResponseError"]; }; ChangeWorkflowFinalStage: { /** @description Evaluated over the last stage's Spaces, and named the same way a stage's entry gates are. */ Prerequisites?: string[]; }; ChangeWorkflowPrerequisite: { /** @description What the gate checks, in the author's words. A promotion this gate holds up reports the prerequisite by Name, so this is where the reason lives. Read by nobody: it is not part of what the gate evaluates. */ Description?: string; /** @description The check itself, carrying the "cel:" prefix. Evaluated against the Space under consideration, the change order being promoted, and that Space's Release; closing a ChangeSet binds Space and ChangeSet, with ChangeOrder and Release null. Compiled when the workflow is written. */ Expression: string; /** @description What a stage or Final gates on. Unique within a workflow, and refused if it shadows a built-in name. */ Name: string; }; ChangeWorkflowSpec: { /** @description The Attestations a stage, its releases, or Final may require. Declared once and named wherever they apply. */ AttestationPrerequisites?: components["schemas"]["ChangeWorkflowAttestationPrerequisite"][]; /** @description The checks a stage or Final may gate on beyond the built-in ones. Declared once and named wherever they apply. */ CustomPrerequisites?: components["schemas"]["ChangeWorkflowPrerequisite"][]; /** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. In a workflow with no stages, which governs a ChangeSet, what every Space the ChangeSet was opened in must satisfy for it to close. */ Final?: components["schemas"]["ChangeWorkflowFinalStage"]; /** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one. A workflow governing a ChangeOrder needs at least one; one governing a ChangeSet has none. */ Stages?: components["schemas"]["ChangeWorkflowStage"][]; }; ChangeWorkflowStage: { /** @description Identifies the stage within the workflow, and is what a promotion reports the change as having entered. Unique within a workflow. */ Name: string; /** @description The stage's entry gates, each naming a built-in check or one declared in CustomPrerequisites. Evaluated over every Space of the stage before this one; the first stage's are evaluated over the Space the ChangeOrder resides in, and refused for Invoke and fan-out ChangeOrders, whose change is in no Space before it is promoted. */ Prerequisites?: string[]; /** @description Gates on publishing a Release for a change order in one of the stage's Spaces, each naming one declared in AttestationPrerequisites. Evaluated over the Revisions the Release bundles. */ ReleasePrerequisites?: string[]; /** @description Selects the stage's Spaces: a where expression over Spaces, intersected with the change order's InScopeSpaceIDs. Nothing else is implied, so a workflow can be shared across components. Empty selects every Space in the change order's scope. */ WhereSpace?: string; }; /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Commands and Subscriptions are set by whoever manages it, not by the client. */ Channel: { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly BackingUnitID?: string; /** * Format: uuid * @description ChannelID uniquely identifies a channel. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChannelID?: string; /** @description How long a lease stays held without a poll renewing it. */ readonly ClaimTTLSeconds?: number; /** * Format: uuid * @description The token of the lease currently held. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly ClaimToken?: string; /** @description The commands the channel handles, by name, each with its signature. Set here, out of band; a connecting client verifies its handlers against them. */ Commands?: { [key: string]: components["schemas"]["CommandSignature"]; }; /** * @description Claimed while a client holds the lease, Unclaimed otherwise. * @enum {string} */ readonly Condition?: ChannelCondition; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description An optional set of gates that, if any is present, will block deletion. */ DeleteGates?: { [key: string]: boolean; }; /** @description Friendly name for the entity. */ DisplayName?: string; /** @description The type of entity. */ readonly EntityType?: string; /** * Format: int64 * @description The channel's bookmark into the event log. Set to the log's tail at creation, a clone's too; change it to replay or skip. */ EventPosition: number; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description The address the client last polled from. */ readonly IPAddress?: string; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** @description The last status message the client reported. */ readonly LastMessage?: string; /** * Format: date-time * @description The last time the client holding the lease polled. * @example 2006-01-02T15:04:05Z07:00 */ readonly LastSeenAt?: string; /** * Format: uuid * @description Unique identifier for an organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Permissions to access this Channel. Claim: acquire its lease and poll it. Use: run a command on it. */ Permissions?: components["schemas"]["Permissions"]; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: uuid * @description Unique identifier for a space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space this entity belongs to. (readonly) */ readonly SpaceSlug?: string; /** @description Filters over the event log. An event after EventPosition that matches any of them is delivered to the client. */ Subscriptions?: components["schemas"]["EventSubscription"][]; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: uuid * @description The Channel this Channel was cloned from, if any. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UpstreamChannelID?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; ChannelCreateOrUpdateResponse: { Channel?: components["schemas"]["Channel"]; Error?: components["schemas"]["ResponseError"]; }; /** @description ChannelLease is the lease a client holds on a Channel: its ClaimToken, carried by every poll and release, and the TTL in seconds a poll renews it for. */ ChannelLease: { /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ClaimToken: string; TTLSeconds: number; }; /** @description ChannelMessage is one item a Channel poll delivers. Kind says which of CommandRun and Event is set: CommandRun or EventLog. */ ChannelMessage: { CommandRun?: components["schemas"]["CommandRun"]; Event?: components["schemas"]["EventLog"]; /** @description CommandRun or EventLog: which of the two is set. */ Kind: string; }; /** @description ChannelPollRequest is one poll of a Channel under its lease. The response is the runs and events waiting for the client, up to MaxRuns runs, or nothing after TimeoutSeconds. */ ChannelPollRequest: { /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ClaimToken: string; MaxRuns?: number; TimeoutSeconds?: number; }; Clearance: components["schemas"]["ClearanceRequirement"][]; ClearanceRequirement: { /** @description The guard key this requirement is about */ Key?: string; /** @description Exists, In, NotIn, or DoesNotExist */ Operator?: string; /** @description The values In and NotIn compare against; unused by Exists and DoesNotExist */ Values?: string[]; }; Column: { /** @description Where the column value comes from. Exactly one field should be set, matching ColumnType. */ ColumnSource?: components["schemas"]["ColumnSource"]; /** @description The kind of value: MetadataAttribute, MetadataExpression, DataPath or DataExpression. */ ColumnType?: string; /** @description The expected data type of the column value: string, int, bool, uuid or time. */ DataType?: string; /** @description Group by this column. Priority is in column list order, after the View's GroupBy. */ GroupBy?: boolean; /** @description The display name for the column. */ Name: string; /** @description Sort by this column, ASC or DESC. Priority is in column list order, after the View's OrderBy. */ OrderByDirection?: string; }; ColumnSource: { DataExpression?: string; DataPath?: components["schemas"]["AttributeSelector"]; MetadataAttribute?: string; MetadataExpression?: string; }; CommandOption: { Choices?: string[]; DataType?: string; Description?: string; Example?: string; Name?: string; Required?: boolean; Schema?: components["schemas"]["Schema"]; }; /** @description CommandRun is one execution of a command on a Channel: the request, from the caller, and the outcome, from the channel's client. Create one at the Space, naming the command and optionally the Channel; without a Channel, the command is resolved to the one Channel in the Space that declares it. A Pending run waits for the client until its Deadline; a Delivered run has a fixed time to its outcome. */ CommandRun: { /** * Format: uuid * @description ChannelID is the Channel the run is delivered on. Optional on create: absent, the command is resolved within the Space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChannelID?: string; /** @description Command is the name of the command to run, as the Channel declares it. */ Command: string; /** * Format: uuid * @description CommandRunID uniquely identifies the run. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ CommandRunID?: string; /** * Format: date-time * @description CompletedAt is when the run reached a terminal status. * @example 2006-01-02T15:04:05Z07:00 */ readonly CompletedAt?: string; /** * Format: date-time * @description When the run was created, in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** * Format: uuid * @description CreatedBy is the user that asked for the run. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly CreatedBy?: string; /** * Format: date-time * @description Deadline is when a Pending run expires. Defaults to five minutes after creation; at most one hour. * @example 2006-01-02T15:04:05Z07:00 */ Deadline?: string; /** * Format: date-time * @description DeliveredAt is when the run was handed to the client. * @example 2006-01-02T15:04:05Z07:00 */ readonly DeliveredAt?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description ErrorMessage explains a Failed or Rejected run. */ readonly ErrorMessage?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** * Format: uuid * @description OrganizationID of the Space the run is in. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Params is the JSON object of inputs, keyed by the option names the Channel declares for the command. */ Params?: Record; /** @description Result is the JSON the client reported for a Completed run. */ readonly Result?: Record; /** * Format: uuid * @description SpaceID of the Space the run is in: the Channel's Space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space the run is in. */ readonly SpaceSlug?: string; /** @description Status is where the run is: Pending, Delivered, Completed, Failed, Rejected, Canceled, Expired or TimedOut. */ readonly Status?: string; /** * Format: date-time * @description TimeoutAt is when a Delivered run times out if the client has reported nothing. * @example 2006-01-02T15:04:05Z07:00 */ readonly TimeoutAt?: string; /** * Format: date-time * @description When the run last changed: created, delivered, returned to Pending, or closed, in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. A run is not updated by its callers, so they never send it. */ Version?: number; }; CommandRunRefusal: { /** @description The Channels in the Space that declare the command, when several do: name one as ChannelID. */ Channels?: components["schemas"]["DeclaredCommand"][]; /** @description The refusal as an error, as every error response carries one. */ Error?: components["schemas"]["ResponseError"]; /** @description Why the run was refused, for a person. */ Message?: string; /** @description Why the run was refused, as a code: CommandNotDeclared, CommandDeclaredByMany or ChannelDoesNotDeclare. */ Reason?: string; }; /** @description CommandRunResult is what a Channel's client reports for a run it executed: Completed with a Result, or Failed or Rejected with an ErrorMessage. */ CommandRunResult: { ErrorMessage?: string; Result?: Record; /** @description Completed, Failed or Rejected. */ Status: string; }; CommandSignature: { Attributes?: { [key: string]: unknown; }; Description?: string; Options?: components["schemas"]["CommandOption"][]; Returns?: components["schemas"]["Schema"]; }; /** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, whether one is required, and whether changes to the configuration of their Units have to be made in a ChangeSet or under a ChangeOrder. */ Component: { /** @description The set of ChangeWorkflows that can be used for promotions and releases of this component's Variants, and for ChangeSets opened on their Units: a ChangeOrder or ChangeSet is governed by one workflow, which every component it reaches has to allow. Changing it requires Manage permission on the component. (optional) */ AllowedChangeWorkflowIDs?: components["schemas"]["UUID"][]; /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly BackingUnitID?: string; /** * Format: uuid * @description Unique identifier for a component. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ComponentID?: string; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description An optional set of gates that, if any is present, will block deletion. */ DeleteGates?: { [key: string]: boolean; }; /** @description Friendly name for the entity. */ DisplayName?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** * Format: uuid * @description Unique identifier for an organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Permissions to access this component. */ Permissions?: components["schemas"]["Permissions"]; /** @description Whether a change to the configuration of a Unit in one of this component's Variants has to be made in a ChangeSet open on the Unit, or under a ChangeOrder: creating a Unit, writing its data, updating it with a restore, upgrade, merge or resolve, invoking functions on it, uploading, promoting and demoting. A write under a ChangeOrder is one that names it: a promotion or demotion of it, an upgrade, resolve or restore with change_order, or an invocation with change_order. A backing Unit refreshed from its entity and a resolve made by the resolve queue are exempt, and their Revisions belong to the ChangeSet open on the Unit, if any. Changing it requires Manage permission on the component. (optional) */ RequireChangeTracking?: boolean; /** @description Whether a ChangeWorkflow must be used for promotions and releases of this component's Variants, and by ChangeSets opened on their Units. Changing it requires Manage permission on the component. (optional) */ RequireChangeWorkflow?: boolean; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UpstreamComponentID?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; ComponentCreateOrUpdateResponse: { Component?: components["schemas"]["Component"]; Error?: components["schemas"]["ResponseError"]; }; ConfigDiff: { /** @description One entry per resource that differs, in the To configuration's order; resources only on the From side follow where they were */ Resources?: components["schemas"]["ResourceDiff"][] | null; }; CreateUserKeyRequest: { Description?: string; PublicJWK?: unknown; }; CreateUserTokenRequest: { Description?: string; /** * Format: date-time * @example 2006-01-02T15:04:05Z07:00 */ ExpiresAt?: string; }; /** @description DeclaredCommand is a command a Channel declares: its name and signature, and the Channel and Space that declare it. A command declared by two Channels in a Space is listed twice, and a run of it has to name one. */ DeclaredCommand: { /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChannelID?: string; ChannelSlug?: string; Command?: string; Signature?: components["schemas"]["CommandSignature"]; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; SpaceSlug?: string; }; /** @description Response for successful delete operation */ DeleteResponse: { /** @description Error information if the delete operation failed. */ Error?: components["schemas"]["ResponseError"]; /** @description Response message. */ Message?: string; }; DemoteRequest: { /** @description Recorded on each restored Revision. Defaults to naming the ChangeOrder undone. */ ChangeDescription?: string; /** * Format: uuid * @description The ChangeOrder to undo. It must have an AbortedReason. Which Units are restored is the Units its start Tag marks. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeOrderID: string; /** * Format: uuid * @description An existing open ChangeSet to record every write in. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeSetID?: string; /** @description The Plan a previous dry run returned. If the plan now differs, nothing is written and the request fails with 412. */ ExpectedPlan?: string; /** * Format: uuid * @description A Filter over Spaces narrowing the Spaces to demote. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceFilterID?: string; /** @description A Stage of the ChangeOrder's ChangeWorkflow whose Spaces to demote. */ TargetStage?: string; /** @description A where expression narrowing the Spaces to demote. Without any selector, every Space the ChangeOrder marked is demoted. */ WhereSpace?: string; }; DemoteResult: { /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeOrderID?: string; /** @description True when nothing was written. */ DryRun?: boolean; /** @description Digest of the planned actions. Send it as ExpectedPlan to apply exactly this plan. */ Plan?: string; /** @description Downstream Spaces first. */ Spaces?: components["schemas"]["DemoteSpaceResult"][]; }; DemoteSpaceResult: { /** @description Demote, Unchanged, Skipped, or Failed. */ Action?: string; Error?: components["schemas"]["ResponseError"]; /** @description For Skipped: NotMarked, when the change order marks no Unit of the Space. */ Reason?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; SpaceSlug?: string; Stage?: string; /** @description The Units the ChangeOrder's start Tag marks in the Space. */ Units?: components["schemas"]["DemoteUnitResult"][]; }; DemoteUnitResult: { /** @description Restore, Mark, or Unchanged. */ Action?: string; /** @description The same change path by path, with the values on both sides. Returned when include names Diff. */ Diff?: components["schemas"]["ConfigDiff"]; /** * Format: int64 * @description The first Revision after the change that restoring drops, when the head had moved past where the change arrived. */ DropsFromRevisionNum?: number; /** * Format: int64 * @description The last Revision that restoring drops. */ DropsToRevisionNum?: number; /** * Format: int64 * @description The Revision the change arrived at. */ EndRevisionNum?: number; Error?: components["schemas"]["ResponseError"]; /** @description What the restore changed, or on a dry run would change. Returned when include names Mutations. */ Mutations?: components["schemas"]["ResourceMutationList"]; /** Format: int64 */ PreviousHeadMutationNum?: number; /** Format: int64 */ PreviousHeadRevisionNum?: number; /** @description For Unchanged: AlreadyRestored. */ Reason?: string; Slug?: string; /** * Format: int64 * @description The Revision the change started from, which the Unit is restored to. */ StartRevisionNum?: number; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; }; DiffRequest: { /** @description The configuration the diff runs from */ From?: components["schemas"]["DiffSide"]; /** @description The configuration the diff runs to */ To?: components["schemas"]["DiffSide"]; }; DiffResult: { /** @description What changed from the From configuration to the To configuration */ Diff?: components["schemas"]["ConfigDiff"]; /** @description What the From side resolved to */ From?: components["schemas"]["DiffSideResult"]; /** @description What the To side resolved to */ To?: components["schemas"]["DiffSideResult"]; }; DiffSide: { /** @description Configuration given inline, instead of a Unit's */ Data?: string; /** @description The Unit's Revision, in the syntax unit update --restore takes; its head when omitted */ Revision?: string; /** @description The toolchain of inline Data; defaults to the other side's */ ToolchainType?: string; /** * Format: uuid * @description The Unit whose configuration this side is. Omitted for inline Data. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; }; DiffSideResult: { /** * Format: int64 * @description The Revision the side resolved to, for a Unit side */ RevisionNum?: number; /** * Format: uuid * @description The Space of the Unit, for a Unit side * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** * Format: uuid * @description The Unit, for a Unit side * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; }; EntityDocument: { /** @description The entity's document, in YAML: the fields a write can set, with the entities it refers to named rather than identified by ID. */ Document: string; /** * Format: int64 * @description The entity's Version when the document was rendered, which an edit of it sends back. */ Version: number; }; EntityDocumentEdit: { /** @description The document as it was read. */ Base: string; /** @description The document as it was edited. */ Document: string; /** * Format: int64 * @description The Version that came with the document read. The edit is refused if the entity's Version has changed since. */ Version: number; }; ErrorItem: { /** @description A clear explanation of what went wrong */ Description?: string; /** @description The name of the field, resource, or entity that the error relates to */ Item?: string; }; ErrorMetadata: { /** @description Optional ID of the entity this error relates to */ EntityID?: string; /** @description Optional slug of the entity this error relates to */ EntitySlug?: string; /** @description Optional type of the entity this error relates to */ EntityType?: string; /** @description Collection of error details */ Items?: components["schemas"]["ErrorItem"][]; }; EventLog: { /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** Format: int64 */ CursorID?: number; /** @description The type of entity. */ readonly EntityType?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ EventLogID?: string; EventType?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; Payload?: unknown; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SubjectEntityID?: string; SubjectEntityType?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TargetID?: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; EventSubscription: { /** @description The event types to deliver, such as release.published. Empty means all. */ EventTypes?: string[]; /** * Format: uuid * @description Restricts delivery to events about one Space. It has to name a Space when the Channel is written; a Space deleted later leaves the subscription matching nothing. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** * Format: uuid * @description Restricts delivery to events about one Target. It has to name a Target when the Channel is written; a Target deleted later leaves the subscription matching nothing. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TargetID?: string; }; /** @description Attestation with additional related entities expanded based on the request's include parameter. */ ExtendedAttestation: { /** @description The Attestation. */ Attestation?: components["schemas"]["Attestation"]; Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; /** @description The Space the Attestation belongs to. */ Space?: components["schemas"]["Space"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedAttribute: { Attribute?: components["schemas"]["Attribute"]; Error?: components["schemas"]["ResponseError"]; Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; Space?: components["schemas"]["Space"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedChangeOrder: { ChangeOrder?: components["schemas"]["ChangeOrder"]; EndTag?: components["schemas"]["Tag"]; Error?: components["schemas"]["ResponseError"]; Invocation?: components["schemas"]["Invocation"]; Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; ReleaseTag?: components["schemas"]["Tag"]; RestoreTag?: components["schemas"]["Tag"]; Space?: components["schemas"]["Space"]; SpaceFilter?: components["schemas"]["Filter"]; StartTag?: components["schemas"]["Tag"]; UnitFilter?: components["schemas"]["Filter"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedChangeSet: { ChangeSet?: components["schemas"]["ChangeSet"]; EndTag?: components["schemas"]["Tag"]; Error?: components["schemas"]["ResponseError"]; Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; Space?: components["schemas"]["Space"]; StartTag?: components["schemas"]["Tag"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedChangeWorkflow: { ChangeWorkflow?: components["schemas"]["ChangeWorkflow"]; Error?: components["schemas"]["ResponseError"]; Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; Space?: components["schemas"]["Space"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedChannel: { Channel?: components["schemas"]["Channel"]; Error?: components["schemas"]["ResponseError"]; Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; Space?: components["schemas"]["Space"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; /** @description CommandRun with additional related entities expanded based on the request's include parameter. */ ExtendedCommandRun: { /** @description The Channel the run is delivered on. */ Channel?: components["schemas"]["Channel"]; /** @description The CommandRun. */ CommandRun?: components["schemas"]["CommandRun"]; Organization?: components["schemas"]["Organization"]; /** @description The Space the run is in: its Channel's. */ Space?: components["schemas"]["Space"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedComponent: { AllowedChangeWorkflows?: components["schemas"]["ChangeWorkflow"][]; Component?: components["schemas"]["Component"]; Error?: components["schemas"]["ResponseError"]; Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedFilter: { Error?: components["schemas"]["ResponseError"]; Filter?: components["schemas"]["Filter"]; FromSpace?: components["schemas"]["Space"]; Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; Space?: components["schemas"]["Space"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; /** @description Group with additional related entities expanded based on the request's include parameter. */ ExtendedGroup: { Error?: components["schemas"]["ResponseError"]; /** @description The Group. */ Group?: components["schemas"]["Group"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedInvocation: { Channel?: components["schemas"]["Channel"]; Error?: components["schemas"]["ResponseError"]; Invocation?: components["schemas"]["Invocation"]; Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; Space?: components["schemas"]["Space"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedLink: { Error?: components["schemas"]["ResponseError"]; FromUnit?: components["schemas"]["Unit"]; Link?: components["schemas"]["Link"]; Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; Space?: components["schemas"]["Space"]; ToSpace?: components["schemas"]["Space"]; ToUnit?: components["schemas"]["Unit"]; TransformInvocation?: components["schemas"]["Invocation"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedMutation: { Error?: components["schemas"]["ResponseError"]; Invocation?: components["schemas"]["Invocation"]; Link?: components["schemas"]["Link"]; MergeSource?: components["schemas"]["Unit"]; Mutation?: components["schemas"]["Mutation"]; Organization?: components["schemas"]["Organization"]; Revision?: components["schemas"]["Revision"]; Space?: components["schemas"]["Space"]; Trigger?: components["schemas"]["Trigger"]; Unit?: components["schemas"]["Unit"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedOrganization: { Error?: components["schemas"]["ResponseError"]; Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedOrganizationMember: { Error?: components["schemas"]["ResponseError"]; OrganizationMember?: components["schemas"]["OrganizationMember"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedPermissions: { Permissions?: components["schemas"]["Permissions"]; Subjects?: components["schemas"]["ExtendedSubjects"]; }; /** @description Release with additional related entities expanded based on the request's include parameter. */ ExtendedRelease: { /** @description The ChangeOrder the Release was published for, if any. Expanded when requested via the include parameter. */ ChangeOrder?: components["schemas"]["ChangeOrder"]; Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; /** @description The Release. */ Release?: components["schemas"]["Release"]; /** @description The Space the Release belongs to. */ Space?: components["schemas"]["Space"]; /** @description The Tag the bundled Units were pinned to, if any. Expanded when requested via the include parameter. */ Tag?: components["schemas"]["Tag"]; /** @description The Target the Release was published for. Expanded when requested via the include parameter. */ Target?: components["schemas"]["Target"]; /** @description The User who published the Release. Expanded when requested via the include parameter. */ User?: components["schemas"]["User"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedResource: { Error?: components["schemas"]["ResponseError"]; Organization?: components["schemas"]["Organization"]; /** * Format: base64 * @description The resource's configuration in its original toolchain-native form, present only when requested with the raw_data query parameter. */ RawData?: string; Resource?: components["schemas"]["Resource"]; Space?: components["schemas"]["Space"]; Target?: components["schemas"]["Target"]; Unit?: components["schemas"]["Unit"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedReviewComment: { ChangeOrder?: components["schemas"]["ChangeOrder"]; Error?: components["schemas"]["ResponseError"]; Organization?: components["schemas"]["Organization"]; ReviewComment?: components["schemas"]["ReviewComment"]; Revision?: components["schemas"]["Revision"]; Space?: components["schemas"]["Space"]; Unit?: components["schemas"]["Unit"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedRevision: { Attestations?: components["schemas"]["Attestation"][]; ChangeOrders?: components["schemas"]["ChangeOrder"][]; ChangeSet?: components["schemas"]["ChangeSet"]; Error?: components["schemas"]["ResponseError"]; Organization?: components["schemas"]["Organization"]; Releases?: components["schemas"]["Release"][]; Revision?: components["schemas"]["Revision"]; Space?: components["schemas"]["Space"]; Tags?: components["schemas"]["Tag"][]; Unit?: components["schemas"]["Unit"]; User?: components["schemas"]["User"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedServiceAccount: { Error?: components["schemas"]["ResponseError"]; Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; ServiceAccount?: components["schemas"]["ServiceAccount"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedSpace: { AttributeFilter?: components["schemas"]["Filter"]; Attributes?: components["schemas"]["Attribute"][]; Component?: components["schemas"]["Component"]; Error?: components["schemas"]["ResponseError"]; /** Format: int64 */ GatedUnitCount?: number; Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; ReleaseTarget?: components["schemas"]["Target"]; Space?: components["schemas"]["Space"]; /** Format: int64 */ TotalAttributeCount?: number; /** Format: int64 */ TotalChangeOrderCount?: number; /** Format: int64 */ TotalChangeSetCount?: number; /** Format: int64 */ TotalChangeWorkflowCount?: number; /** Format: int64 */ TotalChannelCount?: number; /** Format: int64 */ TotalFilterCount?: number; /** Format: int64 */ TotalInvocationCount?: number; /** Format: int64 */ TotalLinkCount?: number; /** Format: int64 */ TotalReleaseCount?: number; /** Format: int64 */ TotalTagCount?: number; /** Format: int64 */ TotalTargetCount?: number; /** Format: int64 */ TotalUnitCount?: number; /** Format: int64 */ TotalViewCount?: number; TriggerCountByEventType?: { [key: string]: number; } | null; TriggerFilter?: components["schemas"]["Filter"]; Triggers?: components["schemas"]["Trigger"][]; /** Format: int64 */ UnlinkedUnitCount?: number; /** Format: int64 */ UnreleasedUnitCount?: number; /** Format: int64 */ UpgradableUnitCount?: number; UpstreamSpace?: components["schemas"]["Space"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; /** Format: int64 */ WarnedUnitCount?: number; }; ExtendedSubjects: { Groups?: { [key: string]: components["schemas"]["Group"][]; }; ServiceAccounts?: { [key: string]: components["schemas"]["ServiceAccount"][]; }; Users?: { [key: string]: components["schemas"]["User"][]; }; }; ExtendedTag: { ChangeSet?: components["schemas"]["ChangeSet"]; Error?: components["schemas"]["ResponseError"]; Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; Space?: components["schemas"]["Space"]; Tag?: components["schemas"]["Tag"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedTarget: { Error?: components["schemas"]["ResponseError"]; Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; Space?: components["schemas"]["Space"]; Target?: components["schemas"]["Target"]; TriggerFilter?: components["schemas"]["Filter"]; Triggers?: components["schemas"]["Trigger"][]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedTrigger: { Channel?: components["schemas"]["Channel"]; Error?: components["schemas"]["ResponseError"]; Invocation?: components["schemas"]["Invocation"]; Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; Space?: components["schemas"]["Space"]; Trigger?: components["schemas"]["Trigger"]; UnitFilter?: components["schemas"]["Filter"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; /** @description Unit with capability to extend additional related entities. */ ExtendedUnit: { ChangeSet?: components["schemas"]["ChangeSet"]; Error?: components["schemas"]["ResponseError"]; FromLink?: components["schemas"]["Link"][]; /** @description The Unit's current HeadMutation */ HeadMutation?: components["schemas"]["Mutation"]; /** @description The Unit's current HeadRevision */ HeadRevision?: components["schemas"]["Revision"]; /** @description The Unit's current LastReleasedRevision */ LastReleasedRevision?: components["schemas"]["Revision"]; /** @description The Organization the Unit belongs to. */ Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; /** @description The Space the Unit belongs to. */ Space?: components["schemas"]["Space"]; /** @description The Target a Release of the Unit's Space publishes the Unit for: the Space's release Target, unless the Unit is Unreleasable. Use include=TargetID to expand it. */ Target?: components["schemas"]["Target"]; /** @description The requested Unit of the operation. */ Unit?: components["schemas"]["Unit"]; /** @description If this Unit is a clone, the Upstream Space the UpstreamUnit belongs to. Optional. */ UpstreamSpace?: components["schemas"]["Space"]; /** @description If this Unit is a clone, the Upstream Unit it was cloned from. Optional. */ UpstreamUnit?: components["schemas"]["Unit"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedUser: { Error?: components["schemas"]["ResponseError"]; User?: components["schemas"]["User"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; ExtendedUserKey: { Error?: components["schemas"]["ResponseError"]; UserKey?: components["schemas"]["UserKey"]; }; ExtendedUserToken: { Error?: components["schemas"]["ResponseError"]; UserToken?: components["schemas"]["UserToken"]; }; ExtendedView: { Error?: components["schemas"]["ResponseError"]; Filter?: components["schemas"]["Filter"]; Organization?: components["schemas"]["Organization"]; Permissions?: components["schemas"]["ExtendedPermissions"]; Space?: components["schemas"]["Space"]; View?: components["schemas"]["View"]; /** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */ ViewColumns?: components["schemas"]["ViewColumn"][]; }; /** @description Defines an entity filter. */ Filter: { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly BackingUnitID?: string; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description An optional set of gates that, if any is present, will block deletion. */ DeleteGates?: { [key: string]: boolean; }; /** @description Friendly name for the entity. */ DisplayName?: string; /** @description The type of entity. */ readonly EntityType?: string; /** * Format: uuid * @description FilterID uniquely identifies a filter within the system. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ FilterID?: string; /** @description From specifies the type of entity (Unit, Space, etc.) to filter, in PascalCase. Required on create, and immutable. */ From: string; /** * Format: uuid * @description FromSpaceID optionally specifies a Space to filter within. Only relevant for spaced entity spaces. (optional) * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ FromSpaceID?: string; /** @description SHA256 hash of the filter parameters encoded as hexadecimal. (readonly) */ readonly Hash?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; IncludeHidden?: string; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** * Format: uuid * @description Unique identifier for an organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Permissions to access this filter. */ Permissions?: components["schemas"]["Permissions"]; /** @description Resource type to match for the desired ToolchainType, for example apps/v1/Deployment. Valid only for Units. (optional) */ ResourceType?: string; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: uuid * @description Unique identifier for a space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space this entity belongs to. (readonly) */ readonly SpaceSlug?: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UpstreamFilterID?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; /** @description Where specifices the where filter expression in the syntax used in list and search API query parameters. (optional) */ Where?: string; /** @description WhereData specifies a filter expression for configuration data. Valid only for Units. (optional) */ WhereData?: string; }; FilterCreateOrUpdateResponse: { Error?: components["schemas"]["ResponseError"]; Filter?: components["schemas"]["Filter"]; }; FunctionArgument: { Evaluator?: string; ParameterName?: string; Value?: string | number | boolean; }; FunctionInvocation: { /** @description Function arguments */ Arguments?: components["schemas"]["FunctionArgument"][] | null; /** @description Function name */ FunctionName?: string; /** @description Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */ Params?: { [key: string]: unknown; }; /** @description Per-invocation resource filter. AND-combined with the request-level WhereResource. Same path syntax as the request-level field (see ParseAndValidateWhereResource). */ WhereResource?: string; }; FunctionInvocationList: components["schemas"]["FunctionInvocation"][] | null; /** @description FunctionInvocationsRequest represents a request to invoke a list of functions on the configuration data of the matching Units or Revision. */ FunctionInvocationsRequest: { /** @description ChangeDescription is a description of the change being made, if any. */ ChangeDescription?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChannelID?: string; FunctionInvocations?: components["schemas"]["FunctionInvocationList"]; /** @description Invocations is a list of Invocation IDs to execute. The invocations must be within the same Organization. Invocations will be executed after the FunctionInvocations list. Functions are grouped by executor (built-in or Channel) and executed in phases: general mutating functions first, then final mutating functions (like ensure-context), then validating functions. Functions that don't match the unit's toolchain type are ignored. */ Invocations?: components["schemas"]["UUID"][]; /** @description NumFilters is the number of validating functions from the FunctionInvocations to treat as filters for the remaining functions in the list. In the case that the validation function does not pass, stop and don't execute the remaining functions, but don't report an error. */ NumFilters?: number; ParameterizedInvocations?: components["schemas"]["ParameterizedInvocationRef"][]; /** @description StopOnError indicates whether to stop executing functions from the FunctionInvocations list on the first error, or to execute all of the functions and return all of the errors. Note that this applies to each Unit or Revision individually rather than all of the entities on which the functions are being invoked. */ StopOnError?: boolean; /** @description ToolchainType specifies the type of toolchain for these function invocations. This determines which configuration formats the functions can process. It must match the ToolchainType of the Units. */ ToolchainType?: string; /** @description Triggers is a list of Trigger IDs to execute. The triggers must be within the same Organization. Triggers will be executed after the FunctionInvocations list. Functions are grouped by executor (built-in or Channel) and executed in phases: general mutating functions first, then final mutating functions (like ensure-context), then validating functions. Functions that don't match the unit's toolchain type are ignored. */ Triggers?: components["schemas"]["UUID"][]; /** * @deprecated * @description Deprecated: use UpdateValidationResults, which this means the same thing as. Setting either has the same effect. */ UpdateApplyGates?: boolean; /** @description UpdateValidationResults indicates that the results of Trigger execution should be used to update ValidationErrors and ValidationWarnings on the affected Units, and the ValidationResults that say why each gate failed. Requires Triggers to be specified. */ UpdateValidationResults?: boolean; /** @description WhereResource restricts which resources functions operate on using ConfigHub metadata path expressions (ConfigHub.ResourceName, ConfigHub.ResourceNameWithoutScope, ConfigHub.ResourceType, ConfigHub.ResourceCategory). */ WhereResource?: string; }; FunctionInvocationsResponse: { /** @description The resulting configuration data; present only when the invocation changed it */ ConfigData?: string; /** @description Mutation conflicts produced by writing the invocation's result, such as a path a guard withheld. Empty when nothing was withheld. */ Conflicts?: components["schemas"]["MutationConflictList"]; /** @description SHA256 of the resulting configuration data, whether or not ConfigData is present */ DataHash?: string; /** @description What the invocation changed, or on a dry run would change, path by path with the values on both sides; returned when include names Diff. */ Diff?: components["schemas"]["ConfigDiff"]; /** @description Error information if the function invocation failed */ Error?: components["schemas"]["ResponseError"]; /** @description Functions produced new mutations (of type other than None) */ HasNewMutations?: boolean; /** @description List of mutations in the same order as the resources in ConfigData */ Mutations?: components["schemas"]["ResourceMutationList"]; /** @description List of function invocation indices that resulted in mutations */ Mutators?: number[] | null; /** * Format: uuid * @description ID of the Unit's Organization * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Map of output types to their corresponding output data as embedded JSON */ Outputs?: { [key: string]: string; } | null; /** * Format: uuid * @description ID of the Revision the configuration data is associated with * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ RevisionID?: string; /** * Format: uuid * @description ID of the Unit's Space * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Unit's Space */ SpaceSlug?: string; /** @description True if all functions executed successfully */ Success?: boolean; /** * Format: uuid * @description ID of the Unit's Target; optional * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TargetID?: string; /** * Format: uuid * @description ID of the Unit the configuration data is associated with * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; /** @description Slug of the Unit */ UnitSlug?: string; }; FunctionOutput: { /** @description Description of the result */ Description?: string; /** @description Data type of the JSON embedded in the output */ OutputType?: string; /** @description Name of the result in kabob-case */ ResultName?: string; /** @description JSON schema of the output type */ Schema?: components["schemas"]["Schema"]; }; FunctionParameter: { /** @description Data type of the parameter */ DataType?: string; /** @description The value the function uses when the argument is omitted, when that is one fixed value. It is a string whatever DataType is, as an argument is passed: an int is "10" and a bool "false", to convert by DataType. A default that depends on the configuration or its context is described in Description instead. */ DefaultValue?: string; /** @description Description of the parameter */ Description?: string; /** @description List of valid enum values; applies to enum parameters */ EnumValues?: string[]; /** @description Example value */ Example?: string; /** @description Maximum allowed value; applies to int parameters */ Max?: number | null; /** @description Minimum allowed value; applies to int parameters */ Min?: number | null; /** @description Name of the parameter in kabob-case */ ParameterName?: string; /** @description Regular expression matching valid values; applies to string parameters */ Regexp?: string; /** @description Whether the parameter is required */ Required?: boolean; /** @description JSON schema (for embedded JSON values) */ Schema?: components["schemas"]["Schema"]; }; FunctionSignature: { /** @description Resource types the function applies to; * if all */ AffectedResourceTypes?: string[]; /** @description Attribute corresponding to registered paths, if a path visitor; optional */ AttributeName?: string; /** @description Description of the function */ Description?: string; /** @description Name of the function in kabob-case */ FunctionName?: string; /** @description Implementation pattern of the function: PathVisitor or Custom */ FunctionType?: string; /** @description Does not call other systems */ Hermetic?: boolean; /** @description Will return the same result if invoked again */ Idempotent?: boolean; /** @description Parts of the FunctionContext passed only to the functions that read them: Conflicts, the Unit's outstanding merge conflicts, and LinkFindings, what the resolves of its Links could not do */ Include?: string[]; /** @description May change the configuration data */ Mutating?: boolean; /** @description The function reads OtherData under any key its caller passes, as a general-purpose function such as vet-cel does, whose expression names the keys: such as the Units a Trigger's OtherUnitSelections pass. Besides those in OtherDataExpected */ OtherDataAnyKey?: boolean; /** @description The keys of the OtherData the function reads, if any: a revision specifier such as LastReleasedRevisionNum, which a caller that names no revision is passed, or a key such as schema under which the caller passes another Unit. Letters, digits, '-' and '_'. */ OtherDataExpected?: string[]; /** @description Output description */ OutputInfo?: components["schemas"]["FunctionOutput"]; /** @description Function parameters, in order */ Parameters?: components["schemas"]["FunctionParameter"][] | null; /** @description Means the same thing run against a different Unit, so a merge may re-execute a stored invocation of it against a downstream variant */ Replayable?: boolean; /** @description Number of required parameters */ RequiredParameters?: number; /** @description Toolchain under which the function is registered */ ToolchainType?: string; /** @description Returns a ValidationResult judging the resources selected, passing when none is selected unless it judges something it declares in Include */ Validating?: boolean; /** @description Last parameter may be repeated */ VarArgs?: boolean; }; /** @description A Group of Users, a subject in an entity's Permissions. Groups and their membership are managed in the identity provider, and like Users are not scoped to an Organization; a Group is provisioned when a User in it logs in. Bot Users are the exception: they are added to a Group through the API. */ Group: { /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description Friendly name for the entity. */ DisplayName?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description Unique identifier for the External Identity Provider record matching this Group. */ readonly ExternalID?: string; /** * Format: uuid * @description Unique identifier for a Group. (readonly) * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ GroupID?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; GuardDelta: { /** @description The path whose guards changed; empty for the resource as a whole */ Path?: string; /** @description Inherited guard keys removed */ Remove?: string[]; /** @description Guard keys removed that stay with the Unit, not inherited; a restore taking out guards the restored Revision did not have */ RemoveLocal?: string[]; /** @description Inherited guard keys added or changed, with their new values */ Set?: { [key: string]: string; }; /** @description Guard keys added or changed as guards that stay with the Unit, with their new values; a restore putting back the Unit's own guards */ SetLocal?: { [key: string]: string; }; }; GuardStamp: { [key: string]: string; }; /** @description Defines a stored, reusable call to one or more functions, executed in the order they are listed. */ Invocation: { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly BackingUnitID?: string; /** * Format: uuid * @description Unique identifier for a Channel whose client executes the functions specified by the Invocation. If it is not specified, the builtin function executor is used. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChannelID?: string; /** @description Classes of guarded reason this Invocation's functions are cleared for; combined by union with the clearance of the Trigger or API call that runs it */ Clearance?: components["schemas"]["Clearance"]; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description An optional set of gates that, if any is present, will block deletion. */ DeleteGates?: { [key: string]: boolean; }; /** @description Friendly name for the entity. */ DisplayName?: string; /** @description The type of entity. */ readonly EntityType?: string; FunctionInvocations: components["schemas"]["FunctionInvocationList"]; /** @description Guards to record on the paths this Invocation's functions write, so a later operation must be cleared for them; combined with the guards of a Trigger running it, the Trigger's winning per key. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). Clearance must cover them. */ Guards?: components["schemas"]["GuardStamp"]; /** @description SHA256 hash of the functions and their arguments encoded as hexadecimal. */ readonly Hash?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** * Format: uuid * @description InvocationID uniquely identifies a invocation within the system. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ InvocationID?: string; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** * Format: uuid * @description Unique identifier for an organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Other Units to pass to the invocation's functions as OtherData, by the key the functions read each under, such as policy for vet-validating-admission-policy. Each Unit's head data is passed, and a change to it re-runs the triggers running the invocation on the Units they apply to. A Unit named here cannot be deleted while the invocation names it. Naming a Unit requires Use permission on it. A trigger that runs the invocation takes them from here. */ OtherUnitIDs?: { [key: string]: components["schemas"]["UUID"]; }; Parameters?: components["schemas"]["FunctionParameter"][]; /** @description Permissions to access this invocation. */ Permissions?: components["schemas"]["Permissions"]; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: uuid * @description Unique identifier for a space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space this entity belongs to. (readonly) */ readonly SpaceSlug?: string; /** * @description ToolchainType specifies the type of toolchain this invocation works with. * This determines which configuration formats the invocation can process. * @example Kubernetes/YAML */ ToolchainType: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UpstreamInvocationID?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; InvocationCreateOrUpdateResponse: { Error?: components["schemas"]["ResponseError"]; Invocation?: components["schemas"]["Invocation"]; }; Issue: { /** @description Identifier for the kind of issue found, such as a number, alphanumeric code, or policy/rule name. Use especially with validation functions that check multiple policies/rules. */ Identifier?: string; /** @description A more detailed and specific explanation of the issue found */ Message?: string; }; IssuedUserToken: { Token?: string; UserToken?: components["schemas"]["UserToken"]; }; /** * @description Link connects two config Units in a dependency / producer-consumer relationship. * A Link indicates that selected config data from the upstream To Unit (the producer) * should be propagated to the downstream From Unit (the consumer). * Links must be created in the same Space as the From Unit. */ Link: { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** @description Automatically update the downstream Unit when the upstream Unit changes. A Link created without an UpdateType is a NeedsProvides Link with AutoUpdate set, which is what such a Link has always done. */ AutoUpdate?: boolean; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly BackingUnitID?: string; /** @description The needs/provides attribute bindings resolution found for this Link and keeps up to date: one for each needed attribute of the downstream Unit it matched with an attribute the upstream Unit provides. Set by the server, and rebuilt by each resolve. A needed attribute that a binding in ManualBindings names is not matched again. */ readonly Bindings?: components["schemas"]["BindingList"]; /** @description Classes of guarded reason this Link's resolve is cleared for, whatever its UpdateType and whether the resolve is queued or requested. A path whose guards it does not cover is not written, and the withheld change is reported as a conflict. This is what lets one Link maintain a field another is guarded out of: a TransformPaths Link cleared for the guard {"Link":"TransformPaths"} keeps writing the value it guards, while an UpgradeUnit Link cleared for nothing leaves it alone. A stored clearance gets no default: a Link that should write over an Override guard needs Override in its Clearance. */ Clearance?: components["schemas"]["Clearance"]; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description An optional set of gates that, if any is present, will block deletion. */ DeleteGates?: { [key: string]: boolean; }; /** @description Friendly name for the entity. */ DisplayName?: string; /** * Format: int64 * @description The sequence number of the revision of the downstream unit created by the last merge. */ DownstreamLastMergedRevisionNum?: number; /** @description Values to write to the downstream Unit when resolving a TransformPaths Link. Each entry evaluates Expression (a Go template or CEL expression, per Evaluator) with the named upstream values (UpstreamPaths and UpstreamGetters) and Space/Unit metadata in scope, coerces the result to DataType, and writes it via set-attributes. Only valid when UpdateType is TransformPaths. */ DownstreamPaths?: components["schemas"]["PathExpression"][]; /** @description Mutating function invocations to run on the downstream Unit. String arguments are template-expanded using the upstream values listed in Parameters (plus Space/Unit metadata) in scope. Each function must be mutating. Functions served on a Channel are not supported. Only valid when UpdateType is TransformPaths. */ DownstreamSetters?: components["schemas"]["ParameterizedFunction"][]; /** @description The type of entity. */ readonly EntityType?: string; /** * Format: uuid * @description Unique identifier of the downstream (consumer) Unit. Links must be in the same space as the source unit. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ FromUnitID: string; /** @description Guards to record on the paths this link's resolve writes, naming the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. {"Link":""}, with a Clearance admitting it, holds what the link maintains against merges and other writes while the link keeps writing it. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard), except that deleting the link takes back the guards it set on the paths it last wrote, and updating it takes back those it no longer states. Refused on UpgradeUnit and MergeUnits links, whose guards arrive by propagation from upstream. */ Guards?: components["schemas"]["GuardStamp"]; /** @description SHA256 hash of the resolution-relevant Link fields, used to detect changes that require re-resolution. */ readonly Hash?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** * Format: uuid * @description Unique identifier for a Link. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ LinkID?: string; /** @description The needs/provides attribute bindings stated for this Link, which resolution uses as they are. Each Binding maps one needed attribute in the downstream Unit to one provided attribute in the upstream Unit. An Insert Link has exactly one, which identifies only the needed attribute (NeededResource and NeededPath) and whose DataType selects how the upstream Unit is inserted: string, the default, inserts it verbatim as text; the downstream Unit's own configuration format inserts it as configuration data. */ ManualBindings?: components["schemas"]["BindingList"]; /** @description Enables the subtraction (override-preservation) step of the merge performed when resolving this Link. When false (the default), the source patch is applied without subtraction, and the downstream Unit's local differences are preserved by its guards -- an Override guard on each local override -- widened by WhereMutation if it is set. When true, the merge additionally subtracts the downstream Unit's local differences from the source patch; the guards still hold. Only meaningful for UpgradeUnit and MergeUnits Links. */ MergeEnableSubtraction?: boolean; /** * Format: uuid * @description Unique identifier for an organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Permissions to access this link. */ Permissions?: components["schemas"]["Permissions"]; /** * @deprecated * @description Deprecated: use Guards, as {"Link":""}, with a Clearance admitting it. Setting it records that guard and clearance on the Link instead, so the paths its resolve writes hold what it wrote against merges and other writes, and the Link keeps maintaining them; it is not stored, and reads false. Refused on UpgradeUnit and MergeUnits Links. */ Protect?: boolean; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: uuid * @description Unique identifier for a space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space this entity belongs to. (readonly) */ readonly SpaceSlug?: string; /** @description Merge this Link's range as one rebased diff in one Revision instead of walking it. By default a resolve replays the source's recorded function invocations against this Unit where they can be re-executed, and records each source Revision that has an effect as a Revision of its own. Only meaningful for UpgradeUnit and MergeUnits Links, which are the ones with a range to walk. */ Squash?: boolean; /** @description The upstream Unit has finished a change this Link has not taken: its head Revision is past UpstreamLastMergedRevisionNum and it is not partway through a ChangeSet, whose Revisions are a prefix of a change nobody can take yet. Most useful on a Link with AutoUpdate false, which is otherwise unchanged by anything its upstream does; on an AutoUpdate Link it is transient, and stays set when a resolve fails. */ readonly Stale?: boolean; /** * Format: uuid * @description Unique identifier of the Space of the upstream Unit. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ToSpaceID?: string; /** * Format: uuid * @description Unique identifier of the upstream (producer) Unit. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ToUnitID: string; /** * Format: uuid * @description Identifier of an Invocation whose function is executed on the upstream Unit's data before the result is inserted into or upserted into the downstream Unit. Only valid when UpdateType is Insert or Upsert. The Invocation's ToolchainType must match the upstream Unit's ToolchainType, the function must be non-mutating, and its OutputType must be YAML. For Upsert the output must also match the downstream Unit's toolchain, which currently limits it to Kubernetes/YAML. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TransformInvocationID?: string; /** @description The ConfigHub operation performed using this Link. Valid values are NeedsProvides, MergeUnits, UpgradeUnit, None, Insert, Upsert, and TransformPaths. A create that omits it gets NeedsProvides with AutoUpdate set, which is what omitting it has always produced. UpgradeUnit is like MergeUnits but also keeps the downstream unit's UpstreamRevision fields in sync. Upsert pulls one or more resources produced by the upstream Unit (optionally through a TransformInvocation) and inserts or replaces them in the downstream Unit. TransformPaths reads values from the upstream Unit (UpstreamPaths) and writes expression-derived values to the downstream Unit (DownstreamPaths). Immutable. */ UpdateType?: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** @description Getter function invocations whose first AttributeValue Value is exposed to DownstreamPaths expressions and DownstreamSetters argument templates by Name, alongside UpstreamPaths. Each function must be non-mutating and produce OutputTypeAttributeValueList. Functions served on a Channel are not supported. Only valid when UpdateType is TransformPaths. */ UpstreamGetters?: components["schemas"]["NamedFunctionResult"][]; /** * Format: int64 * @description The RevisionNum of the last merged upstream revision. */ UpstreamLastMergedRevisionNum?: number; /** * Format: uuid * @description Link ID of the link this link was cloned from (if any). * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UpstreamLinkID?: string; /** @description Values to read from the upstream Unit when resolving a TransformPaths Link. Each NamedPath is read via get-paths and made available to DownstreamPaths expressions by its Name. Only valid when UpdateType is TransformPaths. */ UpstreamPaths?: components["schemas"]["NamedPath"][]; /** * Format: uuid * @description Space ID of the link this link was cloned from (if any). * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UpstreamSpaceID?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; /** @description Where expression selecting Mutations of the downstream Unit whose paths this Link's merges must not overwrite. It adds to the downstream Unit's guards, so it holds further paths and never re-opens a guarded one. */ WhereMutation?: string; /** @description Where expression used to select which resources of the upstream Unit should be eligible for propagation to the downstream Unit. */ WhereResource?: string; }; LinkCreateOrUpdateResponse: { Error?: components["schemas"]["ResponseError"]; Link?: components["schemas"]["Link"]; }; LinkFinding: { /** @description Explanation the Reason alone cannot carry, such as the error a failed resolve reported */ Details?: string; /** @description The Link's entry the finding is about, as its list and position, such as ManualBindings[0] */ Entry?: string; /** @description The Key of the Link's entry the finding is about, when the entry has one */ Key?: string; /** * Format: uuid * @description The Link whose resolve recorded the finding * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ LinkID?: string; /** @description The path the finding is about; empty for a resource-level finding */ Path?: string; /** @description What the resolve could not do: NeededNotFound, ProvidedNotFound, or ResolveFailed */ Reason?: string; /** @description The resource the finding is about, in the Unit Reason names; empty for a finding about the resolve as a whole */ Resource?: components["schemas"]["ResourceInfo"]; /** * Format: uuid * @description The other Unit involved: the Link's upstream Unit * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; }; LinkFindingList: components["schemas"]["LinkFinding"][]; MergeKeyValue: { Key?: string; Value?: string; }; MoveRequest: { /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ToSpaceID?: string; }; MoveResponse: { /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ EntityID?: string; Error?: components["schemas"]["ResponseError"]; Moved?: boolean; MovedTagSlugs?: string[]; SelectionChanges?: components["schemas"]["SelectionChange"][]; Slug?: string; }; /** @description Mutation is a single source of mutation for a Revision. */ Mutation: { /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChannelID?: string; /** @description The classes of guarded reason the change was filtered with. On a function invocation that is the request's clearance together with that of every Trigger and Invocation that wrote in the same execution; on a Link's change, the Link's; on an apply of withheld conflicts, the request's */ Clearance?: components["schemas"]["Clearance"]; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description The function invoked if the change was made by a function. */ FunctionInvocation?: components["schemas"]["FunctionInvocation"]; /** @description The guards the change recorded on the paths it wrote: the operation's merged with those of the Trigger, Invocation, or Link that produced it */ Guards?: components["schemas"]["GuardStamp"]; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description The guards the change recorded as inherited on the paths it wrote, which clones receive and merges carry to the units downstream */ InheritedGuards?: components["schemas"]["GuardStamp"]; /** * Format: uuid * @description InvocationID is the identifier of the function invoked, if there is a corresponding Invocation. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ InvocationID?: string; InvocationParams?: { [key: string]: unknown; }; /** * Format: uuid * @description LinkID is the unique identifier of the link if the change was made due to resolving a link. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ LinkID?: string; /** * Format: int64 * @description MergeBaseRevisionNum is the sequence number of the upstream revision preceding the changes this change took, if it was made by a merge -- including a clone or upgrade -- or by resolving a Link: the revision the merge or the Link last took before. */ MergeBaseRevisionNum?: number; /** * Format: int64 * @description MergeEndRevisionNum is the sequence number of the upstream revision this change took, if it was made by a merge -- including a clone or upgrade -- or by resolving a Link. A Link's resolve reads its upstream Unit (the Link's ToUnitID) at this revision. A merge also records MergeSourceID; a resolve that is not a merge does not. */ MergeEndRevisionNum?: number; /** * Format: uuid * @description MergeSourceID is the unique identifier of the unit if the change was made due to merging from another unit, including for clone and upgrade. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ MergeSourceID?: string; /** * Format: uuid * @description Unique identifier for a Mutation. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ MutationID?: string; /** * Format: int64 * @description Sequence number for the Mutation. */ MutationNum?: number; /** * Format: uuid * @description Unique identifier for an Organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description ProvidedPath is the path of the provided value used to satisfy a needed value if the change was made due to resolving a link. */ ProvidedPath?: string; /** @description ProvidedResource contains the type and name of the resource which provided a value used to satisfy a needed value if the change was made due to resolving a link. */ ProvidedResource?: components["schemas"]["ResourceInfoType2"]; ReplayOutcome?: string; ReplayReason?: string; /** * Format: int64 * @description Sequence number of the restored revision, if the change was due to a restore operation. */ RestoredRevisionNum?: number; /** * Format: uuid * @description Unique identifier of the corresponding Revision. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ RevisionID?: string; /** * Format: int64 * @description Sequence number of the corresponding Revision. */ RevisionNum?: number; /** * Format: uuid * @description Unique identifier for a space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space this entity belongs to. (readonly) */ readonly SpaceSlug?: string; /** @description User-defined category for the Mutation. The prefix 'ConfigHub' is reserved. */ Subgroup?: string; /** * Format: uuid * @description TriggerID is the unique identifier of the trigger if the change was made by a trigger. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TriggerID?: string; /** * Format: uuid * @description Unique identifier for a Unit. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; /** @description Slug of the Unit this entity belongs to. (readonly) */ readonly UnitSlug?: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; MutationConflict: { /** @description Explanation the Reason alone cannot carry, such as the error text of a failed replay */ Details?: string; /** @description For Guarded: the guard the operation's clearance did not cover */ Guard?: components["schemas"]["WithheldGuard"]; /** @description For GuardWithheld: the guard change that did not propagate */ GuardChange?: components["schemas"]["GuardDelta"]; /** @description For Guarded and GuardWithheld: every guard the operation's clearance did not cover, those it forbade with DoesNotExist first and then in key order. Guard is the first of them. */ Guards?: components["schemas"]["WithheldGuard"][]; /** @description Path of the mutation; empty for resource-level conflicts */ Path?: string; /** @description Why the mutation was dropped */ Reason?: string; /** @description Resource the mutation applied to */ Resource?: components["schemas"]["ResourceInfo"]; /** @description The dropped source-side mutation */ Source?: components["schemas"]["MutationInfo"]; /** @description The target-side mutation that caused the drop, when applicable (Subtracted, DeleteShadowed) */ Target?: components["schemas"]["MutationInfo"]; /** * Format: uuid * @description ID of the other unit involved in the conflict (upstream for upgrade/merge, link target for resolve) * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; }; MutationConflictList: components["schemas"]["MutationConflict"][]; MutationInfo: { /** * Format: int64 * @description Function index or sequence number corresponding to the change */ Index?: number; /** @description Type of mutation performed on the associated configuration element: Add, Update, Replace, Delete, or None, if no change */ MutationType?: components["schemas"]["MutationType"]; /** @description Line-level patch for multi-line string updates, in unified diff format. When present on an Update, PatchMutations applies this to the target value instead of replacing with Value. Falls back to Value if the patch cannot be applied cleanly. */ Patch?: string; /** @description In the protection argument of the patch-mutations and reset functions, that the operation must leave the path alone. On a Unit's stored MutationSources, deprecated and no longer read: a local override a merge must not overwrite is an Override guard, in the Unit's PathAnnotations. True on paths stored as local overrides before that */ Protected?: boolean; /** @description Removed configuration data if MutationType is Delete and otherwise the new data */ Value?: string; }; MutationMap: { [key: string]: components["schemas"]["MutationInfo"]; }; MutationSourcesResponse: { /** @description Sources of mutations affecting the configuration data, by resource and path. */ MutationSources?: components["schemas"]["ResourceMutationList"]; }; /** @enum {string} */ MutationType: MutationType; NamedFunctionResult: { /** @description Non-mutating function invocation that produces OutputTypeAttributeValueList. The Value of the first returned AttributeValue is bound to Name. Functions served on a Channel are not supported. */ FunctionInvocation?: components["schemas"]["FunctionInvocation"]; /** @description Identifier used to reference the value; must be a legal Go and CEL identifier and unique across UpstreamPaths and UpstreamGetters */ Name?: string; }; NamedPath: { /** @description Identifier used to reference the value from a DownstreamPath Expression; must be a legal Go and CEL identifier */ Name?: string; /** @description Resolved path within Resource to read via get-paths */ Path?: string; /** @description Resource in the upstream Unit that contains Path */ Resource?: components["schemas"]["ResourceInfo"]; }; /** @description A per-app OAuth public client used by a browser app to authenticate against the ConfigHub API. */ OAuthClient: { /** @description Allow members of any organization to use the app (each gets their own org's session) instead of only the owning org. Permitted only for trusted organizations. */ AllowAllOrgs?: boolean; /** @description Generated OAuth client_id used at login and to address this client in the API. */ readonly ClientID?: string; /** @description Human-friendly name for the app. */ Name?: string; /** @description External identifier of the owning organization. */ readonly OrganizationID?: string; /** @description Exact redirect URIs permitted for the app's login (no wildcards). */ RedirectURIs?: string[] | null; }; /** @description The top-level container for an organization using ConfigHub. */ Organization: { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description An optional set of gates that, if any is present, will block deletion. */ DeleteGates?: { [key: string]: boolean; }; /** @description Friendly name for the entity. */ DisplayName?: string; /** @description Unique email domain name for the External Identity Provider record matching this organization */ EmailDomain?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description Unique identifier for the External Identity Provider record matching this organization. */ readonly ExternalID?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** * Format: uuid * @description Unique identifier for an organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Permissions to access this organization. Its Children categories apply to the spaces and the other entities that belong to the organization rather than to a space. */ Permissions?: components["schemas"]["Permissions"]; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; /** @description a User given membership on the Organization */ OrganizationMember: { /** @description Friendly name for the organization member User. */ DisplayName?: string; /** @description Unique identifier for the External Identity Provider record matching this User. */ ExternalID?: string; /** @description Unique identifier for the External Identity Provider record matching this organization. */ ExternalOrganizationID?: string; /** * Format: uuid * @description Unique identifier for an organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description The URL to get the profile avatar picture of the User. */ ProfilePictureURL?: string; /** @description Unique URL-safe identifier for the organization member User. */ Slug?: string; /** * Format: uuid * @description Unique identifier for the organization member User. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UserID?: string; /** @description Unique username for a User. Must be unique for all of ConfigHub. */ Username?: string; }; OtherUnitSelection: { /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ FilterID?: string; Where?: string; WhereResource?: string; }; ParameterizedFunction: { /** @description Mutating function invocation to run on the downstream Unit. Functions served on a Channel are not supported. */ FunctionInvocation?: components["schemas"]["FunctionInvocation"]; /** @description Identifies the entry within DownstreamSetters, so that a merge of two versions of the Link matches entries by Key rather than by position. Optional, and unique within the list when present. Letters, digits, '-' and '_', starting with a letter or digit; at most 128 characters. */ Key?: string; /** @description Names of upstream values whose values are exposed to string-argument template expansion. Each entry must match a Name in UpstreamPaths or UpstreamGetters. */ Parameters?: string[]; }; ParameterizedInvocationRef: { /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ InvocationID?: string; Parameters?: { [key: string]: unknown; }; }; PathAnnotationList: components["schemas"]["ResourcePathAnnotations"][]; PathAnnotations: { [key: string]: { [key: string]: string; }; }; PathChange: { /** @description The To side's MutationSources entry for this path, which says what set the new value; returned when include names Attribution */ Attribution?: components["schemas"]["MutationInfo"]; /** @description Add, Delete, Update, Replace, Reorder, or Rename; or None for an unchanged path returned as context */ ChangeType?: string; /** @description Head, Line, or Foot when the change is to a comment on the node at the path rather than to its value: the comment above the node, at the end of its line, or below it. The path of a comment on a whole resource is empty */ Comment?: string; /** @description The path in configuration path syntax, as --path arguments and where filters take it, with each unkeyed array element named by its index */ DisplayPath?: string; /** @description How to read FromValue: string, int, or bool for a scalar, YAML for a map or array, and empty for a scalar of another type, such as a float or null, or when the From side has no value */ FromDataType?: string; /** @description The value on the From side: a scalar's text, or a YAML block for a map or array */ FromValue?: string; /** @description A unified line diff, for multi-line string values */ Patch?: string; /** @description The path as MutationSources and patch functions record it */ Path?: string; /** @description The path split into its segments, for rendering without parsing the path syntax */ Segments?: components["schemas"]["PathSegment"][] | null; /** @description How to read ToValue: string, int, or bool for a scalar, YAML for a map or array, and empty for a scalar of another type, such as a float or null, or when the To side has no value */ ToDataType?: string; /** @description The value on the To side: a scalar's text, or a YAML block for a map or array. For an unchanged path, the value on both sides */ ToValue?: string; }; PathExpression: { /** @description Data type of the resulting AttributeValue: string, int, or bool. The Expression result (a string) is coerced to this type. */ DataType?: string; /** @description Expression evaluator: "template" for Go templates or "cel" for CEL */ Evaluator?: string; /** @description Go template or CEL expression that evaluates to the value to write. Parameters and FunctionContext fields are in scope. */ Expression?: string; /** @description Identifies the entry within DownstreamPaths, so that a merge of two versions of the Link matches entries by Key rather than by position. Optional, and unique within the list when present. Letters, digits, '-' and '_', starting with a letter or digit; at most 128 characters. */ Key?: string; /** @description Names of upstream values referenced by Expression. Each entry must be a legal identifier and must match a Name in UpstreamPaths or UpstreamGetters. */ Parameters?: string[]; /** @description Unresolved path within Resource to write via set-attributes */ Path?: string; /** @description Resource in the downstream Unit that contains Path. Reserved as a pointer for a future optional/WhereResource form; required for now. */ Resource?: components["schemas"]["ResourceInfo"]; }; PathSegment: { /** @description The map key, for a map segment */ Field?: string; /** @description The element's index on the From side; -1 for a map key or an element absent there */ FromIndex: number; /** @description The merge keys that identify the element, for an element of a merge-keyed array */ MergeKeys?: components["schemas"]["MergeKeyValue"][]; /** @description The element's index on the To side; -1 for a map key or an element absent there */ ToIndex: number; }; PathToVisitorInfoType: { [key: string]: components["schemas"]["PathVisitorInfo"]; }; PathVisitorInfo: { /** @description AttributeName for the path */ AttributeName?: string; /** @description DataType of the attribute at the path */ DataType?: string; /** @description Additional attribute details */ Details?: components["schemas"]["AttributeDetails"]; /** @description Configuration of the embedded accessor, if any */ EmbeddedAccessorConfig?: string; /** @description Embedded accessor to use, if any */ EmbeddedAccessorType?: string; /** @description Unresolved path pattern */ Path?: string; /** @description Specific resolved path */ ResolvedPath?: string; /** @description Resource types to skip */ TypeExceptions?: { [key: string]: Record; }; }; Permissions: { [key: string]: components["schemas"]["Subjects"]; }; PromoteGateResult: { /** @description For an attestation prerequisite, what was counted, whether or not the gate holds. */ Attestation?: components["schemas"]["AttestationGateResult"]; /** @description Why the gate does not hold. */ Message?: string; /** @description Promoted, Validated, Released, Healthy, or the name of a custom or attestation prerequisite. */ Prerequisite?: string; /** @description Why the gate does not hold, as a code: NotPromoted, PreviousStageEmpty, NotReleased, ValidationErrors, NotMarked, NoReleaseTarget, NoRelease, NoLiveStatus, NotSynced, Deploying, DeployFailed, Unhealthy, AttestationsMissing, AttestationRejected, ExpressionFalse, EvaluationFailed, or UnknownPrerequisite. A client that does not know a code shows Message. */ Reason?: string; Satisfied?: boolean; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; SpaceSlug?: string; }; PromoteLinkResult: { /** @description Create, Unchanged, Skip, or Orphaned. */ Action?: string; Error?: components["schemas"]["ResponseError"]; FromUnitSlug?: string; /** * Format: uuid * @description Absent for a Link a dry run would create. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ LinkID?: string; /** @description Why the Link was skipped or orphaned, in words. */ Message?: string; /** @description Adopted for an Unchanged Link, TargetUnitMissing for a Skip, or UpstreamLinkDeleted for an Orphaned one. */ Reason?: string; Slug?: string; ToSpaceSlug?: string; ToUnitSlug?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UpstreamLinkID?: string; }; PromoteRequest: { /** @description Recorded on each Unit write. */ ChangeDescription?: string; /** * Format: uuid * @description The ChangeOrder to promote. Without one, everything each upstream has reached is promoted. With one, only its range is, into the Spaces it is headed for. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeOrderID?: string; /** * Format: uuid * @description An existing open ChangeSet to record every write in. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeSetID?: string; /** @description The guarded reasons the writes are cleared for. A path whose guards this does not cover is not written, and the withheld change is reported in the Unit's Conflicts. */ Clearance?: components["schemas"]["Clearance"]; /** @description Plan the promotion, evaluate its gates, and return the same response without writing anything. */ DryRun?: boolean; /** @description The Plan a previous dry run returned. If the plan now differs, nothing is written and the request fails with 412. */ ExpectedPlan?: string; /** @description Promote even though the Stage's entry gates do not hold. Requires ForceReason, and Edit permission on the ChangeOrder, where the override is recorded. */ Force?: boolean; /** @description Why the gates were overridden. Required with Force. */ ForceReason?: string; /** @description Reasons to record on the paths each Unit write changes. A later operation must be cleared for them before overwriting those paths. Clearance must cover them, since a write is withheld by guards it is not cleared for, its own included. */ Guards?: components["schemas"]["GuardStamp"]; /** * @description With a ChangeOrder, what to do for a Unit whose last merged upstream Revision is before the ChangeOrder's start there -- typically because a Link in the upstream Space, such as a TransformPaths Link, wrote Revisions after the Unit last merged. Include merges those Revisions first, as Revisions of their own that do not carry the ChangeOrder, and then the ChangeOrder's range; Skip merges only the ChangeOrder's range, as though the Unit had already merged as far as its start, and those Revisions do not arrive later; Error refuses, naming the Revisions; All merges them as Include does, and also marks every Unit in the Space the change does not change at its head, so the next promotion brings it up to this Space. Defaults to the ChangeOrder's PriorRevisions, or Include. A Unit that has merged past the ChangeOrder's start is an error whatever this says. Refused with an Insert, Upsert, or TransformPaths ChangeOrder, whose Links read their sources as they are at its end rather than merging a range. * @enum {string} */ PriorRevisions?: PromoteRequestPriorRevisions; /** @description Deprecated: use Guards, as {"Override":"Upstream"}, with a Clearance admitting it. Records each Unit's Override guard on the paths its writes change -- Override=Upstream for a Unit with an upstream Unit, Override=External for one without -- with the clearance to write over one. Accepted only for an Invoke ChangeOrder and for one that follows Insert, Upsert, or TransformPaths Links: refused for a promotion that merges, which the guard holds paths against. */ Protect?: boolean; /** * Format: uuid * @description A Filter over Spaces selecting the Spaces to promote. Intersected with the other selectors. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceFilterID?: string; /** @description Merge each Unit's range as one rebased Revision rather than replaying each upstream Revision. */ Squash?: boolean; /** @description A category recorded on the Mutations of each Unit write. Alphanumeric, at most 64 characters, and not starting with ConfigHub. */ Subgroup?: string; /** * Format: uuid * @description A Tag to put on the Revision each Unit the promotion writes is left at, clones included. Units the promotion leaves Unchanged are not tagged. Requires Use permission on the Tag, and cannot be used with ChangeOrderID, whose own Tags mark what it promotes. A selected Space with a Unit to write that the Tag already marks fails, and nothing in it is written. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TagID?: string; /** @description A Stage of the ChangeOrder's ChangeWorkflow to promote into. Requires a ChangeOrder with a ChangeWorkflow. When empty, and neither WhereSpace nor SpaceFilterID is given, the next Stage the change has not reached. */ TargetStage?: string; /** @description A where expression selecting the Spaces to promote. Intersected with the other selectors. */ WhereSpace?: string; }; PromoteResult: { /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeOrderID?: string; /** @description Every Stage of the ChangeWorkflow already has the change; nothing was promoted. */ Complete?: boolean; /** @description True when nothing was written. */ DryRun?: boolean; /** @description Set when the gates refused the promotion: why, with each failed gate's message among its Details. */ Error?: components["schemas"]["ResponseError"]; /** @description When Complete, the gates of the ChangeWorkflow's Final, evaluated over each Space of the last Stage. The ChangeOrder's Stage becomes Completed once they all hold. */ Final?: components["schemas"]["PromoteGateResult"][]; /** @description Digest of the planned actions. Send it as ExpectedPlan to apply exactly this plan. */ Plan?: string; /** @description In the order they were, or would be, promoted: a Space after any selected Space it takes from. */ Spaces?: components["schemas"]["PromoteSpaceResult"][]; /** @description The Stages entered, each with every gate evaluated over the Stage before it. */ Stages?: components["schemas"]["PromoteStageResult"][]; }; PromoteSpaceResult: { /** @description Promote, Unchanged, Skipped, Blocked, or Failed. */ Action?: string; Error?: components["schemas"]["ResponseError"]; Links?: components["schemas"]["PromoteLinkResult"][]; /** @description Why the Space was Skipped or Blocked, in words. */ Message?: string; /** @description A dry run previewed this Space against its upstream as it is now, although the same request promotes that upstream first. */ PreviewedAgainstCurrentUpstream?: boolean; /** @description Why the Space was Skipped or Blocked, as a code: ChangeOrderSpace, NotInScope, UpstreamPromotedFirst, or UpstreamFailed. */ Reason?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; SpaceSlug?: string; Stage?: string; Units?: components["schemas"]["PromoteUnitResult"][]; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UpstreamSpaceID?: string; UpstreamSpaceSlug?: string; }; PromoteStageResult: { /** @description The Stage was the next one the change has not reached, rather than named. */ Chosen?: boolean; /** @description The gates did not hold and the promotion was forced. */ Forced?: boolean; Gates?: components["schemas"]["PromoteGateResult"][]; Name?: string; /** @description The Stage whose Spaces the gates are evaluated over. Empty for the first Stage, whose gates are evaluated over the change order's own Space. */ PreviousStage?: string; }; PromoteUnitResult: { /** @description Upgrade, Resolve, Mark, Empty, Revive, Clone, Invoke, Unchanged, or Skip. */ Action?: string; /** @description The configuration the write produced, or on a dry run would produce. Returned when include names ConfigData, for a Unit the promotion writes. */ ConfigData?: string; /** @description Paths withheld because they were overridden locally or guarded. */ Conflicts?: components["schemas"]["MutationConflictList"]; /** @description The same change path by path, with the values on both sides. Returned when include names Diff. */ Diff?: components["schemas"]["ConfigDiff"]; Error?: components["schemas"]["ResponseError"]; /** Format: int64 */ HeadRevisionNum?: number; /** @description For a Resolve, and a Mark made by one, the Links resolved. */ LinkIDs?: components["schemas"]["UUID"][]; /** @description What the write changed, or on a dry run would change: the entries of the Unit's MutationSources it produced. Returned when include names Mutations. */ Mutations?: components["schemas"]["ResourceMutationList"]; /** Format: int64 */ PreviousHeadMutationNum?: number; /** Format: int64 */ PreviousHeadRevisionNum?: number; /** @description For Skip and Unchanged: NotCovered, CreatedAfterChangeOrder, AlreadyTaken, NotChanged when the change does not change the Unit, or CreatedInSpace when the Unit was created in this Space rather than cloned into it. A Unit in the Space that the change does not change is marked once the Space's writes are done, with both Tags on the Revision the ChangeOrder's PriorRevisions names. For an applied Upgrade or Resolve: NoChange, when the Unit already held the change, so no Revision was made and the ChangeOrder's Tags mark its head. */ Reason?: string; Slug?: string; /** * Format: uuid * @description Absent for a clone a dry run would create. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; /** * Format: uuid * @description Absent for a Unit created in this Space, and for a Resolve over Links to more than one Unit. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UpstreamUnitID?: string; }; /** @description Release is a published bundle of the configuration of the Units in a Space that are not Unreleasable, for the Space's release Target. It is created by publishing, taken out of service by withdrawing, and removed by deleting; its bundled content is never updated, though its Labels, Annotations, DeleteGates, and LiveStatus can be. The bundle is stored as an OCI image (a tar.gz layer plus manifest) so it can be served to and consumed by the Target. */ Release: { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** @description Base filename used for the Release's stored bundle, without the .tar.gz suffix. Set at publish time and recorded in the Release's OCI manifest, so it cannot be changed afterwards. (readonly) */ readonly BundleBaseName?: string; /** * Format: uuid * @description ChangeOrder the Release was published for, when publishing named one. Publishing it advances that ChangeOrder's Stage. (readonly) * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly ChangeOrderID?: string; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** Format: int64 */ readonly DataSize?: number; /** @description An optional set of gates that, if any is present, will block deletion. */ DeleteGates?: { [key: string]: boolean; }; /** @description OCI content digest (sha256:...) of the Release's stored tar.gz bundle. */ readonly Digest?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** @description What the tool deploying the Release, such as k8sbot for Argo CD, reports about it running. Absent until a tool reports. Written by that tool: EditChildren on the Release's Target grants Edit on the Release. */ LiveStatus?: components["schemas"]["ReleaseLiveStatus"]; /** @description OCI digest (sha256:...) of the Release's OCI image manifest. */ readonly ManifestDigest?: string; /** @description The OCI repository the Release is served from: its Space's, as the Space's OCIRepositoryURL says, while the Release is Published. It is oci://:/space/, for a GitOps operator such as Argo CD or Flux to pull: its tag latest is the newest Release published for the Space's current release Target, and a ManifestDigest pins one. The registry is the one GET /api/info advertises to the same caller (OCIHost and OCIPort). Derived when the entity is read rather than stored, and returned whatever select names. (readonly) */ readonly OCIRepositoryURL?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Permissions to access this release. */ Permissions?: components["schemas"]["Permissions"]; /** @description Whether the Release is currently served to its consuming Target. Set when the Release is published and cleared when it is withdrawn; a withdrawn Release is retained until deleted. */ readonly Published?: boolean; /** * Format: uuid * @description Unique identifier for a Release. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ReleaseID?: string; /** * Format: int64 * @description Monotonically increasing sequence number of the Release within its Target, assigned at publish time. The highest ReleaseNum is the latest Release for the Target. */ readonly ReleaseNum?: number; /** @description SkippedUnits names the Units released to the Release's Target that the Release does not bundle, mapped to the reason as a code. NotMarked: publishing with a TagID leaves out a Unit that has never been released and that the Tag marks no Revision of; a Unit that has been released must be marked. (readonly) */ readonly SkippedUnits?: { [key: string]: string; }; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space this entity belongs to. */ readonly SpaceSlug?: string; /** * Format: uuid * @description Tag identifying the bundled Revision of each Unit in the Release. When publishing supplied a TagID, this is that Tag. Otherwise publishing creates a Tag named release- in the Release's Space, applies it to each bundled Revision, and sets it here. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly TagID?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly TargetID?: string; /** * Format: int64 * @description Number of Units bundled in the Release, captured at publish time. */ readonly UnitCount?: number; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: uuid * @description The User who published the Release. Absent for Releases published before it was recorded. (readonly) * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UserID?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; ReleaseLiveStatus: { /** @description The object the status was read from, such as the name of the Argo CD Application. */ DataSource?: string; /** * @description The aggregate health of what the Release deployed: Healthy, Progressing, Degraded, Suspended, Missing, or Unknown. * @enum {string} */ Health?: ReleaseLiveStatusHealth; /** @description A short human-readable status or error message. */ Message?: string; /** * Format: date-time * @description When the reporter observed this status. * @example 2006-01-02T15:04:05Z07:00 */ ObservedAt?: string; /** * @description The state of the operation applying the Release, when the reporter runs one: Running, Succeeded, or Failed. * @enum {string} */ Operation?: ReleaseLiveStatusOperation; /** @description The client that reported the status, such as k8sbot. */ Reporter?: string; /** @description The health in the reporter's own words. */ ReporterHealth?: string; /** @description The operation phase in the reporter's own words, such as Argo CD's Error or Terminating. */ ReporterOperation?: string; /** @description The sync status in the reporter's own words, such as Argo CD's OutOfSync. */ ReporterSync?: string; /** * @description Whether what is running matches the Release: Synced, OutOfSync, or Unknown. * @enum {string} */ Sync?: ReleaseLiveStatusSync; }; ReleasePublishRequest: { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** @description Optional override of the name of the Release's tar.gz bundle. */ BundleBaseName?: string; /** * Format: uuid * @description Optional ID of the ChangeOrder the Release is published for. It is recorded as the Release's ChangeOrderID, and the ChangeOrder's Stage is advanced in the same transaction. The Release is bundled at the ChangeOrder's release Tag (ReleaseTagID): TagID may be omitted, or name that Tag or the ChangeOrder's end Tag, which is taken to mean it; any other TagID is refused. Naming a ChangeOrder's release Tag as TagID without ChangeOrderID publishes for that ChangeOrder. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeOrderID?: string; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean; }; /** @description Publish in a transaction that is rolled back, returning the Release that would be published, or the error publishing would return: the same ChangeSet, validation and ReleasePrerequisites checks run against the Revisions it would bundle. No event is emitted and no Stage is advanced. */ DryRun?: boolean; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** @description Optional Permissions to access the Release. Its publisher is granted Manage in addition. */ Permissions?: components["schemas"]["Permissions"]; /** * @description For a Release of a ChangeOrder, what to do with a bundled Unit's Revisions from before the change: those after its LastReleasedRevisionNum up to the one the ChangeOrder's start Tag marks. Include releases them; Error refuses the publish, naming them and the ChangeOrders they belong to. Defaults to the ChangeOrder's ReleasePriorRevisions, or Include. * @enum {string} */ PriorRevisions?: ReleasePublishRequestPriorRevisions; /** * Format: uuid * @description Optional Tag ID identifying the tagged Revision to bundle. For each Unit of the Space that is not Unreleasable, the highest-numbered Revision carrying this Tag is bundled at that Revision instead of the Unit's head Revision. A Unit with no matching tagged Revision is left out of the bundle and listed in the Release's SkippedUnits when it has never been released, and refuses the publish when it has. When omitted, each Unit is bundled at its head Revision and publishing creates a Tag named release-, applies it to each bundled Revision, and sets it as the Release's TagID. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TagID?: string; }; ReleasePublishResponse: { /** @description Why the Release was not published. */ Error?: components["schemas"]["ResponseError"]; /** @description For a change order, each ReleasePrerequisite of the stage the Space belongs to, evaluated over the Revisions the Release bundles, whether or not it holds. */ Gates?: components["schemas"]["PromoteGateResult"][]; /** @description Why no Release was created: nothing changed since the latest published Release, or, on a refusal, the error as one string. */ Message?: string; /** @description The published Release, or the latest published Release when no Release was created. */ Release?: components["schemas"]["Release"]; }; /** @description Resource is a configuration element extracted from a Unit's configuration data. Resources are maintained automatically as Units change and are read-only. */ Resource: { /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description Configuration data of the resource, represented as JSON. */ Data?: Record; /** @description The type of entity. */ readonly EntityType?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** * Format: uuid * @description Unique identifier for an Organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** * Format: uuid * @description Unique identifier for a Resource. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ResourceID?: string; /** * Format: int64 * @description Distinguishes resources within a Unit that share a ResourceType and ResourceName, as AppConfig documents that declare no configHub.configName do. 0 when the name is unique within the Unit. */ ResourceIndex?: number; /** @description Name of the resource; Kubernetes resources are represented in the form /. */ ResourceName?: string; /** @description Type of the resource; Kubernetes resources are represented in the form /. */ ResourceType?: string; /** * Format: uuid * @description Unique identifier for a space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space this entity belongs to. (readonly) */ readonly SpaceSlug?: string; /** * Format: uuid * @description Identifier of the Target a Release of the Unit's Space publishes the resource for, which defines where the configuration will be applied: the Unit's TargetID, which is the Space's ReleaseTargetID unless the Unit is Unreleasable. Read from the Space and the Unit. (readonly) * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly TargetID?: string; /** @description ToolchainType of the Unit the resource was extracted from. */ ToolchainType?: string; /** * Format: uuid * @description Unique identifier for a Unit. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; /** @description Slug of the Unit this entity belongs to. (readonly) */ readonly UnitSlug?: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; ResourceDiff: { /** @description For an Add, the To side's MutationSources entry for the resource, which says what added it; returned when include names Attribution */ Attribution?: components["schemas"]["MutationInfo"]; /** @description Add, Delete, Update, or None when the resource is unchanged */ ChangeType?: components["schemas"]["MutationType"]; /** @description Changes within the resource, for an Update, in document order */ Changes?: components["schemas"]["PathChange"][]; /** @description The whole resource, for a Delete */ FromValue?: string; /** @description The resource on the From side, when it was matched across a rename */ PreviousResource?: components["schemas"]["ResourceInfo"]; /** @description Identifies the resource on the To side, or on the From side if it was deleted */ Resource?: components["schemas"]["ResourceInfo"]; /** @description The whole resource, for an Add */ ToValue?: string; }; ResourceGuards: { /** @description Guard keys to remove, by path, named as in Set; * also matches the paths guarded that the data no longer has. Removing a key that is not there is not an error */ Remove?: { [key: string]: string[]; }; /** @description The resource whose guards are being edited: ResourceName, its whole name (namespace/name) or a name it had before a rename, or ResourceNameWithoutScope, a name without its namespace that has to match one resource; ResourceType, in any API version, is optional. A resource the unit does not have yet is named by ResourceType and ResourceName. */ Resource?: components["schemas"]["ResourceInfo"]; /** @description Guard key/value pairs to add or overwrite, by path, as guards of this unit alone: clones and downstream units do not receive them, and one that was inherited stops being. The empty path addresses the resource as a whole. A list element is named by merge key or by position, and * stands for every element or key there is; a path that does not exist yet is kept as written */ Set?: { [key: string]: { [key: string]: string; }; }; /** @description Guard key/value pairs to add or overwrite, by path, as inherited guards: a clone of the unit receives them, and a merge carries them, and any later change to them, to the units downstream of it. Named as in Set; a key may not be in both at the same path */ SetInherited?: { [key: string]: { [key: string]: string; }; }; }; ResourceInfo: { /** @description Category of configuration element represented in the configuration data; Kubernetes resources are of category Resource, and application configuration files are of category AppConfig */ ResourceCategory?: string; /** @description Name of a resource in the system under management represented in the configuration data; Kubernetes resources are represented in the form /; not all ToolchainTypes necessarily use '/' as a separator between any scope(s) and name or other client-chosen ID */ ResourceName?: string; /** @description Name of a resource in the system under management represented in the configuration data with generated prefixes and suffixes stripped; empty if nothing to strip */ ResourceNameStableCore?: string; /** @description Name of a resource in the system under management represented in the configuration data, without any uniquifying scope, such as Namespace, Project, Account, Region, etc.; Kubernetes resources are represented in the form */ ResourceNameWithoutScope?: string; /** @description Type of a resource in the system under management represented in the configuration data; Kubernetes resources are represented in the form / (aka group-version-kind) */ ResourceType?: string; }; ResourceInfoType2: { /** @description Category of configuration element represented in the configuration data; Kubernetes resources are of category Resource, and application configuration files are of category AppConfig */ ResourceCategory?: string; /** @description Name of a resource in the system under management represented in the configuration data; Kubernetes resources are represented in the form /; not all ToolchainTypes necessarily use '/' as a separator between any scope(s) and name or other client-chosen ID */ ResourceName?: string; /** @description Name of a resource in the system under management represented in the configuration data with generated prefixes and suffixes stripped; empty if nothing to strip */ ResourceNameStableCore?: string; /** @description Type of a resource in the system under management represented in the configuration data; Kubernetes resources are represented in the form / (aka group-version-kind) */ ResourceType?: string; }; ResourceMutation: { /** @description Names (with scopes, if any) used in current and prior revisions of this resource */ Aliases?: { [key: string]: Record; }; /** @description Names without scopes used in current and prior revisions of this resource */ AliasesWithoutScopes?: { [key: string]: Record; }; /** @description For merge-keyed arrays in which an element was renamed (its merge-key value changed): the array parent path mapped to a previous-merge-key -> new-merge-key map. PatchMutations rewrites the matched element's merge-key field accordingly so child paths and ArrayOrders entries resolve under the new key. */ ArrayElementAliases?: components["schemas"]["ArrayElementAliasMap"]; /** @description For merge-keyed arrays whose element set or order changed in this mutation: the desired sequence of merge-key values in source order, keyed by the array's parent path. PatchMutations applies this as a reorder pass after path mutations so positional associative arrays (e.g., Kubernetes initContainers, env, ports) preserve source-side ordering rather than landing append-on-clash. */ ArrayOrders?: components["schemas"]["ArrayOrderMap"]; /** @description Path-level mutation information; more deeply nested paths override values represented at higher levels */ PathMutationMap?: components["schemas"]["MutationMap"]; /** @description Identifiers of the resource to which the mutations correspond */ Resource?: components["schemas"]["ResourceInfo"]; /** @description Resource-level mutation information, such as for Add, Delete, or Replace */ ResourceMutationInfo?: components["schemas"]["MutationInfo"]; }; ResourceMutationList: components["schemas"]["ResourceMutation"][]; ResourcePathAnnotations: { /** @description Names (with scopes, if any) used in current and prior revisions of this resource */ Aliases?: { [key: string]: Record; }; /** @description Names without scopes used in current and prior revisions of this resource */ AliasesWithoutScopes?: { [key: string]: Record; }; /** @description Annotations by path. Paths are canonical: an associative segment names its element by merge key, with no positional fallback */ PathAnnotationMap?: { [key: string]: components["schemas"]["PathAnnotations"]; }; /** @description Identifiers of the resource whose paths are annotated */ Resource?: components["schemas"]["ResourceInfo"]; /** @description Annotations on the resource as a whole, inherited by paths with no more specific entry */ ResourceAnnotations?: components["schemas"]["PathAnnotations"]; }; ResourceProtection: { /** @description Map of path to whether it is a local override: true gives the path the Unit's Override guard, false removes it. A list element is named by merge key or by position, and * stands for every element or key there is. The empty path addresses the resource as a whole */ Protected?: { [key: string]: boolean; } | null; /** @description The resource whose protection is being set: ResourceName, its whole name (namespace/name) or a name it had before a rename, or ResourceNameWithoutScope, a name without its namespace that has to match one resource; ResourceType, in any API version, is optional */ Resource?: components["schemas"]["ResourceInfo"]; }; ResourceTypePathsEntry: { /** * Format: uuid * @description ID of the Link that bound this needed path to a provided value * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ BoundLinkID?: string; /** @description ProvidedProperties of the provided path that was bound to this needed path, for cross-link score comparison */ BoundProvidedProperties?: { [key: string]: string; }; /** @description Whether this attribute is a needed value */ IsNeeded?: boolean; /** @description Whether this attribute is a provided value */ IsProvided?: boolean; /** @description Preferred properties for matching; more matches produce a stronger match preference */ NeededPreferred?: { [key: string]: string; }; /** @description Required properties that a provided value must have in order to match */ NeededRequired?: { [key: string]: string; }; Paths?: components["schemas"]["PathToVisitorInfoType"]; /** @description Key/value properties describing what this provided value offers, for matching */ ProvidedProperties?: { [key: string]: string; }; ResourceType?: string; }; ResponseError: { /** @description Additional context messages */ Details?: string[]; /** @description Structured error details like field violations */ ErrorMetadata?: components["schemas"]["ErrorMetadata"]; /** @description The primary error message */ Message?: string; /** @description HTTP status code */ Status?: number; /** @description The category of the error, as a code: UserInput, Validation, Data, Authentication, Permission, NotFound, Conflict, AlreadyExists, Unprocessable, Locked, PreconditionFailed, TooManyRequests, Unexpected, GatewayTimeout, or ServiceUnavailable */ Type?: string; }; /** @description ReviewComment is a remark made in review of a Revision of a Unit, optionally about one resource or path in it. */ ReviewComment: { /** * Format: uuid * @description Unique identifier of the ChangeOrder the comment was made in review of, which may be in another Space. Optional; requires Use permission on the ChangeOrder. A reply takes the ChangeOrderID of the comment it answers, and may not name another. Immutable. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeOrderID?: string; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** * Format: uuid * @description Unique identifier for an Organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Path to which the remark is attached; optional */ Path?: string; /** * Format: uuid * @description Unique identifier of the ReviewComment, on the same Unit, this one replies to. Unset for a comment that starts a thread. Immutable. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ReplyToID?: string; /** @description Resource to which the remark is attached; optional */ Resource?: components["schemas"]["ResourceInfoType2"]; /** * Format: uuid * @description Unique identifier for a ReviewComment. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ReviewCommentID?: string; /** * Format: uuid * @description Unique identifier of the Revision the comment is about. Set by the server from RevisionNum. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ RevisionID?: string; /** * Format: int64 * @description Sequence number of the Revision the comment is about. Required on create, and immutable. */ RevisionNum: number; /** * Format: uuid * @description Unique identifier for a space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space this entity belongs to. (readonly) */ readonly SpaceSlug?: string; /** @description The text of the remark. */ Text: string; /** * Format: uuid * @description Unique identifier for a Unit. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; /** @description Slug of the Unit this entity belongs to. (readonly) */ readonly UnitSlug?: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** @description User-Agent string of the API call that created the comment. */ readonly UserAgent?: string; /** * Format: uuid * @description Unique identifier of the user who made the comment. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UserID?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; ReviewCommentCreateOrUpdateResponse: { Error?: components["schemas"]["ResponseError"]; ReviewComment?: components["schemas"]["ReviewComment"]; }; /** @description Revision is a historial view of a Config Unit. */ Revision: { /** * @deprecated * @description Deprecated: use ValidationErrors, which this is a copy of. Returned for compatibility with clients written before the field was renamed; it cannot be set. */ readonly ApplyGates?: { [key: string]: boolean; }; /** * @deprecated * @description Deprecated: use ValidationWarnings, which this is a copy of. Returned for compatibility with clients written before the field was renamed; it cannot be set. */ readonly ApplyWarnings?: { [key: string]: boolean; }; /** @description A set (map) of AttestationIDs of the Attestations covering this Revision: approvals, reviews, and other claims made about it. The string values have no particular meaning. */ readonly Attestations?: { [key: string]: string; }; readonly ChangeOrders?: { [key: string]: string; }; /** * Format: uuid * @description Unique identifier for the ChangeSet to which this Revision belongs. Optional. Revisions are not required to belong to ChangeSets. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeSetID?: string; Conflicts?: components["schemas"]["MutationConflictList"]; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description The SHA256 hash of this revision's data, encoded as hexadecimal. It is also the ETag the data endpoint serves. */ DataHash?: string; /** * Format: int64 * @description The size of this revision's data in bytes. The data itself is not part of the Revision; read it from the data endpoint. */ readonly DataSize?: number; /** @description User description of the change. It is copied from the LastChangeDescription field of the Unit at the time the change was made that created the Revision. */ Description?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; LinkFindings?: components["schemas"]["LinkFindingList"]; /** @description Attribute paths this Revision's configuration needs from upstream Units via NeedsProvides Links. */ NeededPaths?: components["schemas"]["AttributeValue"][]; /** * Format: uuid * @description Unique identifier for an Organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Annotations on locations within the Unit's configuration data as of this Revision. */ PathAnnotations?: components["schemas"]["PathAnnotationList"]; /** @description Attribute paths this Revision's configuration provides to downstream Units via NeedsProvides Links. */ ProvidedPaths?: components["schemas"]["AttributeInfo"][]; /** @description A set (map) of ReleaseIDs of any Releases that have bundled this Revision. The string values have no particular meaning for now. */ Releases?: { [key: string]: string; }; /** * Format: uuid * @description Unique identifier for a Revision. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ RevisionID?: string; /** * Format: int64 * @description Sequence number for a Revision. */ RevisionNum?: number; /** @description ConfigHub operation that created this revision. */ Source?: string; /** * Format: uuid * @description Unique identifier for a space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space this entity belongs to. (readonly) */ readonly SpaceSlug?: string; /** @description A set (map) of TagIDs of any Tags applied to this Revision. The string values have no particular meaning for now. */ Tags?: { [key: string]: string; }; /** * Format: uuid * @description Unique identifier for a Unit. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; /** @description Slug of the Unit this entity belongs to. (readonly) */ readonly UnitSlug?: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** @description User-Agent string if created by an API call. Optional. */ UserAgent?: string; /** * Format: uuid * @description UserID if change was made by a user. Automated changes, such as by triggers and resolve, are currently made with the UserID "00000000-0000-0000-0000-000000000000". * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UserID?: string; /** @description A map of "//" to true of Triggers invoking validating functions that did not pass on the configuration data at this Revision. These block Release operations. */ ValidationErrors?: { [key: string]: boolean; }; /** @description A map of "//" to true of Triggers invoking validating functions that executed and passed on the configuration data at this Revision. Disjoint from ValidationErrors and ValidationWarnings. */ ValidationPassed?: { [key: string]: boolean; }; /** @description A map from gate/warning name to the validation results that caused it, for the configuration data at this Revision. */ ValidationResults?: { [key: string]: components["schemas"]["ValidationResultList"]; }; /** @description A map of "//" to true of validating Triggers that had nothing to check on the configuration data at this Revision: their WhereResource selects no resource in it, so their functions were not invoked. Disjoint from ValidationErrors, ValidationWarnings and ValidationPassed. */ ValidationSkipped?: { [key: string]: boolean; }; /** @description Map from each gate name in ValidationErrors, ValidationWarnings, and ValidationPassed to the ID of the Trigger that produced it. A gate no Trigger produced has no entry. The Trigger may since have been renamed, moved, or deleted. */ ValidationTriggerIDs?: { [key: string]: components["schemas"]["UUID"]; }; /** @description A map of "//" to true of Triggers with Warn=true invoking validating functions that did not pass on the configuration data at this Revision. These do not block Release operations. */ ValidationWarnings?: { [key: string]: boolean; }; /** @description Map from each key in Values to the ID of the Trigger that produced it. The Trigger may since have been renamed, moved, or deleted. */ ValueTriggerIDs?: { [key: string]: components["schemas"]["UUID"]; }; /** @description Map from "//" to the first output Value with that attribute name of the function invocation specified by the Trigger, as of this Revision. Revisions written before the Space slug was added have "/" keys. */ Values?: { [key: string]: string; }; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; RevisionData: { /** @description The configuration data at this Revision. */ Data?: string; /** @description SHA256 of the configuration data, which is also the ETag the single-Revision data endpoint serves. */ DataHash?: string; /** * Format: int64 * @description Size of the configuration data in bytes. */ DataSize?: number; /** * Format: uuid * @description Unique identifier of the Revision. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ RevisionID?: string; /** * Format: int64 * @description Sequence number of the Revision within its Unit. */ RevisionNum?: number; /** * Format: uuid * @description Unique identifier of the Space the Unit belongs to. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** * Format: uuid * @description Unique identifier of the Unit the Revision belongs to. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; }; RevisionMutationSources: { /** @description Sources of mutations affecting the configuration data, by resource and path. */ MutationSources?: components["schemas"]["ResourceMutationList"]; /** * Format: uuid * @description Unique identifier of the Revision. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ RevisionID?: string; /** * Format: int64 * @description Sequence number of the Revision within its Unit. */ RevisionNum?: number; /** * Format: uuid * @description Unique identifier of the Unit the Revision belongs to. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; }; Schema: unknown; SelectionChange: { /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ EntityID?: string; EntityType?: string; Refreshed?: boolean; Selects?: boolean; Slug?: string; SpaceSlug?: string; }; /** @description An identity of the organization that is not a person and does not log in through the identity provider, such as an automation or an agent. Each ServiceAccount is backed by a User, which is what other entities' Permissions and Groups name to grant it access. The ServiceAccount's own Permissions say who may manage it. */ ServiceAccount: { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description An optional set of gates that, if any is present, will block deletion. */ DeleteGates?: { [key: string]: boolean; }; /** @description Friendly name for the entity. */ DisplayName?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** @description Organization-level role of the ServiceAccount's User. Defaults to none, which leaves the User with only the permissions granted to it. It cannot be set above the role of the caller setting it, and changing it requires Manage permission on the service account. */ OrgRole?: string; /** * Format: uuid * @description Unique identifier for an organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Permissions to access this service account. */ Permissions?: components["schemas"]["Permissions"]; /** * Format: uuid * @description Unique identifier for a service account. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ServiceAccountID?: string; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: uuid * @description The User the service account acts as. Grant the service account access to other entities by naming this User in their Permissions, or by adding it to a Group. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UserID?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; ServiceAccountCreateOrUpdateResponse: { Error?: components["schemas"]["ResponseError"]; ServiceAccount?: components["schemas"]["ServiceAccount"]; }; /** @description The logical container for most entities in ConfigHub. Namespaces triggers, units, targets, and other entities. */ Space: { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** * Format: uuid * @description Reference to a Filter entity used to identify Attributes for the Space's FunctionExecutor. The Filter's From field must be set to 'Attribute'. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ AttributeFilterID?: string; /** @description Hash of the configurations of the Attributes in AttributeIDs, which changes whenever the Space's function executor does. (readonly) */ readonly AttributeHash?: string; /** @description List of Attribute IDs the Space's function executor is built from: those that match the WhereAttribute and/or AttributeFilterID criteria, or, when neither is set, the Attributes in the Space. (readonly) */ readonly AttributeIDs?: components["schemas"]["UUID"][]; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly BackingUnitID?: string; /** * Format: uuid * @description Reference to the Component this Space is a Variant of. (optional) * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ComponentID?: string; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description An optional set of gates that, if any is present, will block deletion. */ DeleteGates?: { [key: string]: boolean; }; /** @description Friendly name for the entity. */ DisplayName?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** @description The OCI repository the Space's Releases are served from, set when the Space has a ReleaseTargetID. It is oci://:/space/, for a GitOps operator such as Argo CD or Flux to pull: its tag latest is the newest Release published for the Space's current release Target, and a ManifestDigest pins one. The registry is the one GET /api/info advertises to the same caller (OCIHost and OCIPort). Derived when the entity is read rather than stored, and returned whatever select names. (readonly) */ readonly OCIRepositoryURL?: string; /** * Format: uuid * @description Unique identifier for an organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Permissions to access this space. */ Permissions?: components["schemas"]["Permissions"]; /** * Format: uuid * @description Reference to a Target used as the default Target for all Units in this Space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ReleaseTargetID?: string; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: uuid * @description Unique identifier for a space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** * Format: uuid * @description Reference to a Filter entity used to identify Triggers that should be invoked on Units within this Space. The Filter's From field must be set to 'Trigger'. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TriggerFilterID?: string; readonly TriggerHash?: string; /** @description List of Trigger IDs that match the WhereTrigger and/or TriggerFilterID criteria, or, with neither, of the Triggers in the Space. (readonly) */ readonly TriggerIDs?: components["schemas"]["UUID"][]; /** @description The Units the OtherUnitSelections of the Triggers in TriggerIDs selected for this Space, by Trigger and OtherData key, evaluated with TriggerIDs and with the Use permission of whoever made that write. A Trigger run on a Unit in the Space is passed them under the key. A Unit deleted is removed from it. (readonly) */ readonly TriggerOtherUnitIDs?: components["schemas"]["TriggerOtherUnits"][]; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: uuid * @description Reference to the Space this Space takes its configuration from, which promotion takes from: the Space it was cloned from, which a clone sets, or one set since. Setting it requires Use on that Space. (optional) * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UpstreamSpaceID?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; /** * @description Filter expression to identify Attributes that should be registered in the Space's FunctionExecutor. The specified string is an expression for the purpose of filtering * the list of Attributes returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Attribute: Annotations, AttributeID, BackingUnitID, CreatedAt, DataType, DeleteGates, DisplayName, Hash, HiddenReason, Labels, OrganizationID, Parameters, Permissions, ResourceTypePaths, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamAttributeID. * * The whole string must be query-encoded. */ WhereAttribute?: string; /** * @description Filter expression to identify Triggers that should be invoked on Units within this Space. With neither it nor TriggerFilterID, the Triggers in the Space are invoked; a clone of such a Space selects the Triggers in the Space it was cloned from. The specified string is an expression for the purpose of filtering * the list of Triggers returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, OtherUnitSelections, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit. * * The whole string must be query-encoded. */ WhereTrigger?: string; }; SpaceCreateOrUpdateResponse: { Error?: components["schemas"]["ResponseError"]; Space?: components["schemas"]["Space"]; }; /** @description The body of an error response: the error as data (Error), and as one string (message) for clients written before Error. */ StandardErrorResponse: { /** @description The error: its message, category (Type), HTTP status, details, and structured items. */ Error?: components["schemas"]["ResponseError"]; /** @description The error as one string: its message, with any details, items, and individual errors appended. Kept for clients written before Error; new clients read Error. */ message?: string; }; Subjects: { GroupIDs?: { [key: string]: boolean; }; UserIDs?: { [key: string]: boolean; }; }; /** @description Defines a Tag that can be used to identify a set of Revisions across Units. */ Tag: { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** * Format: uuid * @description ChangeOrderID is the optional ID of the ChangeOrder this Tag is associated with. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly ChangeOrderID?: string; /** * Format: uuid * @description ChangeSetID is the optional ID of the ChangeSet this Tag is associated with. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly ChangeSetID?: string; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description An optional set of gates that, if any is present, will block deletion. */ DeleteGates?: { [key: string]: boolean; }; /** @description Friendly name for the entity. */ DisplayName?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** * Format: uuid * @description Unique identifier for an organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Permissions to access this tag. */ Permissions?: components["schemas"]["Permissions"]; /** * Format: uuid * @description ReleaseID is the optional ID of the Release that made this Tag. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly ReleaseID?: string; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: uuid * @description Unique identifier for a space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space this entity belongs to. (readonly) */ readonly SpaceSlug?: string; /** * Format: uuid * @description TagID uniquely identifies a tag within the system. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TagID?: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; TagCreateOrUpdateResponse: { Error?: components["schemas"]["ResponseError"]; Tag?: components["schemas"]["Tag"]; }; /** @description Target represents a deployment target in ConfigHub: where configuration is destined. A Space's Releases are published for its release Target and pulled from ConfigHub's OCI registry by a GitOps tool such as Argo CD or Flux. Access to a Target is granted through its Permissions. */ Target: { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly BackingUnitID?: string; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description An optional set of gates that, if any is present, will block deletion. */ DeleteGates?: { [key: string]: boolean; }; /** @description Friendly name for the entity. */ DisplayName?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description Facts are properties of the infrastructure this Target represents (e.g. a Kubernetes cluster), as a flat string-to-string map. Collected facts use reserved key prefixes such as "Cluster." and are (re)written by fact collection; all other keys are user-defined custom facts. Facts can be referenced in where queries, e.g. Facts.Cluster.KubernetesVersion = '1.31.2'. */ Facts?: { [key: string]: string; }; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** * Format: uuid * @description Unique identifier for an organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Permissions to access this target. */ Permissions?: components["schemas"]["Permissions"]; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: uuid * @description Unique identifier for a space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space this entity belongs to. (readonly) */ readonly SpaceSlug?: string; /** * Format: uuid * @description Unique identifier for a Target. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TargetID?: string; /** * Format: uuid * @description Reference to a Filter entity used to identify Triggers that should be invoked on Units this Target is attached to. The Filter's From field must be set to 'Trigger'. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TriggerFilterID?: string; readonly TriggerHash?: string; /** @description List of Trigger IDs that match the WhereTrigger and/or TriggerFilterID criteria. (readonly) */ readonly TriggerIDs?: components["schemas"]["UUID"][]; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UpstreamTargetID?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; /** * @description Filter expression to identify Triggers that should be invoked on Units this Target is attached to. The specified string is an expression for the purpose of filtering * the list of Triggers returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, OtherUnitSelections, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit. * * The whole string must be query-encoded. */ WhereTrigger?: string; }; TargetCreateOrUpdateResponse: { Error?: components["schemas"]["ResponseError"]; Target?: components["schemas"]["Target"]; }; /** * @description Defines an automated function invocation that executes in response to specific * Unit lifecycle events in ConfigHub. Triggers can be used to implement validation rules, * automated transformations, or other custom logic that should run when configuration * changes occur. Each Trigger is associated with a specific Space and can be configured * to execute on events. * * Triggers can be either validating (checking configuration validity without modifying it) * or mutating (making changes to the configuration). They can be disabled, and validating * triggers can be set to Warn mode to produce non-blocking ValidationWarnings instead of ValidationErrors. */ Trigger: { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** @description Function arguments */ Arguments?: components["schemas"]["FunctionArgument"][] | null; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly BackingUnitID?: string; /** * Format: uuid * @description Unique identifier for a Channel whose client executes the function specified by the Trigger. If it is not specified, the builtin function executor is used. A Trigger that references an Invocation takes the Invocation's. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChannelID?: string; /** @description Classes of guarded reason this trigger's function is cleared for. A path whose guards it does not cover is not written, and the withheld change is reported as a conflict. A trigger running a stored Invocation is cleared for what either names. A stored clearance gets no default: a trigger that should write over an Override guard needs Override in its Clearance. Only meaningful for a mutating trigger, and part of the trigger's Hash. */ Clearance?: components["schemas"]["Clearance"]; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description An optional set of gates that, if any is present, will block deletion. */ DeleteGates?: { [key: string]: boolean; }; /** @description A longer description which explains what the trigger checks and how to fix validation failures. Shown as a pop-up when hovering over an ApplyGate in the UI. */ Description?: string; /** * @description Disabled indicates whether this trigger is currently disabled. * When disabled, the trigger will not be executed even when matching events occur. * @example false */ Disabled?: boolean; /** @description Friendly name for the entity. */ DisplayName?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description Event specifies the type of event that will activate this trigger. Valid values are Mutation and PostClone */ Event: string; /** @description Function name */ FunctionName?: string; /** @description Guards to record on the paths this trigger's function writes, naming the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. {"Trigger":""}, with a Clearance admitting it, holds what the trigger decides against merges and other writes while the trigger keeps writing it. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard), except that deleting the trigger takes back the guards it set on the paths it last wrote, and updating it takes back those it no longer states. Only meaningful for a mutating trigger, and part of the trigger's Hash. */ Guards?: components["schemas"]["GuardStamp"]; /** @description SHA256 hash of the trigger's specification fields, used to detect changes. */ readonly Hash?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** * Format: uuid * @description InvocationID is the identifier of the function to be invoked, if there is a corresponding Invocation. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ InvocationID?: string; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** * Format: uuid * @description Unique identifier for an organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Other Units to pass to the trigger's function as OtherData, by the key the function reads each under, such as policy for vet-validating-admission-policy. Each Unit's head data is passed, and a change to it re-runs the trigger on the Units it applies to. A Unit named here cannot be deleted while the trigger names it. Naming a Unit requires Use permission on it. Empty on a trigger that references an Invocation, which takes the Invocation's. */ OtherUnitIDs?: { [key: string]: components["schemas"]["UUID"]; }; /** @description Selections of other Units to pass to the trigger's function as OtherData, by the key the function reads them under. Each Space that selects the trigger evaluates them when it evaluates its triggers -- when it is created, when its WhereTrigger or TriggerFilterID changes, and on refresh_triggers -- and records the Units each picked in its TriggerOtherUnitIDs. A change to the data of a Unit recorded re-runs the trigger on the Space's Units it applies to, and a Unit recorded can be deleted, which removes it from the record and re-runs the trigger the same way; which Units a selection picks changes only when the Space evaluates it again. A selection's Where may name that Space as EvaluatingSpace, as in `Space.ReleaseTargetID = EvaluatingSpace.ReleaseTargetID`. Only Units of the trigger's ToolchainType are selected, and whoever makes the Space's write needs Use permission on each. The function is passed the selected Units' head data as one entry, only the resources the selection's WhereResource matches if it has one, with each document's origin in OtherDataOrigins; it runs with whatever was selected, nothing included. A key is in either OtherUnitIDs or OtherUnitSelections. */ OtherUnitSelections?: { [key: string]: components["schemas"]["OtherUnitSelection"]; }; /** @description Permissions to access this trigger. */ Permissions?: components["schemas"]["Permissions"]; /** * @deprecated * @description Deprecated: use Guards, as {"Trigger":""}, with a Clearance admitting it. Setting it records that guard and clearance on the trigger instead, so the paths its function writes hold what it wrote against merges and other writes, and the trigger keeps maintaining them; it is not stored, and reads false. Only meaningful for a mutating trigger. * @example false */ Protect?: boolean; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: uuid * @description Unique identifier for a space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space this entity belongs to. (readonly) */ readonly SpaceSlug?: string; /** * @description ToolchainType specifies the type of toolchain this trigger works with. * This determines which configuration formats the trigger can process. * @example Kubernetes/YAML */ ToolchainType: string; /** * Format: uuid * @description TriggerID uniquely identifies a trigger within the system. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TriggerID?: string; /** * Format: uuid * @description References a Filter entity (with From=Unit) to restrict which Units this Trigger applies to. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitFilterID?: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UpstreamTriggerID?: string; /** * @description Validating indicates whether this is a validating function (true) or not (false). * When false, the function can be either mutating (modifying configuration) or readonly returning an AttributeValueList (extracting values without modification). * Validating functions check configuration validity without modifying it. * This value is returned by ConfigHub based on the corresponding property of the specified function. * @example true */ readonly Validating?: boolean; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; /** * @description Warn indicates whether this trigger produces ValidationWarnings instead of ValidationErrors when its validating function fails. ValidationWarnings are non-blocking. * @example false */ Warn?: boolean; /** @description Restricts which resources within a Unit's configuration data the Trigger's function operates on, using ConfigHub metadata path expressions. */ WhereResource?: string; /** @description A filter expression to restrict which Units this Trigger applies to. It takes what the where parameter of the Unit list does, attributes of what a Unit refers to included, as in `Space.Labels.Environment = 'prod'` and `UpstreamUnit.Slug = 'base'`. */ WhereUnit?: string; }; TriggerCreateOrUpdateResponse: { Error?: components["schemas"]["ResponseError"]; Trigger?: components["schemas"]["Trigger"]; }; TriggerOtherUnits: { Key?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TriggerID?: string; UnitIDs?: components["schemas"]["UUID"][] | null; }; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UUID: string; /** @description Unit is the core unit of operation in ConfigHub. It contains a blob of configuration Data of a single supported Config Type (configuration format). This blob is typically a text document that contains a collection of Kubernetes or infrastructure resources, or an application configuration file. Applying / deploying or destroying the configuration happens as a single *transaction* from ConfigHub's perspective. In reality, it is most often a multi-step workflow performed by the underlying configuration / deployment tool. The resources must belong to a single infrastructure provider and the actuation mechanism must be able to resolve references and ordering dependencies among the resources within the document. For example, if one resource needs to be fully provisioned to provide input to another resource, then the actuation code is responsible for handling this. Revisions store historical copies of the configuration data. Configuration data can be restored from prior Revisions. Units can also be cloned to create new variants of a configuration. */ Unit: { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** * @deprecated * @description Deprecated: use ValidationErrors, which this is a copy of. Returned for compatibility with clients written before the field was renamed; it cannot be set. */ readonly ApplyGates?: { [key: string]: boolean; }; /** * @deprecated * @description Deprecated: use ValidationWarnings, which this is a copy of. Returned for compatibility with clients written before the field was renamed; it cannot be set. */ readonly ApplyWarnings?: { [key: string]: boolean; }; /** * Format: uuid * @description Unique identifier for the ChangeSet to which the current Revision belongs. Optional. Units are not required to belong to ChangeSets. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeSetID?: string; readonly Conflicts?: components["schemas"]["MutationConflictList"]; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description The SHA256 hash of the configuration data, encoded as hexadecimal. It is also the ETag the data endpoint serves, so a caller that listed Units can ask for a body conditionally without fetching it first. */ readonly DataHash?: string; /** * Format: int64 * @description The size of the configuration data in bytes. The configuration itself is not part of the Unit; read it from the data endpoint. */ readonly DataSize?: number; /** @description An optional set of gates that, if any is present, will block deletion. */ DeleteGates?: { [key: string]: boolean; }; /** @description An optional set of gates that, if any is present, will block destroy operations. */ DestroyGates?: { [key: string]: boolean; }; /** @description Friendly name for the entity. */ DisplayName?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description IDs of Links originating from this Unit. */ readonly FromLinkID?: components["schemas"]["UUID"][]; /** * Format: int64 * @description Sequence number the head Mutation. */ readonly HeadMutationNum?: number; /** * Format: uuid * @description Unique identifier of the head Revision -- the same Revision HeadRevisionNum numbers. Use include=HeadRevisionNum to expand it. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly HeadRevisionID?: string; /** * Format: int64 * @description Sequence number the head Revision. */ readonly HeadRevisionNum?: number; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** @description LastChangeDescription is a human-readable description of the last change. This description is copied to the new Revision when the Data is changed. */ LastChangeDescription?: string; /** * Format: int64 * @description Sequence number of the last Revision published in a Release, or for a backing Unit the last Revision its entity took. 0 if there is none. */ readonly LastReleasedRevisionNum?: number; readonly LinkFindings?: components["schemas"]["LinkFindingList"]; /** @description Attribute paths that this Unit needs from upstream Units via NeedsProvides Links. Computed from get-needed and stored on data updates. */ readonly NeededPaths?: components["schemas"]["AttributeValue"][]; /** * Format: uuid * @description Unique identifier for an organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Annotations on locations within the Unit's configuration data, by resource and path. */ readonly PathAnnotations?: components["schemas"]["PathAnnotationList"]; /** @description Permissions to access this unit. */ Permissions?: components["schemas"]["Permissions"]; /** @description Attribute paths that this Unit provides to downstream Units via NeedsProvides Links. Computed from get-provided and stored on data updates. */ readonly ProvidedPaths?: components["schemas"]["AttributeInfo"][]; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: uuid * @description Unique identifier for a space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space this entity belongs to. (readonly) */ readonly SpaceSlug?: string; /** * Format: uuid * @description The Target a Release of the Unit's Space publishes the Unit for: the Space's ReleaseTargetID, or none when the Unit is Unreleasable or the Space has no release Target. Read from the Space; set the Space's ReleaseTargetID or the Unit's Unreleasable to change it. (readonly) * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly TargetID?: string; /** @description ToolchainType specifies the type of toolchain for this unit. Possible values include "Kubernetes/YAML", "AppConfig/Properties", "AppConfig/YAML", "AppConfig/TOML", "AppConfig/INI", "AppConfig/JSON", "AppConfig/Env", "AppConfig/Text", "ConfigHub/YAML". */ ToolchainType: string; /** * Format: uuid * @description Unique identifier for a Unit. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; /** @description Leaves the Unit out of its Space's Releases, so that it is delivered to no Target. A Unit that is not Unreleasable is published for its Space's release Target, its TargetID. Defaults to false for Kubernetes/YAML Units and to true for Units of every other toolchain, whose configuration is consumed within ConfigHub. */ Unreleasable?: boolean; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: int64 * @description Sequence number for the Revision of the Unit this unit was cloned from, or 0. This is updated to the upstream Unit's head revision number when the Unit is upgraded. To change this revision number, change the UpstreamLastMergedRevisionNum of the corresponding Link of UpdateType UpgradeUnit from this Unit to the upstream Unit. */ readonly UpstreamRevisionNum?: number; /** * Format: uuid * @description Unique identifier for the Space of the Unit this unit was cloned from, if any. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UpstreamSpaceID?: string; /** * Format: uuid * @description Unique identifier for Unit this unit was cloned from, if any. To change or remove the upstream unit, change or delete the corresponding Link of UpdateType UpgradeUnit from this Unit to the upstream Unit. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UpstreamUnitID?: string; /** @description A map of "//" to true of Triggers invoking validating functions that did not pass on the latest configuration data. These block Release operations. */ readonly ValidationErrors?: { [key: string]: boolean; }; /** @description A map of "//" to true of Triggers invoking validating functions that executed and passed on the latest configuration data, whether or not they have Warn=true. Read from the head Revision, which records it. */ readonly ValidationPassed?: { [key: string]: boolean; }; /** @description A map from gate/warning name to the list of validation results that caused the gate or warning. */ readonly ValidationResults?: { [key: string]: components["schemas"]["ValidationResultList"]; }; /** @description A map of "//" to true of validating Triggers that had nothing to check in the latest configuration data: their WhereResource selects no resource in it, so their functions were not invoked. Read from the head Revision, which records it. */ readonly ValidationSkipped?: { [key: string]: boolean; }; /** @description Map from each gate name in ValidationErrors and ValidationWarnings, and in the head Revision's ValidationPassed and ValidationSkipped, to the ID of the Trigger that produced it. A gate no Trigger produced has no entry. The Trigger may since have been renamed, moved, or deleted, so find it by this ID rather than by the slugs in the gate name. */ readonly ValidationTriggerIDs?: { [key: string]: components["schemas"]["UUID"]; }; /** @description A map of "//" to true of Triggers with Warn=true invoking validating functions that did not pass on the latest configuration data. These do not block Release operations. */ readonly ValidationWarnings?: { [key: string]: boolean; }; /** @description Map from each key in Values to the ID of the Trigger that produced it. */ readonly ValueTriggerIDs?: { [key: string]: components["schemas"]["UUID"]; }; /** @description Map from "//" to the first output Value with that attribute name of the function invocation specified by the Trigger. Units not resolved since the Space slug was added have "/" keys. */ readonly Values?: { [key: string]: string; }; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; UnitBlame: { /** @description Why the unit's blame could not be read, in a SearchUnitBlame response. */ Error?: components["schemas"]["ResponseError"]; /** @description The unit's fields the request selected, each with what set its value and everything else recorded about it, in resource and path order. */ Fields?: components["schemas"]["BlameField"][]; /** * Format: uuid * @description The Space of the unit. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** * Format: uuid * @description The unit. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; }; UnitConflictSelector: { /** @description Match Guarded and GuardWithheld conflicts every one of whose guards is named here, as key or key=value; empty matches any conflict, guarded or not */ Guards?: string[]; /** @description Match conflicts at this path; empty matches any path, including resource-level conflicts. An element of a list may be named by position (spec.data.0.secretKey), by merge key (containers.?name=main.image), or as the conflict records it, and * matches any one list element or map key (spec.data.*.secretKey). With Undismiss, the path names dismissals as Permanent recorded them: empty, the one on the resource as a whole; *, every one; a path, the one recorded at that path, a pattern included. */ Path?: string; /** @description Match conflicts dropped for this reason, as their Reason names it; empty matches any reason */ Reason?: string; /** @description Match conflicts on this resource, by its whole name (namespace/name, or /name for a cluster-scoped Kubernetes resource) or a name it had before a rename; empty matches any resource */ ResourceName?: string; /** @description Match conflicts on every resource with this name without its namespace, now or before a rename; empty matches any. With Permanent or Undismiss it has to match only one resource. */ ResourceNameWithoutScope?: string; /** @description Match conflicts on resources of this type, in any API version; empty matches any type. With ResourceName, it picks out one of several resources of that name. */ ResourceType?: string; }; UnitConflictsRequest: { /** @description Apply re-applies the withheld change; Dismiss drops the conflict without changing the configuration data; Undismiss removes dismissals recorded with Permanent */ Action?: string; /** * Format: uuid * @description The ChangeSet open on the Unit, which a request that creates a Revision of a Unit in a ChangeSet has to name: a ChangeSet locks the Units it is open on. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeSetID?: string; /** @description With Apply, the classes of guarded reason the applied changes are cleared for, as a list of {Key, Operator, Values} requirements. A withheld value is written only where the guards at its path admit this clearance, and a withheld guard change only where the guards already at its path do; the request is refused otherwise. Not taken by Dismiss or Undismiss, which write no configuration data and no guards. */ Clearance?: components["schemas"]["Clearance"]; /** @description Report what the request would do without writing anything. The response carries the Unit as it would be. */ DryRun?: boolean; /** @description With Dismiss, also dismiss the conflicts each selector matches whenever a later merge reports them. Each selector names one resource, by ResourceName or ResourceNameWithoutScope, and a Reason, and Guards for a guard-caused reason; an empty Path covers every path of the resource. */ Permanent?: boolean; /** @description Which outstanding conflicts to act on. Empty acts on all of them. Permanent and Undismiss need at least one, each naming a ResourceName or ResourceNameWithoutScope, and for Permanent a Reason. */ Select?: components["schemas"]["UnitConflictSelector"][]; }; UnitConflictsResponse: { /** @description Number of conflicts whose withheld change was applied */ Applied?: number; /** @description The Unit's outstanding conflicts after the request */ Conflicts?: components["schemas"]["MutationConflictList"]; /** @description What applying the withheld changes changed in the configuration, or would change for a dry run, path by path with the values on both sides */ Diff?: components["schemas"]["ConfigDiff"]; /** @description Number of conflicts dropped without changing the configuration data */ Dismissed?: number; Error?: components["schemas"]["ResponseError"]; /** @description Number of permanent dismissals recorded, each a reason (or a reason and a guard) at one path of one resource */ Recorded?: number; /** @description Number of permanent dismissals removed by Undismiss */ Removed?: number; /** @description The Unit as the request left it, or would have left it for a dry run */ Unit?: components["schemas"]["Unit"]; }; UnitCreateOrUpdateResponse: { /** @description The gates closing the Unit's ChangeSet was judged against, when the write closed, or on a dry run would close, a ChangeSet a ChangeWorkflow governs. Returned for every Unit of the ChangeSet the write detaches. A close the gates refuse fails every such Unit alike, so a write detaching nothing else answers with the refusal alone, whose items name each gate that does not hold, by Space. */ ChangeSetClose?: components["schemas"]["ChangeSetCloseResult"]; /** @description The configuration the operation produced; returned when include names ConfigData. */ ConfigData?: string; /** @description What this write could not apply: for an upgrade, merge or resolve, each change it withheld, and for any write, each value whose guards its clearance did not cover (Guarded) and each guard change it was not cleared to make (GuardWithheld). For a dry run, what it would withhold. Unit.Conflicts lists every conflict outstanding on the Unit, including those earlier operations left. */ Conflicts?: components["schemas"]["MutationConflictList"]; /** @description What the operation changed, or on a dry run would change, path by path with the values on both sides; returned when include names Diff. */ Diff?: components["schemas"]["ConfigDiff"]; Error?: components["schemas"]["ResponseError"]; Links?: components["schemas"]["LinkCreateOrUpdateResponse"][]; /** @description What set each value in the configuration the operation produced; returned when include names MutationSources. */ MutationSources?: components["schemas"]["ResourceMutationList"]; Unit?: components["schemas"]["Unit"]; }; UnitData: { /** @description The configuration data. */ Data?: string; /** @description SHA256 of the configuration data, which is also the ETag the single-Unit data endpoint serves. */ DataHash?: string; /** * Format: int64 * @description Size of the configuration data in bytes. */ DataSize?: number; /** @description Slug of the Unit. */ Slug?: string; /** * Format: uuid * @description Unique identifier of the Space the Unit belongs to. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space the Unit belongs to. */ SpaceSlug?: string; /** * Format: uuid * @description Unique identifier of the Unit. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; }; UnitDiff: { /** @description What changed from the From Revision to the To Revision */ Diff?: components["schemas"]["ConfigDiff"]; Error?: components["schemas"]["ResponseError"]; /** * Format: int64 * @description The Revision on the From side; 0 when the Unit has none there and the diff is against nothing */ FromRevisionNum?: number; /** * Format: uuid * @description The Space of the Unit * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** * Format: int64 * @description The Revision on the To side; 0 when the Unit has none there and the diff is against nothing */ ToRevisionNum?: number; /** * Format: uuid * @description The Unit * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; }; UnitGuardRequest: { /** @description Recorded on the Revision the edit creates. Defaults to "Set path guards". */ ChangeDescription?: string; /** * Format: uuid * @description The ChangeSet open on the Unit, which a request that creates a Revision of a Unit in a ChangeSet has to name: a ChangeSet locks the Units it is open on. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeSetID?: string; /** @description The classes of reason this edit is cleared for; required to edit a path that already carries guards */ Clearance?: components["schemas"]["Clearance"]; /** @description Per-resource guard edits to apply to the Unit's PathAnnotations */ ResourceGuards?: components["schemas"]["ResourceGuards"][] | null; }; UnitGuardResponse: { /** @description The Unit's PathAnnotations after applying the guard edits */ PathAnnotations?: components["schemas"]["PathAnnotationList"]; }; UnitMoveRequest: { /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ToSpaceID?: string; }; UnitMoveResponse: { Error?: components["schemas"]["ResponseError"]; Moved?: boolean; MovedLinkSlugs?: string[]; Resolving?: boolean; Slug?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TargetID?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; }; UnitMutationSources: { /** @description SHA256 of the configuration data the MutationSources describe. */ DataHash?: string; /** @description Sources of mutations affecting the configuration data, by resource and path. */ MutationSources?: components["schemas"]["ResourceMutationList"]; /** @description Slug of the Unit. */ Slug?: string; /** * Format: uuid * @description Unique identifier of the Space the Unit belongs to. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space the Unit belongs to. */ SpaceSlug?: string; /** * Format: uuid * @description Unique identifier of the Unit. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; }; UnitPathReport: { /** @description The path's own annotations other than guards, their inheritance and conflict dismissals, by kind. The field's Guards are those that apply to it, its ancestors' and its resource's included. */ Annotations?: { [key: string]: { [key: string]: string; }; }; /** @description The field's chain: the changes that put the value here, from this unit out to where it was set, each with the Mutation and Revision it was read from. */ Changes?: components["schemas"]["BlamePathChange"][]; /** @description The comments the unit's configuration has about the field: above it, at the end of its line, and below it. Absent when it has none. */ ConfigComments?: components["schemas"]["BlameConfigComments"]; /** @description Every conflict dismissal covering the field, each with the Path it is recorded at: the field's, a pattern naming it, or empty for one on its resource as a whole. */ ConflictDismissals?: components["schemas"]["BlameConflictDismissal"][]; /** @description The field, as the unit's blame reports it, without its Chain: Changes carries the chain with its records. */ Field?: components["schemas"]["BlameField"]; /** @description Every change this unit recorded to the field, oldest first; returned when history is requested. */ History?: components["schemas"]["BlamePathChange"][]; /** @description Names of the entities the report's records refer to by ID alone: as space/slug, the other unit of each conflict, each Link's upstream unit and each merge source; by slug, or space/slug in another Space, each Release's Target and the ReviewThread's ChangeOrder; and by username, the author of each comment of the ReviewThread. */ Names?: { [key: string]: string; }; /** @description ReleaseState in words, naming the revisions. */ ReleaseMessage?: string; /** @description Whether the unit's last Release includes the value: Released, NeverReleased, ChangedSinceRelease, or NothingToRelease in a Space with no release Target. Absent for a field the unit does not have. */ ReleaseState?: string; /** @description The thread of ReviewComments about the field that was commented in most recently: those naming its resource and path, the path as written or naming the same element. Absent when there is none. */ ReviewThread?: components["schemas"]["BlameReviewThread"]; /** @description How many threads of ReviewComments are about the field, ReviewThread among them. */ ReviewThreads?: number; }; UnitProtectionRequest: { /** @description Recorded on the Revision the edit creates. Defaults to "Set path protection". */ ChangeDescription?: string; /** * Format: uuid * @description The ChangeSet open on the Unit, which a request that creates a Revision of a Unit in a ChangeSet has to name: a ChangeSet locks the Units it is open on. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeSetID?: string; /** @description Per-resource edits: a path mapped to true gets the Unit's Override guard (Override=Upstream for a Unit with an upstream Unit, Override=External for one without), and one mapped to false loses its Override guard */ ResourceProtection?: components["schemas"]["ResourceProtection"][] | null; /** @description Remove every Override guard the Unit has before applying ResourceProtection */ UnprotectAll?: boolean; }; UnitProtectionResponse: { Error?: components["schemas"]["ResponseError"]; /** @description The Unit's MutationSources after applying the protection edits */ MutationSources?: components["schemas"]["ResourceMutationList"]; }; UnitTagRequest: { /** @description Move the Tag from the Revision it marks on each Unit to the one Revision names, refusing a Unit it marks no Revision of. Tags owned by a ChangeSet, ChangeOrder or Release cannot be added or removed; a ChangeOrder's release Tag can be moved, to a Revision at or after the one its end Tag marks and the Unit's LastReleasedRevisionNum, with no ValidationErrors, while no Release in the Space has been published at it. */ Move?: boolean; /** @description Which Unit revision to tag: a named revision ('HeadRevisionNum', 'LastReleasedRevisionNum'), a revision number, an entity reference ('Tag:uuid', 'ChangeSet:uuid', 'Revision:uuid'), any of those prefixed with 'Before:', or 'Remove' to remove the tag from the unit */ Revision?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TagID?: string; }; UnitTagResponse: { Error?: components["schemas"]["ResponseError"]; Message?: string; }; UploadBrokenEdge: { Cycle?: string[]; From?: string; Kind?: string; Reason?: string; To?: string; }; UploadComponentRequest: { /** @description Take over the backing Unit of an entity a document describes when another source owns it. Without it, that document is refused. */ Adopt?: boolean; /** @description The Space, by slug, for the backing Units of the bundle's Space and Component documents; it may be the component's own Space. Required when the bundle has either. */ BackingUnitSpace?: string; /** @description Synthesize the release Namespace if the bundle lacks it and it is not one every cluster has (default, kube-node-lease, kube-public, kube-system). Off by default. */ CreateNamespace?: boolean; /** @description Names of the components this one depends on, recorded by ComponentID in the Space's DependsOn annotation. Each Component must already exist. Requires a Variant Space label. */ DependsOn?: string[]; /** @description The component name. Without one, Space must name an existing Space, which is written into as it is, with no Component and no labels set, and SourceName is required. */ Name?: string; /** @description The release namespace. Required when the bundle has namespaced resources that name no namespace. */ Namespace?: string; /** @description Prepended to the slugs of new Units, so two releases can share one Space. */ SlugPrefix?: string; /** @description Ownership name within the component's Spaces. Default: Name. */ SourceName?: string; /** @description Explicit Space slug, overriding SpacePattern. */ Space?: string; SpaceAnnotations?: { [key: string]: string; }; /** @description Set on Spaces the upload creates. */ SpaceDeleteGates?: { [key: string]: boolean; }; /** @description Merged over UploadRequest.SpaceLabels. */ SpaceLabels?: { [key: string]: string; }; /** * Format: uuid * @description Becomes the release Target of the component's Spaces, to which a Release of each Space publishes its Units that are not Unreleasable. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TargetID?: string; UnitAnnotations?: { [key: string]: string; }; /** @description Set on Units the upload creates. */ UnitDeleteGates?: { [key: string]: boolean; }; /** @description Set on Units the upload creates. */ UnitDestroyGates?: { [key: string]: boolean; }; /** @description Set on every Unit the source writes. */ UnitLabels?: { [key: string]: string; }; }; UploadComponentResult: { /** @description Inferred links dropped to keep the link graph acyclic. */ BrokenLinks?: components["schemas"]["UploadBrokenEdge"][]; Name?: string; /** @description Set when CreateNamespace was asked for but the bundle already carried the release Namespace. */ NamespaceCollision?: components["schemas"]["UploadNamespaceCollision"]; /** @description Secret resources dropped from the bundle, as Kind/namespace/name. Secrets are never uploaded. */ SkippedSecrets?: string[]; SourceName?: string; Spaces?: components["schemas"]["UploadSpaceResult"][]; /** @description References that resolved to no resource in the bundle. */ UnmatchedReferences?: components["schemas"]["UploadUnmatchedReference"][]; }; UploadDuplicate: { /** @description The other Units that define the resource. */ Others?: components["schemas"]["UploadUnitRef"][]; /** @description The resource identity, as in UploadUnitResult.Resource. */ Resource?: string; /** @description The slug of this upload's Unit for the resource. */ Slug?: string; }; UploadEntityResult: { /** @description Create, Update, Unchanged, Pending (its backing Unit's Triggers had not reached a verdict in time), Skipped (an entity it names failed or is pending), or Prune (its backing Unit is empty, and a bulk delete with from_backing_units deletes it). */ Action?: string; /** * Format: uuid * @description Absent for an entity a dry run would create, or one not written. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ EntityID?: string; EntityType?: string; Error?: components["schemas"]["ResponseError"]; Slug?: string; }; UploadLinkResult: { /** @description Create, Update (a Link an earlier upload created that is cleared for less than it now needs: a Link from a carrier's placeholder Unit is cleared for the Link=Upsert guard of the ConfigMaps rendered into it), or Unchanged. */ Action?: string; Error?: components["schemas"]["ResponseError"]; FromUnit?: string; /** * Format: uuid * @description Absent for a Link a dry run would create. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ LinkID?: string; /** @description Why the link was inferred, e.g. reference:v1/ConfigMap. */ Reason?: string; ToUnit?: string; }; UploadNamespaceCollision: { /** @description The release Namespace the bundle already carries. */ Namespace?: string; }; UploadRegistryCredentials: { /** @description The password, or an access token for registries that issue them. */ Password?: string; /** @description The registry username. */ Username?: string; }; UploadRequest: { /** @description Recorded on each Unit write. */ ChangeDescription?: string; ChangeSetDescription?: string; /** * Format: uuid * @description An existing ChangeSet to record the writes in. Default: one new ChangeSet per Space. The upload closes it afterwards, unless a ChangeWorkflow governs it. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeSetID?: string; /** * Format: uuid * @description The ChangeWorkflow governing the ChangeSet the upload opens, which a Space whose Component requires one needs. A ChangeSet a ChangeWorkflow governs is left open, with the Units the upload wrote in it, since closing it is gated on the workflow's Final prerequisites. Not accepted with ChangeSetID, whose ChangeSet names its own. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeWorkflowID?: string; /** @description The guarded reasons the Unit writes are cleared for. A path whose guards this does not cover is not written, and the withheld change is reported in the Unit's Conflicts. */ Clearance?: components["schemas"]["Clearance"]; /** @description Placement of each component. Exactly one is supported. */ Components?: components["schemas"]["UploadComponentRequest"][]; /** @description Plan the upload and return the same response without writing anything. */ DryRun?: boolean; /** @description The bundle's files. Paths must be relative and may not contain "..". Exactly one of Files and Source.Pull is given. */ Files?: components["schemas"]["UploadRequestFile"][]; /** @description The bundle is part of what its source owns: Units the source owns that it leaves out are left alone rather than emptied. */ Partial?: boolean; Source?: components["schemas"]["UploadSourceInfo"]; /** @description Labels applied to every Space, merge-patch: keys given are set, keys omitted are left alone. */ SpaceLabels?: { [key: string]: string; }; /** @description Slug pattern for created Spaces, over the Space's Component and labels. Default {{.Component.Slug}}-{{.Labels.Variant}}. */ SpacePattern?: string; /** @description A category recorded on the Mutations of each Unit write. Alphanumeric, at most 64 characters, and not starting with ConfigHub. */ Subgroup?: string; /** * Format: uuid * @description A Tag to put on the Revision each Unit the upload writes is left at, created Units included. Units the upload leaves Unchanged are not tagged. Requires Use permission on the Tag; a ChangeSet's or ChangeOrder's own Tag is refused. An upload with a Unit to write that the Tag already marks fails, and nothing is written. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TagID?: string; }; UploadRequestFile: { /** @description The file's contents. */ Content?: string; /** @description Relative path within the bundle, e.g. backend.yaml. */ Path?: string; }; UploadResult: { Components?: components["schemas"]["UploadComponentResult"][]; /** @description True when nothing was written. */ DryRun?: boolean; /** @description Digest of the planned actions. */ Plan?: string; /** @description The digest of the manifest the server pulled, when Source.Pull was set. Send it as Source.Digest to upload exactly the bundle a dry run read. */ SourceDigest?: string; }; UploadSourceInfo: { /** @description The client that uploaded: cub, installer, ui. */ Client?: string; ClientVersion?: string; /** @description Registry credentials for the pull. Used for this request only; never stored, logged, or returned. */ Credentials?: components["schemas"]["UploadRegistryCredentials"]; /** @description The resolved digest, when the transport has one. */ Digest?: string; /** @description Fetch the bundle from Ref, an oci:// reference, instead of taking Files. With Digest set, that manifest is fetched rather than whatever Ref's tag names now. */ Pull?: boolean; /** @description Where the bundle came from, e.g. oci://ghcr.io/confighub/configs/cubbychat:1.4.0 or a local path. */ Ref?: string; }; UploadSpaceResult: { /** @description Create, Update, or Unchanged. */ Action?: string; /** * Format: uuid * @description The ChangeSet the writes were recorded in. Absent on a dry run. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ChangeSetID?: string; /** @description The upload left the ChangeSet open, with the Units it wrote in it, because a ChangeWorkflow governs it: closing it is gated on the workflow's Final prerequisites. */ ChangeSetOpen?: boolean; /** @description Resources this upload writes that other Units deployed to the same Target also define: the Space's other Units, and when the Space has a Target, Units elsewhere on that Target. */ Duplicates?: components["schemas"]["UploadDuplicate"][]; Links?: components["schemas"]["UploadLinkResult"][]; Namespace?: string; /** * Format: uuid * @description Absent for a Space a dry run would create. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; SpaceSlug?: string; /** @description The Triggers the uploaded configuration needs: one keeping a hash of each ConfigMap that pod templates carry hash annotations for, and one pruning the immutable ConfigMaps it renders. */ Triggers?: components["schemas"]["UploadTriggerResult"][]; Units?: components["schemas"]["UploadUnitResult"][]; }; UploadTriggerResult: { /** @description Create (in the Space, which runs the Triggers defined in it), Update (a Trigger of the pack that an earlier upload created in the Space, which gets the guards and clearance the pack now states), Unchanged (the Space already runs a Mutation Trigger with the function, or one with the slug is in the Space), or Missing (the Space selects its Triggers from elsewhere, and none it selects runs the function). */ Action?: string; Error?: components["schemas"]["ResponseError"]; /** @description The function the Trigger runs. */ Function?: string; /** @description The Trigger's slug: the one upload creates, or, when the Space already runs a Trigger with the function, that Trigger's. */ Slug?: string; /** @description The Space the Trigger is in. Absent when Missing. */ SpaceSlug?: string; /** * Format: uuid * @description Absent for a Trigger a dry run would create, or a Missing one. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ TriggerID?: string; }; UploadUnitRef: { /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; SpaceSlug?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; UnitSlug?: string; }; UploadUnitResult: { /** @description Create, Update, Unchanged, Empty, Revive, or Adopt. */ Action?: string; /** @description Paths withheld because they were overridden locally or guarded. */ Conflicts?: components["schemas"]["MutationConflictList"]; /** @description The same change path by path, with the values on both sides. Returned when include names Diff. */ Diff?: components["schemas"]["ConfigDiff"]; /** @description For a BackingUnit, what became of the entity its document describes. */ Entity?: components["schemas"]["UploadEntityResult"]; Error?: components["schemas"]["ResponseError"]; /** @description What the write changed, or on a dry run would change: the entries of the Unit's MutationSources it produced. Returned when include names Mutations. */ Mutations?: components["schemas"]["ResourceMutationList"]; /** @description The resource identity this Unit is keyed by. */ Resource?: string; /** @description Resource, AppConfig, AppConfigRendered, or BackingUnit. */ Role?: string; Slug?: string; /** * Format: uuid * @description Absent for a Unit a dry run would create. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UnitID?: string; }; UploadUnmatchedReference: { FromUnit?: string; TargetName?: string; TargetType?: string; }; /** @description a User in Confighub. */ User: { /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description Friendly name for the entity. */ DisplayName?: string; /** @description The type of entity. */ readonly EntityType?: string; /** @description Unique identifier for the External Identity Provider record matching this User. */ ExternalID?: string; /** @description The Groups the User belongs to, from the identity provider's claims at their last login. A bot User's Groups are the ones it was added to through the Group API instead. (readonly) */ GroupIDs?: components["schemas"]["UUID"][]; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description The URL to get the profile avatar picture of the User. */ ProfilePictureURL?: string; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: uuid * @description Unique identifier for a User. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UserID?: string; /** @description Unique username for a User. Must be unique for all of Confighub. */ Username?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; UserKey: { /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; Description?: string; /** @description Friendly name for the entity. */ DisplayName?: string; /** @description The type of entity. */ readonly EntityType?: string; /** * Format: date-time * @example 2006-01-02T15:04:05Z07:00 */ ExpiresAt?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; Kid?: string; /** * Format: date-time * @example 2006-01-02T15:04:05Z07:00 */ LastUsedAt?: string; PublicJWK?: unknown; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UserID?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UserKeyID?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; /** @description The record of a long-lived token issued to a ServiceAccount. The token itself is shown once, when it is issued, and is not stored; this record is what lets it be listed, traced to whoever issued it, and revoked on its own. */ UserToken: { /** * Format: date-time * @description When the token was issued. (readonly) * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** * Format: uuid * @description The User who issued the token. A token is never issued by the identity it authenticates as. (readonly) * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ CreatedByUserID?: string; /** @description Which system holds the token, so it can be retired without guessing what breaks. */ Description?: string; /** @description Friendly name for the entity. */ DisplayName?: string; /** @description The type of entity. */ readonly EntityType?: string; /** * Format: date-time * @description When the token stops working. Zero when it does not expire. * @example 2006-01-02T15:04:05Z07:00 */ ExpiresAt?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description The token's jti claim, which the token carries; a where clause names a token by it, as cub does. (readonly) */ Jti?: string; /** * Format: date-time * @description When the token was last exchanged at the registry, stamped at most once per cache period per server. Zero when it has not been used. (readonly) * @example 2006-01-02T15:04:05Z07:00 */ LastUsedAt?: string; /** * Format: date-time * @description When the token was revoked. Zero when it is live. (readonly) * @example 2006-01-02T15:04:05Z07:00 */ RevokedAt?: string; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: uuid * @description The User the token authenticates as: the ServiceAccount's User. (readonly) * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UserID?: string; /** * Format: uuid * @description Unique identifier for the record, by which the API addresses the token. (readonly) * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ UserTokenID?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; }; ValidationResult: { /** @description Deprecated. Use Issues or FailedAttributes instead. Optional list of failure details when not associated with specific attributes/paths. */ Details?: string[]; /** @description optional list of failed attributes/paths and issues found for them. Preferred over Issues and Details. */ FailedAttributes?: components["schemas"]["AttributeValueList"]; /** @description Name of the function invocation corresponding to the result */ FunctionName?: string; /** @description Index of the function invocation corresponding to the result. Useful in the case that multiple function invocations in the same executor call return ValidationResultList output. */ Index: number; /** @description Issues found with the configuration unit that are not associated with specific attributes/paths. Use FailedAttributes where possible. */ Issues?: components["schemas"]["Issue"][]; /** @description Maximum score of all findings */ MaxScore?: string; /** @description True if valid, false otherwise */ Passed: boolean; }; ValidationResultList: components["schemas"]["ValidationResult"][]; /** @description Defines an entity view. */ View: { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string; }; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly BackingUnitID?: string; /** @description Columns to display, in order. (optional) */ Columns?: components["schemas"]["Column"][]; /** * Format: date-time * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly CreatedAt?: string; /** @description An optional set of gates that, if any is present, will block deletion. */ DeleteGates?: { [key: string]: boolean; }; /** @description Friendly name for the entity. */ DisplayName?: string; /** @description The type of entity. */ readonly EntityType?: string; /** * Format: uuid * @description FilterID identifies a filter. At least one of FilterID or Of must be specified. (optional) * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ FilterID?: string; /** @description Column to group by (optional). */ GroupBy?: string; /** @description SHA256 hash of the view's specification fields encoded as hexadecimal: FilterID, Of, Columns, GroupBy, OrderBy and OrderByDirection. (readonly) */ readonly Hash?: string; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string; }; /** @description Entity type to view (e.g., Unit, Space). At least one of FilterID or Of must be specified. If both are specified, Of must match Filter.From. (optional) */ Of?: string; /** @description Column to sort by. (optional) */ OrderBy?: string; /** @description Columnn sort order, ASC or DESC. Default is ASC. Only should be specified if OrderBy is specified. (optional) */ OrderByDirection?: string; /** * Format: uuid * @description Unique identifier for an organization. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ OrganizationID?: string; /** @description Permissions to access this view. */ Permissions?: components["schemas"]["Permissions"]; /** @description Unique URL-safe identifier for the entity. */ Slug: string; /** * Format: uuid * @description Unique identifier for a space. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ SpaceID?: string; /** @description Slug of the Space this entity belongs to. (readonly) */ readonly SpaceSlug?: string; /** * Format: date-time * @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. * @example 2025-04-04T11:50:02.95102-07:00 */ readonly UpdatedAt?: string; /** * Format: uuid * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ readonly UpstreamViewID?: string; /** * Format: int64 * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number; /** * Format: uuid * @description ViewID uniquely identifies a view within the system. * @example 248df4b7-aa70-47b8-a036-33ac447e668d */ ViewID?: string; }; ViewColumn: { Name?: string; Value?: string; }; ViewCreateOrUpdateResponse: { Error?: components["schemas"]["ResponseError"]; View?: components["schemas"]["View"]; }; WithheldGuard: { /** @description The guard key the operation was not cleared for */ Key?: string; /** @description True when the clearance forbade this key with DoesNotExist rather than simply not covering it */ Precondition?: boolean; /** @description The guard value */ Value?: string; }; }; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } interface operations { BulkDeleteComponents: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Components returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Component: AllowedChangeWorkflowIDs, Annotations, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrganizationID, Permissions, RequireChangeTracking, RequireChangeWorkflow, Slug, UpdatedAt, UpstreamComponentID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Component list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Component). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Component include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Component entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Component. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Component entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Component entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Prune: of the Components selected, delete those whose backing Unit is empty, which says the Component should not exist, and keep the Unit, empty and backing nothing, so that it keeps the Component's history and a document that comes back revives it. The others are left alone and are not in the response, so a broad selection deletes only what was emptied. */ from_backing_units?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Component request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Component not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Component is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete entity */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Component. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkPatchComponents: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Components returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Component: AllowedChangeWorkflowIDs, Annotations, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrganizationID, Permissions, RequireChangeTracking, RequireChangeWorkflow, Slug, UpdatedAt, UpstreamComponentID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Component list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Component). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Component include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Component entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Component. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Component entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Component entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Give each Component written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Component's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description The Space, by slug or ID, for the backing Units with_backing_units creates. Required with it: a Component is in no Space of its own to hold one. */ backing_unit_space?: string; /** @description Patch each selected Component with what its backing Unit holds that it has not taken yet: the change to the Unit since its LastReleasedRevisionNum. The request body is applied after it. Selecting one with no backing Unit is an error, and so are outstanding ValidationErrors on a backing Unit. */ from_backing_units?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { AllowedChangeWorkflowIDs?: (string | null)[] | null; /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; RequireChangeTracking?: boolean | null; RequireChangeWorkflow?: boolean | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ComponentCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ComponentCreateOrUpdateResponse"][]; }; }; /** @description Component request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Component not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Component data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Component. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkDeleteServiceAccounts: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ServiceAccounts returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ServiceAccount: Annotations, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrgRole, OrganizationID, Permissions, ServiceAccountID, Slug, UpdatedAt, UserID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ServiceAccount list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ServiceAccount). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ServiceAccount include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden ServiceAccount entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for ServiceAccount. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ServiceAccount are OrganizationID, Permissions. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of ServiceAccount entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the ServiceAccount entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description ServiceAccount request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete entity */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ServiceAccount. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkPatchServiceAccounts: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ServiceAccounts returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ServiceAccount: Annotations, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrgRole, OrganizationID, Permissions, ServiceAccountID, Slug, UpdatedAt, UserID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ServiceAccount list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ServiceAccount). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ServiceAccount include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden ServiceAccount entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for ServiceAccount. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ServiceAccount are OrganizationID, Permissions. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of ServiceAccount entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the ServiceAccount entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; OrgRole?: string | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ServiceAccountCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ServiceAccountCreateOrUpdateResponse"][]; }; }; /** @description ServiceAccount request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ServiceAccount. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkCreateSpaces: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Spaces returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, TriggerOtherUnitIDs, UpdatedAt, UpstreamSpaceID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Space list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Space). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Space include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Space entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Space. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Space are AttributeFilterID, AttributeIDs, ComponentID, OrganizationID, Permissions, ReleaseTargetID, TriggerFilterID, TriggerIDs, UpstreamSpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Space entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Space entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Comma-separated list of prefixes to apply to cloned Space names */ name_prefixes?: string; /** @description Comma-separated list of labels with multiple values for cloned Space labels, in the format of key1=value1|value2,key2=value1|value2|value3 */ variant_labels?: string; /** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */ name_pattern?: string; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description Give each Space written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Space's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description The Space, by slug or ID, for the backing Units with_backing_units creates. Required with it: a Space is in no Space of its own to hold one. */ backing_unit_space?: string; /** @description Create Spaces from the ConfigHub/YAML Units where_unit and filter_unit select, each in its Unit's Space, and each with its Unit as its backing Unit. The request body is applied after the Unit's document. Units of other toolchains or describing other entity types are passed over; outstanding ValidationErrors on a Unit are an error. Takes none of the parameters that select entities to clone, name the clones or choose their Spaces. */ from_backing_units?: boolean; /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * The Units to create entities from, with from_backing_units. * * The whole string must be query-encoded. */ where_unit?: string; /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */ filter_unit?: string; /** @description With from_backing_units, patch a Space a selected Unit already backs with what the Unit holds that it has not taken yet, as a bulk patch with from_backing_units does, rather than report that the Unit backs it. The request body is applied after it. Without it, such a Unit is an error, or with allow_exists the Space is returned as it is. */ patch_existing?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** Format: uuid */ AttributeFilterID?: string | null; /** Format: uuid */ ComponentID?: string | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; /** Format: uuid */ ReleaseTargetID?: string | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** Format: uuid */ TriggerFilterID?: string | null; /** Format: uuid */ UpstreamSpaceID?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; WhereAttribute?: string | null; WhereTrigger?: string | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["SpaceCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status (partial success) */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SpaceCreateOrUpdateResponse"][]; }; }; /** @description Space request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Space. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkDeleteSpaces: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Spaces returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, TriggerOtherUnitIDs, UpdatedAt, UpstreamSpaceID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Space list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Space). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Space include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Space entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Space. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Space are AttributeFilterID, AttributeIDs, ComponentID, OrganizationID, Permissions, ReleaseTargetID, TriggerFilterID, TriggerIDs, UpstreamSpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Space entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Space entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Valid values are true and false. False is the default if unspecified. If true, recursively delete all entities within the deleted space(s) so long as none have delete gates. */ recursive?: string; /** @description Valid values are true and false. False is the default if unspecified. If true, recursively delete all entities within the deleted space(s) regardless whether any have delete gates. */ recursive_force?: string; /** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */ detach?: boolean; /** @description Prune: of the Spaces selected, delete those whose backing Unit is empty, which says the Space should not exist, and keep the Unit, empty and backing nothing, so that it keeps the Space's history and a document that comes back revives it. The others are left alone and are not in the response, so a broad selection deletes only what was emptied. */ from_backing_units?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Space request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete entity */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Space. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkPatchSpaces: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Spaces returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, TriggerOtherUnitIDs, UpdatedAt, UpstreamSpaceID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Space list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Space). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Space include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Space entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Space. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Space are AttributeFilterID, AttributeIDs, ComponentID, OrganizationID, Permissions, ReleaseTargetID, TriggerFilterID, TriggerIDs, UpstreamSpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Space entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Space entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description If true, re-list the Triggers the Space selects (with WhereTrigger and/or TriggerFilterID, or the ones in it with neither) even if these fields have not changed */ refresh_triggers?: boolean; /** @description Give each Space written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Space's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description The Space, by slug or ID, for the backing Units with_backing_units creates. Required with it: a Space is in no Space of its own to hold one. */ backing_unit_space?: string; /** @description Patch each selected Space with what its backing Unit holds that it has not taken yet: the change to the Unit since its LastReleasedRevisionNum. The request body is applied after it. Selecting one with no backing Unit is an error, and so are outstanding ValidationErrors on a backing Unit. */ from_backing_units?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** Format: uuid */ AttributeFilterID?: string | null; /** Format: uuid */ ComponentID?: string | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; /** Format: uuid */ ReleaseTargetID?: string | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** Format: uuid */ TriggerFilterID?: string | null; /** Format: uuid */ UpstreamSpaceID?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; WhereAttribute?: string | null; WhereTrigger?: string | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["SpaceCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SpaceCreateOrUpdateResponse"][]; }; }; /** @description Space request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Space. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; Attest: { parameters: { query?: { /** @description Resolve the Revisions that would be covered and return the same response without writing anything. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["AttestRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AttestResult"]; }; }; /** @description Recording failed in some Spaces; each Space's result carries its own error */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AttestResult"]; }; }; /** @description Attest request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attest not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attest data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Attest. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAllAttestations: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Attestations returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Attestation: AttestationID, ChangeOrderID, Claims, CreatedAt, EvidenceAttestationIDs, ExpiresAt, Hash, HiddenReason, Note, OrganizationID, Permissions, ReleaseID, Result, RevokedAttestationID, SpaceID, Type, UserID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Attestation list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Attestation). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Attestation include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Attestation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Attestation are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Attestation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, AttestationID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Attestation entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsAttestationGetParametersQueryWhere_permission; /** * @description Hidden Attestation entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Attestation, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Attestation: its Of, or the From of its Filter, must be Attestation. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Attestation entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Attestation results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Attestation: AttestationID, ChangeOrderID, CreatedAt, ExpiresAt, Hash, HiddenReason, Note, OrganizationID, ReleaseID, Result, RevokedAttestationID, SpaceID, Type, UserID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Attestation's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Attestation entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedAttestation"][]; }; }; /** @description Attestation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attestation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Attestation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAllAttributes: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Attributes returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Attribute: Annotations, AttributeID, BackingUnitID, CreatedAt, DataType, DeleteGates, DisplayName, Hash, HiddenReason, Labels, OrganizationID, Parameters, Permissions, ResourceTypePaths, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamAttributeID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Attribute list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Attribute). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Attribute include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Attribute. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Attribute are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Attribute. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, AttributeID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Attribute entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsAttributeGetParametersQueryWhere_permission; /** * @description Hidden Attribute entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Attribute, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Attribute: its Of, or the From of its Filter, must be Attribute. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Attribute entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Attribute results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Attribute: AttributeID, BackingUnitID, CreatedAt, DataType, DisplayName, Hash, HiddenReason, OrganizationID, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamAttributeID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Attribute's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Attribute entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedAttribute"][]; }; }; /** @description Attribute request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Attribute. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkCreateAttributes: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Attributes returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Attribute: Annotations, AttributeID, BackingUnitID, CreatedAt, DataType, DeleteGates, DisplayName, Hash, HiddenReason, Labels, OrganizationID, Parameters, Permissions, ResourceTypePaths, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamAttributeID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Attribute list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Attribute). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Attribute include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Attribute entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Attribute. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Attribute are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Attribute entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Attribute entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of Spaces returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, TriggerOtherUnitIDs, UpdatedAt, UpstreamSpaceID. * * Where expression to select destination spaces for cloning attributes * * The whole string must be query-encoded. */ where_space?: string; /** * @description UUID of a Filter entity to apply to the Space list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Space). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter_space?: string; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description Give each Attribute written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Attribute's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Create Attributes from the ConfigHub/YAML Units where_unit and filter_unit select, each in its Unit's Space, and each with its Unit as its backing Unit. The request body is applied after the Unit's document. Units of other toolchains or describing other entity types are passed over; outstanding ValidationErrors on a Unit are an error. Takes none of the parameters that select entities to clone, name the clones or choose their Spaces. */ from_backing_units?: boolean; /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * The Units to create entities from, with from_backing_units. * * The whole string must be query-encoded. */ where_unit?: string; /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */ filter_unit?: string; /** @description With from_backing_units, patch a Attribute a selected Unit already backs with what the Unit holds that it has not taken yet, as a bulk patch with from_backing_units does, rather than report that the Unit backs it. The request body is applied after it. Without it, such a Unit is an error, or with allow_exists the Attribute is returned as it is. */ patch_existing?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; DataType?: string | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; Description?: string | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Parameters?: (Record | null)[] | null; Permissions?: { [key: string]: Record | null; } | null; ResourceTypePaths?: (Record | null)[] | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; ToolchainType?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["AttributeCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status (partial success) */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AttributeCreateOrUpdateResponse"][]; }; }; /** @description Attribute request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Attribute. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkDeleteAttributes: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Attributes returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Attribute: Annotations, AttributeID, BackingUnitID, CreatedAt, DataType, DeleteGates, DisplayName, Hash, HiddenReason, Labels, OrganizationID, Parameters, Permissions, ResourceTypePaths, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamAttributeID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Attribute list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Attribute). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Attribute include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Attribute entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Attribute. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Attribute are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Attribute entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Attribute entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Prune: of the Attributes selected, delete those whose backing Unit is empty, which says the Attribute should not exist, and keep the Unit, empty and backing nothing, so that it keeps the Attribute's history and a document that comes back revives it. The others are left alone and are not in the response, so a broad selection deletes only what was emptied. */ from_backing_units?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Attribute request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete entity */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Attribute. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkPatchAttributes: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Attributes returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Attribute: Annotations, AttributeID, BackingUnitID, CreatedAt, DataType, DeleteGates, DisplayName, Hash, HiddenReason, Labels, OrganizationID, Parameters, Permissions, ResourceTypePaths, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamAttributeID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Attribute list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Attribute). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Attribute include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Attribute entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Attribute. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Attribute are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Attribute entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Attribute entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Give each Attribute written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Attribute's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Patch each selected Attribute with what its backing Unit holds that it has not taken yet: the change to the Unit since its LastReleasedRevisionNum. The request body is applied after it. Selecting one with no backing Unit is an error, and so are outstanding ValidationErrors on a backing Unit. */ from_backing_units?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; DataType?: string | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; Description?: string | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Parameters?: (Record | null)[] | null; Permissions?: { [key: string]: Record | null; } | null; ResourceTypePaths?: (Record | null)[] | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; ToolchainType?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["AttributeCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AttributeCreateOrUpdateResponse"][]; }; }; /** @description Attribute request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Attribute. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkMoveAttributes: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Attributes returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Attribute: Annotations, AttributeID, BackingUnitID, CreatedAt, DataType, DeleteGates, DisplayName, Hash, HiddenReason, Labels, OrganizationID, Parameters, Permissions, ResourceTypePaths, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamAttributeID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Attribute list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Attribute). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Attribute include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Attribute entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Attribute. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Attribute are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Report what the move would do, and what would stop it, without moving anything */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["MoveRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description Multi-Status: nothing was moved, or some moved and others did not */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description Attribute request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Attribute. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAllChangeOrders: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ChangeOrders returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, ReviewRequests, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ChangeOrder list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ChangeOrder). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ChangeOrder include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for ChangeOrder. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, Permissions, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for ChangeOrder. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ChangeOrderID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return ChangeOrder entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsChange_orderGetParametersQueryWhere_permission; /** * @description Hidden ChangeOrder entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each ChangeOrder, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of ChangeOrder: its Of, or the From of its Filter, must be ChangeOrder. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of ChangeOrder entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort ChangeOrder results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering ChangeOrder: AbortedReason, AdoptedEndTagID, ChangeOrderID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, InvocationID, OrganizationID, PriorRevisions, ReleasePriorRevisions, ReleaseTagID, RestoreTagID, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the ChangeOrder's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the ChangeOrder entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedChangeOrder"][]; }; }; /** @description ChangeOrder request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeOrder. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkCreateChangeOrders: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ChangeOrders returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, ReviewRequests, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ChangeOrder list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ChangeOrder). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ChangeOrder include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden ChangeOrder entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for ChangeOrder. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, Permissions, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of ChangeOrder entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the ChangeOrder entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Comma-separated list of prefixes to apply to cloned ChangeOrder names */ name_prefixes?: string; /** @description Comma-separated list of labels with multiple values for cloned ChangeOrder labels, in the format of key1=value1|value2,key2=value1|value2|value3 */ variant_labels?: string; /** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */ name_pattern?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of Spaces returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, TriggerOtherUnitIDs, UpdatedAt, UpstreamSpaceID. * * Where expression to select destination spaces for cloning change orders * * The whole string must be query-encoded. */ where_space?: string; /** * @description UUID of a Filter entity to apply to the Space list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Space). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter_space?: string; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { AbortedReason?: string | null; /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** Format: uuid */ ChangeWorkflowID?: string | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; Description?: string | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** Format: uuid */ EndTagID?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; InScopeSpaceIDs?: (string | null)[] | null; /** Format: uuid */ InvocationID?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Parameters?: Record | null; Permissions?: { [key: string]: Record | null; } | null; PriorRevisions?: string | null; ReleasePriorRevisions?: string | null; ReviewRequests?: (Record | null)[] | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** Format: uuid */ SpaceFilterID?: string | null; /** Format: uuid */ UnitFilterID?: string | null; UpdateType?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; WhereSpace?: string | null; WhereUnit?: string | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeOrderCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status (partial success) */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeOrderCreateOrUpdateResponse"][]; }; }; /** @description ChangeOrder request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeOrder. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkDeleteChangeOrders: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ChangeOrders returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, ReviewRequests, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ChangeOrder list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ChangeOrder). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ChangeOrder include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden ChangeOrder entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for ChangeOrder. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, Permissions, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of ChangeOrder entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the ChangeOrder entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */ detach?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description ChangeOrder request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete entity */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeOrder. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkPatchChangeOrders: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ChangeOrders returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, ReviewRequests, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ChangeOrder list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ChangeOrder). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ChangeOrder include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden ChangeOrder entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for ChangeOrder. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, Permissions, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of ChangeOrder entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the ChangeOrder entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description If true, re-evaluate WhereSpace and/or SpaceFilterID into InScopeSpaceIDs, and re-derive what the ChangeOrder covers if the Spaces they select have changed, even if neither field has changed. Has no effect on a ChangeOrder with neither set. */ refresh_spaces?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { AbortedReason?: string | null; /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** Format: uuid */ ChangeWorkflowID?: string | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; Description?: string | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** Format: uuid */ EndTagID?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; InScopeSpaceIDs?: (string | null)[] | null; /** Format: uuid */ InvocationID?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Parameters?: Record | null; Permissions?: { [key: string]: Record | null; } | null; PriorRevisions?: string | null; ReleasePriorRevisions?: string | null; ReviewRequests?: (Record | null)[] | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** Format: uuid */ SpaceFilterID?: string | null; /** Format: uuid */ UnitFilterID?: string | null; UpdateType?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; WhereSpace?: string | null; WhereUnit?: string | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeOrderCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeOrderCreateOrUpdateResponse"][]; }; }; /** @description ChangeOrder request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeOrder. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkRefreshChangeOrderStages: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ChangeOrders returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, ReviewRequests, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ChangeOrder list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ChangeOrder). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ChangeOrder include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden ChangeOrder entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for ChangeOrder. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, Permissions, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of ChangeOrder entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the ChangeOrder entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeOrderCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeOrderCreateOrUpdateResponse"][]; }; }; /** @description ChangeOrder request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeOrder. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAllChangeSets: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ChangeSets returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, ChangeWorkflow, ChangeWorkflowID, CloseOverride, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, Labels, OrganizationID, Permissions, ReviewRequests, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ChangeSet list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ChangeSet). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ChangeSet include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for ChangeSet. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeSet are EndTagID, OrganizationID, Permissions, SpaceID, StartTagID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for ChangeSet. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ChangeSetID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return ChangeSet entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsChange_setGetParametersQueryWhere_permission; /** * @description Hidden ChangeSet entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each ChangeSet, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of ChangeSet: its Of, or the From of its Filter, must be ChangeSet. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of ChangeSet entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort ChangeSet results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering ChangeSet: ChangeSetID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, OrganizationID, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the ChangeSet's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the ChangeSet entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedChangeSet"][]; }; }; /** @description ChangeSet request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeSet. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkCreateChangeSets: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ChangeSets returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, ChangeWorkflow, ChangeWorkflowID, CloseOverride, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, Labels, OrganizationID, Permissions, ReviewRequests, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ChangeSet list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ChangeSet). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ChangeSet include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden ChangeSet entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for ChangeSet. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeSet are EndTagID, OrganizationID, Permissions, SpaceID, StartTagID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of ChangeSet entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the ChangeSet entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Comma-separated list of prefixes to apply to cloned ChangeSet names */ name_prefixes?: string; /** @description Comma-separated list of labels with multiple values for cloned ChangeSet labels, in the format of key1=value1|value2,key2=value1|value2|value3 */ variant_labels?: string; /** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */ name_pattern?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of Spaces returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, TriggerOtherUnitIDs, UpdatedAt, UpstreamSpaceID. * * Where expression to select destination spaces for cloning change sets * * The whole string must be query-encoded. */ where_space?: string; /** * @description UUID of a Filter entity to apply to the Space list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Space). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter_space?: string; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** Format: uuid */ ChangeWorkflowID?: string | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; Description?: string | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; ReviewRequests?: (Record | null)[] | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeSetCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status (partial success) */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeSetCreateOrUpdateResponse"][]; }; }; /** @description ChangeSet request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeSet. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkDeleteChangeSets: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ChangeSets returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, ChangeWorkflow, ChangeWorkflowID, CloseOverride, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, Labels, OrganizationID, Permissions, ReviewRequests, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ChangeSet list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ChangeSet). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ChangeSet include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden ChangeSet entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for ChangeSet. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeSet are EndTagID, OrganizationID, Permissions, SpaceID, StartTagID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of ChangeSet entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the ChangeSet entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */ detach?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description ChangeSet request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete entity */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeSet. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkPatchChangeSets: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ChangeSets returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, ChangeWorkflow, ChangeWorkflowID, CloseOverride, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, Labels, OrganizationID, Permissions, ReviewRequests, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ChangeSet list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ChangeSet). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ChangeSet include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden ChangeSet entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for ChangeSet. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeSet are EndTagID, OrganizationID, Permissions, SpaceID, StartTagID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of ChangeSet entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the ChangeSet entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** Format: uuid */ ChangeWorkflowID?: string | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; Description?: string | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; ReviewRequests?: (Record | null)[] | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeSetCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeSetCreateOrUpdateResponse"][]; }; }; /** @description ChangeSet request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeSet. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkMoveChangeSets: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ChangeSets returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, ChangeWorkflow, ChangeWorkflowID, CloseOverride, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, Labels, OrganizationID, Permissions, ReviewRequests, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ChangeSet list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ChangeSet). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ChangeSet include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden ChangeSet entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for ChangeSet. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeSet are EndTagID, OrganizationID, Permissions, SpaceID, StartTagID. * * The whole string must be query-encoded. */ include?: string; /** @description Report what the move would do, and what would stop it, without moving anything */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["MoveRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description Multi-Status: nothing was moved, or some moved and others did not */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description ChangeSet request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeSet. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAllChangeWorkflows: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ChangeWorkflows returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ChangeWorkflow: Annotations, AttestationPrerequisites, BackingUnitID, ChangeWorkflowID, CreatedAt, CustomPrerequisites, DeleteGates, DisplayName, Final, Hash, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, Stages, UpdatedAt, UpstreamChangeWorkflowID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ChangeWorkflow list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ChangeWorkflow). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ChangeWorkflow include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for ChangeWorkflow. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeWorkflow are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for ChangeWorkflow. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ChangeWorkflowID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return ChangeWorkflow entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsChange_workflowGetParametersQueryWhere_permission; /** * @description Hidden ChangeWorkflow entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each ChangeWorkflow, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of ChangeWorkflow: its Of, or the From of its Filter, must be ChangeWorkflow. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of ChangeWorkflow entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort ChangeWorkflow results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering ChangeWorkflow: BackingUnitID, ChangeWorkflowID, CreatedAt, DisplayName, Hash, HiddenReason, OrganizationID, Slug, SpaceID, UpdatedAt, UpstreamChangeWorkflowID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the ChangeWorkflow's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the ChangeWorkflow entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedChangeWorkflow"][]; }; }; /** @description ChangeWorkflow request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeWorkflow. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkCreateChangeWorkflows: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ChangeWorkflows returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ChangeWorkflow: Annotations, AttestationPrerequisites, BackingUnitID, ChangeWorkflowID, CreatedAt, CustomPrerequisites, DeleteGates, DisplayName, Final, Hash, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, Stages, UpdatedAt, UpstreamChangeWorkflowID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ChangeWorkflow list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ChangeWorkflow). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ChangeWorkflow include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden ChangeWorkflow entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for ChangeWorkflow. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeWorkflow are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of ChangeWorkflow entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the ChangeWorkflow entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Comma-separated list of prefixes to apply to cloned ChangeWorkflow names */ name_prefixes?: string; /** @description Comma-separated list of labels with multiple values for cloned ChangeWorkflow labels, in the format of key1=value1|value2,key2=value1|value2|value3 */ variant_labels?: string; /** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */ name_pattern?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of Spaces returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, TriggerOtherUnitIDs, UpdatedAt, UpstreamSpaceID. * * Where expression to select destination spaces for cloning change workflows * * The whole string must be query-encoded. */ where_space?: string; /** * @description UUID of a Filter entity to apply to the Space list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Space). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter_space?: string; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description Give each ChangeWorkflow written a backing Unit if it has none: a ConfigHub/YAML Unit holding the ChangeWorkflow's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Create ChangeWorkflows from the ConfigHub/YAML Units where_unit and filter_unit select, each in its Unit's Space, and each with its Unit as its backing Unit. The request body is applied after the Unit's document. Units of other toolchains or describing other entity types are passed over; outstanding ValidationErrors on a Unit are an error. Takes none of the parameters that select entities to clone, name the clones or choose their Spaces. */ from_backing_units?: boolean; /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * The Units to create entities from, with from_backing_units. * * The whole string must be query-encoded. */ where_unit?: string; /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */ filter_unit?: string; /** @description With from_backing_units, patch a ChangeWorkflow a selected Unit already backs with what the Unit holds that it has not taken yet, as a bulk patch with from_backing_units does, rather than report that the Unit backs it. The request body is applied after it. Without it, such a Unit is an error, or with allow_exists the ChangeWorkflow is returned as it is. */ patch_existing?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description The Attestations a stage, its releases, or Final may require. Declared once and named wherever they apply. */ AttestationPrerequisites?: (Record | null)[] | null; /** @description The checks a stage or Final may gate on beyond the built-in ones. Declared once and named wherever they apply. */ CustomPrerequisites?: (Record | null)[] | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. In a workflow with no stages, which governs a ChangeSet, what every Space the ChangeSet was opened in must satisfy for it to close. */ Final?: Record | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one. A workflow governing a ChangeOrder needs at least one; one governing a ChangeSet has none. */ Stages?: (Record | null)[] | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeWorkflowCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status (partial success) */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeWorkflowCreateOrUpdateResponse"][]; }; }; /** @description ChangeWorkflow request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeWorkflow. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkDeleteChangeWorkflows: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ChangeWorkflows returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ChangeWorkflow: Annotations, AttestationPrerequisites, BackingUnitID, ChangeWorkflowID, CreatedAt, CustomPrerequisites, DeleteGates, DisplayName, Final, Hash, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, Stages, UpdatedAt, UpstreamChangeWorkflowID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ChangeWorkflow list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ChangeWorkflow). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ChangeWorkflow include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden ChangeWorkflow entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for ChangeWorkflow. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeWorkflow are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of ChangeWorkflow entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the ChangeWorkflow entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Prune: of the ChangeWorkflows selected, delete those whose backing Unit is empty, which says the ChangeWorkflow should not exist, and keep the Unit, empty and backing nothing, so that it keeps the ChangeWorkflow's history and a document that comes back revives it. The others are left alone and are not in the response, so a broad selection deletes only what was emptied. */ from_backing_units?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description ChangeWorkflow request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete entity */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeWorkflow. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkPatchChangeWorkflows: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ChangeWorkflows returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ChangeWorkflow: Annotations, AttestationPrerequisites, BackingUnitID, ChangeWorkflowID, CreatedAt, CustomPrerequisites, DeleteGates, DisplayName, Final, Hash, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, Stages, UpdatedAt, UpstreamChangeWorkflowID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ChangeWorkflow list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ChangeWorkflow). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ChangeWorkflow include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden ChangeWorkflow entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for ChangeWorkflow. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeWorkflow are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of ChangeWorkflow entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the ChangeWorkflow entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Give each ChangeWorkflow written a backing Unit if it has none: a ConfigHub/YAML Unit holding the ChangeWorkflow's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Patch each selected ChangeWorkflow with what its backing Unit holds that it has not taken yet: the change to the Unit since its LastReleasedRevisionNum. The request body is applied after it. Selecting one with no backing Unit is an error, and so are outstanding ValidationErrors on a backing Unit. */ from_backing_units?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description The Attestations a stage, its releases, or Final may require. Declared once and named wherever they apply. */ AttestationPrerequisites?: (Record | null)[] | null; /** @description The checks a stage or Final may gate on beyond the built-in ones. Declared once and named wherever they apply. */ CustomPrerequisites?: (Record | null)[] | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. In a workflow with no stages, which governs a ChangeSet, what every Space the ChangeSet was opened in must satisfy for it to close. */ Final?: Record | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one. A workflow governing a ChangeOrder needs at least one; one governing a ChangeSet has none. */ Stages?: (Record | null)[] | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeWorkflowCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeWorkflowCreateOrUpdateResponse"][]; }; }; /** @description ChangeWorkflow request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeWorkflow. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkMoveChangeWorkflows: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ChangeWorkflows returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ChangeWorkflow: Annotations, AttestationPrerequisites, BackingUnitID, ChangeWorkflowID, CreatedAt, CustomPrerequisites, DeleteGates, DisplayName, Final, Hash, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, Stages, UpdatedAt, UpstreamChangeWorkflowID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ChangeWorkflow list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ChangeWorkflow). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ChangeWorkflow include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden ChangeWorkflow entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for ChangeWorkflow. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeWorkflow are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Report what the move would do, and what would stop it, without moving anything */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["MoveRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description Multi-Status: nothing was moved, or some moved and others did not */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description ChangeWorkflow request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeWorkflow. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAllChannels: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Channels returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Channel: Annotations, BackingUnitID, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt, UpstreamChannelID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Channel list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Channel). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Channel include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Channel. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Channel are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Channel. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ChannelID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Channel entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View, Claim. */ where_permission?: PathsChannelGetParametersQueryWhere_permission; /** * @description Hidden Channel entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Channel, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Channel: its Of, or the From of its Filter, must be Channel. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Channel entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Channel results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Channel: BackingUnitID, ChannelID, Condition, CreatedAt, DisplayName, EventPosition, HiddenReason, IPAddress, LastMessage, LastSeenAt, OrganizationID, Slug, SpaceID, UpdatedAt, UpstreamChannelID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Channel's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Channel entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedChannel"][]; }; }; /** @description Channel request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Channel. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkCreateChannels: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Channels returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Channel: Annotations, BackingUnitID, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt, UpstreamChannelID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Channel list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Channel). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Channel include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Channel entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Channel. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Channel are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Channel entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Channel entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Comma-separated list of prefixes to apply to cloned Channel names */ name_prefixes?: string; /** @description Comma-separated list of labels with multiple values for cloned Channel labels, in the format of key1=value1|value2,key2=value1|value2|value3 */ variant_labels?: string; /** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */ name_pattern?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of Spaces returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, TriggerOtherUnitIDs, UpdatedAt, UpstreamSpaceID. * * Where expression to select destination spaces for cloning channels * * The whole string must be query-encoded. */ where_space?: string; /** * @description UUID of a Filter entity to apply to the Space list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Space). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter_space?: string; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description Give each Channel written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Channel's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Create Channels from the ConfigHub/YAML Units where_unit and filter_unit select, each in its Unit's Space, and each with its Unit as its backing Unit. The request body is applied after the Unit's document. Units of other toolchains or describing other entity types are passed over; outstanding ValidationErrors on a Unit are an error. Takes none of the parameters that select entities to clone, name the clones or choose their Spaces. */ from_backing_units?: boolean; /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * The Units to create entities from, with from_backing_units. * * The whole string must be query-encoded. */ where_unit?: string; /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */ filter_unit?: string; /** @description With from_backing_units, patch a Channel a selected Unit already backs with what the Unit holds that it has not taken yet, as a bulk patch with from_backing_units does, rather than report that the Unit backs it. The request body is applied after it. Without it, such a Unit is an error, or with allow_exists the Channel is returned as it is. */ patch_existing?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; Commands?: { [key: string]: Record | null; } | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; EventPosition?: number | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; Subscriptions?: (Record | null)[] | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChannelCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status (partial success) */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChannelCreateOrUpdateResponse"][]; }; }; /** @description Channel request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Channel. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkDeleteChannels: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Channels returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Channel: Annotations, BackingUnitID, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt, UpstreamChannelID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Channel list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Channel). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Channel include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Channel entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Channel. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Channel are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Channel entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Channel entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Prune: of the Channels selected, delete those whose backing Unit is empty, which says the Channel should not exist, and keep the Unit, empty and backing nothing, so that it keeps the Channel's history and a document that comes back revives it. The others are left alone and are not in the response, so a broad selection deletes only what was emptied. */ from_backing_units?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Channel request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete entity */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Channel. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkPatchChannels: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Channels returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Channel: Annotations, BackingUnitID, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt, UpstreamChannelID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Channel list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Channel). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Channel include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Channel entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Channel. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Channel are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Channel entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Channel entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Give each Channel written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Channel's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Patch each selected Channel with what its backing Unit holds that it has not taken yet: the change to the Unit since its LastReleasedRevisionNum. The request body is applied after it. Selecting one with no backing Unit is an error, and so are outstanding ValidationErrors on a backing Unit. */ from_backing_units?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; Commands?: { [key: string]: Record | null; } | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; EventPosition?: number | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; Subscriptions?: (Record | null)[] | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChannelCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChannelCreateOrUpdateResponse"][]; }; }; /** @description Channel request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Channel. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkMoveChannels: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Channels returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Channel: Annotations, BackingUnitID, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt, UpstreamChannelID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Channel list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Channel). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Channel include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Channel entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Channel. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Channel are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Report what the move would do, and what would stop it, without moving anything */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["MoveRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description Multi-Status: nothing was moved, or some moved and others did not */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description Channel request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Channel. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAllCommands: { parameters: { query?: { /** @description List only the Channels declaring this command. */ command?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeclaredCommand"][]; }; }; /** @description DeclaredCommand request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description DeclaredCommand not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing DeclaredCommand. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAllCommandRuns: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of CommandRuns returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, HiddenReason, OrganizationID, SpaceID, Status, TimeoutAt, UpdatedAt. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the CommandRun list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (CommandRun). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for CommandRun include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for CommandRun. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for CommandRun are ChannelID, OrganizationID, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for CommandRun. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, CommandRunID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return CommandRun entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsCommand_runGetParametersQueryWhere_permission; /** * @description Hidden CommandRun entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each CommandRun, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of CommandRun: its Of, or the From of its Filter, must be CommandRun. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of CommandRun entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort CommandRun results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, HiddenReason, OrganizationID, Status, TimeoutAt, UpdatedAt. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the CommandRun's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the CommandRun entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedCommandRun"][]; }; }; /** @description CommandRun request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description CommandRun not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing CommandRun. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListComponents: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Components returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Component: AllowedChangeWorkflowIDs, Annotations, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrganizationID, Permissions, RequireChangeTracking, RequireChangeWorkflow, Slug, UpdatedAt, UpstreamComponentID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Component list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Component). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Component include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Component. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Component. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ComponentID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Component entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsComponentGetParametersQueryWhere_permission; /** * @description Hidden Component entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Component, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Component: its Of, or the From of its Filter, must be Component. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Component entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Component results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Component: BackingUnitID, ComponentID, CreatedAt, DisplayName, HiddenReason, OrganizationID, RequireChangeTracking, RequireChangeWorkflow, Slug, UpdatedAt, UpstreamComponentID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Component's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Component entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedComponent"][]; }; }; /** @description Component request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Component not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Component. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateComponent: { parameters: { query?: { /** @description Give each Component written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Component's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description The Space, by slug or ID, for the backing Units with_backing_units creates. Required with it: a Component is in no Space of its own to hold one. */ backing_unit_space?: string; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Component"]; }; }; responses: { /** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, whether one is required, and whether changes to the configuration of their Units have to be made in a ChangeSet or under a ChangeOrder. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Component"]; }; }; /** @description Component request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Component not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Component data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Component. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetComponent: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for Component. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Component. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ComponentID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a component_id */ component_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedComponent"]; }; }; /** @description Component request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Component not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Component. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateComponent: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a component_id */ component_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Component"]; }; }; responses: { /** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, whether one is required, and whether changes to the configuration of their Units have to be made in a ChangeSet or under a ChangeOrder. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Component"]; }; }; /** @description Component request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Component not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Component data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Component. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteComponent: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a component_id */ component_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description Component request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Component not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Component is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Component could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Component. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchComponent: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a component_id */ component_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { AllowedChangeWorkflowIDs?: (string | null)[] | null; /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; RequireChangeTracking?: boolean | null; RequireChangeWorkflow?: boolean | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, whether one is required, and whether changes to the configuration of their Units have to be made in a ChangeSet or under a ChangeOrder. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Component"]; }; }; /** @description Component request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Component not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Component data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Component. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetComponentDocument: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a component_id */ component_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityDocument"]; }; }; /** @description Component request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Component not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Component. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateComponentDocument: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a component_id */ component_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["EntityDocumentEdit"]; }; }; responses: { /** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, whether one is required, and whether changes to the configuration of their Units have to be made in a ChangeSet or under a ChangeOrder. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Component"]; }; }; /** @description Component request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Component not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description The Component changed since the document was read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Component. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; Demote: { parameters: { query?: { /** @description Plan the demotion and return the same response without writing anything. */ dry_run?: boolean; /** * @description Comma-separated parts of the result to return in addition to the actions: Mutations for what each restore changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides. Context, with Diff, adds to each Diff the unchanged paths around the changes: every unchanged child of each map or array that holds a change, up to the resource, as ChangeType None. * * Supported values: Mutations, Diff, Context. */ include?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["DemoteRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DemoteResult"]; }; }; /** @description Multi-Status: some Unit writes failed, each carrying its own error */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DemoteResult"]; }; }; /** @description Demote request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Demote not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Demote data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description The plan differs from ExpectedPlan. Nothing was written. */ 412: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Demote. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DiffConfigurations: { parameters: { query?: { /** * @description Comma-separated: Attribution to attach to each changed path the To side's MutationSources entry, which says what set the new value, Unchanged to also list resources with no changes, and Context to also list, within each changed resource, the unchanged paths around the changes: every unchanged child of each map or array that holds a change, up to the resource, as ChangeType None. * * Supported values: Attribution, Unchanged, Context. */ include?: string; /** @description Limit the diff to the resources this where expression selects on either side. */ where_resource?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["DiffRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DiffResult"]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAllFilters: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Filters returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Filter: Annotations, BackingUnitID, CreatedAt, DeleteGates, DisplayName, FilterID, From, FromSpaceID, Hash, HiddenReason, IncludeHidden, Labels, OrganizationID, Permissions, ResourceType, Slug, SpaceID, UpdatedAt, UpstreamFilterID, Where, WhereData. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Filter list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Filter). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Filter include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Filter. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Filter are FromSpaceID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Filter. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, FilterID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Filter entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsFilterGetParametersQueryWhere_permission; /** * @description Hidden Filter entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Filter, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Filter: its Of, or the From of its Filter, must be Filter. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Filter entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Filter results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Filter: BackingUnitID, CreatedAt, DisplayName, FilterID, From, FromSpaceID, Hash, HiddenReason, IncludeHidden, OrganizationID, ResourceType, Slug, SpaceID, UpdatedAt, UpstreamFilterID, Where, WhereData. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Filter's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Filter entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; /** @description Entity type to filter for (e.g., Unit, Space). Must be specified together with 'id' parameter. */ entity?: string; /** @description Entity ID to filter for. Must be specified together with 'entity' parameter. */ id?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedFilter"][]; }; }; /** @description Filter request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Filter. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkCreateFilters: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Filters returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Filter: Annotations, BackingUnitID, CreatedAt, DeleteGates, DisplayName, FilterID, From, FromSpaceID, Hash, HiddenReason, IncludeHidden, Labels, OrganizationID, Permissions, ResourceType, Slug, SpaceID, UpdatedAt, UpstreamFilterID, Where, WhereData. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Filter list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Filter). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Filter include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Filter entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Filter. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Filter are FromSpaceID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Filter entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Filter entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Comma-separated list of prefixes to apply to cloned Filter names */ name_prefixes?: string; /** @description Comma-separated list of labels with multiple values for cloned Filter labels, in the format of key1=value1|value2,key2=value1|value2|value3 */ variant_labels?: string; /** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */ name_pattern?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of Spaces returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, TriggerOtherUnitIDs, UpdatedAt, UpstreamSpaceID. * * Where expression to select destination spaces for cloning filters * * The whole string must be query-encoded. */ where_space?: string; /** * @description UUID of a Filter entity to apply to the Space list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Space). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter_space?: string; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description Give each Filter written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Filter's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Create Filters from the ConfigHub/YAML Units where_unit and filter_unit select, each in its Unit's Space, and each with its Unit as its backing Unit. The request body is applied after the Unit's document. Units of other toolchains or describing other entity types are passed over; outstanding ValidationErrors on a Unit are an error. Takes none of the parameters that select entities to clone, name the clones or choose their Spaces. */ from_backing_units?: boolean; /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * The Units to create entities from, with from_backing_units. * * The whole string must be query-encoded. */ where_unit?: string; /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */ filter_unit?: string; /** @description With from_backing_units, patch a Filter a selected Unit already backs with what the Unit holds that it has not taken yet, as a bulk patch with from_backing_units does, rather than report that the Unit backs it. The request body is applied after it. Without it, such a Unit is an error, or with allow_exists the Filter is returned as it is. */ patch_existing?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; From?: string | null; /** Format: uuid */ FromSpaceID?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; IncludeHidden?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; ResourceType?: string | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; Where?: string | null; WhereData?: string | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["FilterCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status (partial success) */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FilterCreateOrUpdateResponse"][]; }; }; /** @description Filter request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Filter. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkDeleteFilters: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Filters returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Filter: Annotations, BackingUnitID, CreatedAt, DeleteGates, DisplayName, FilterID, From, FromSpaceID, Hash, HiddenReason, IncludeHidden, Labels, OrganizationID, Permissions, ResourceType, Slug, SpaceID, UpdatedAt, UpstreamFilterID, Where, WhereData. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Filter list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Filter). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Filter include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Filter entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Filter. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Filter are FromSpaceID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Filter entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Filter entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Prune: of the Filters selected, delete those whose backing Unit is empty, which says the Filter should not exist, and keep the Unit, empty and backing nothing, so that it keeps the Filter's history and a document that comes back revives it. The others are left alone and are not in the response, so a broad selection deletes only what was emptied. */ from_backing_units?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Filter request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete entity */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Filter. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkPatchFilters: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Filters returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Filter: Annotations, BackingUnitID, CreatedAt, DeleteGates, DisplayName, FilterID, From, FromSpaceID, Hash, HiddenReason, IncludeHidden, Labels, OrganizationID, Permissions, ResourceType, Slug, SpaceID, UpdatedAt, UpstreamFilterID, Where, WhereData. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Filter list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Filter). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Filter include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Filter entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Filter. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Filter are FromSpaceID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Filter entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Filter entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Give each Filter written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Filter's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Patch each selected Filter with what its backing Unit holds that it has not taken yet: the change to the Unit since its LastReleasedRevisionNum. The request body is applied after it. Selecting one with no backing Unit is an error, and so are outstanding ValidationErrors on a backing Unit. */ from_backing_units?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; From?: string | null; /** Format: uuid */ FromSpaceID?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; IncludeHidden?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; ResourceType?: string | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; Where?: string | null; WhereData?: string | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["FilterCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FilterCreateOrUpdateResponse"][]; }; }; /** @description Filter request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Filter. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkMoveFilters: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Filters returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Filter: Annotations, BackingUnitID, CreatedAt, DeleteGates, DisplayName, FilterID, From, FromSpaceID, Hash, HiddenReason, IncludeHidden, Labels, OrganizationID, Permissions, ResourceType, Slug, SpaceID, UpdatedAt, UpstreamFilterID, Where, WhereData. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Filter list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Filter). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Filter include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Filter entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Filter. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Filter are FromSpaceID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Report what the move would do, and what would stop it, without moving anything */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["MoveRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description Multi-Status: nothing was moved, or some moved and others did not */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description Filter request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Filter. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListOrgFunctions: { parameters: { query?: { /** @description Space ID or slug whose executor to use for listing or invoking builtin functions */ executor_space?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of FunctionSignatures returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on FunctionSignature: AttributeName, Description, FunctionName, FunctionType, Hermetic, Idempotent, Mutating, OutputInfo.Description, OutputInfo.OutputType, OutputInfo.ResultName, Replayable, RequiredParameters, ToolchainType, Validating, VarArgs. * * The whole string must be query-encoded. */ where?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { [key: string]: { [key: string]: components["schemas"]["FunctionSignature"]; }; }; }; }; /** @description Function request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Function not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Function. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; InvokeFunctionsOnOrg: { parameters: { query?: { /** @description Space ID or slug whose executor to use for listing or invoking builtin functions */ executor_space?: string; /** @description Dry run mode: when true, skip updating configuration data even if it changed */ dry_run?: string; /** * @deprecated * @description Deprecated: use guards, as {"Override":"Upstream"} or {"Override":"External"}. Records the paths this operation writes as local overrides a merge must not overwrite: each Unit's Override guard -- Override=Upstream for a Unit with an upstream Unit, Override=External for one without -- with the clearance to write over one. A guard this request names under Override wins. */ protect?: boolean; /** @description The classes of guarded reason this operation is cleared for, as a JSON Clearance -- a list of {Key, Operator, Values} requirements, where Operator is Exists, In, NotIn, or DoesNotExist. A path whose guards this does not cover is not written, and the withheld change is reported as a Guarded conflict. An absent or empty clearance clears nothing, which only matters for a Unit that has guards. */ clearance?: string; /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */ guards?: string; /** @description The guards this operation records on the paths it writes as inherited guards, in the form guards takes: a clone of the Unit receives them, and a merge carries them, and any later change to them, to the Units downstream of it. Guards set through guards stay with the Unit they are on. A key may not be in both. The clearance has to cover these as it covers guards. */ inherited_guards?: string; /** @description Must match ChangeSetID of affected Units unless in dry run mode; not valid when invoked on Revisions */ change_set_id?: string; /** @description ChangeOrder to promote, which must have UpdateType Invoke. What runs then comes from the ChangeOrder rather than from the request body, which may not carry functions, triggers or invocations of its own; that is what holds every Space in scope to the same change. Only the Units the ChangeOrder covers are reached, a Unit that has already taken it is passed over, and every Unit reached is marked with the ChangeOrder's start and end Tags -- both on the head, with no Revision made, where the invocation changed nothing. Not valid when invoked on Revisions. */ change_order?: string; /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */ subgroup?: string; /** @description Additional configuration data to pass as OtherData to the functions the request names, and to the invocations that name none of their own; triggers pass what they name. Either a revision of each Unit, named LastReleasedRevisionNum or HeadRevisionNum, optionally prefixed with 'Before:' (e.g., Before:HeadRevisionNum), which the functions read under that name, or another Unit, as Unit::, whose head data the functions read under (e.g., Unit:policy: for vet-validating-admission-policy); the caller needs View permission on it. May be repeated or comma-separated. A function passed no revision is passed the revisions its signature lists in OtherDataExpected. */ other_data_source?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Unit list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Unit). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Comma-separated parts of the result to return in addition to the default: ConfigData for the configuration the invocation produced, carried whether or not the invocation changed it. Without it, the configuration is present only when the invocation changed it, and an unchanged result is reported by DataHash alone. Diff for what the invocation changed in each Unit, path by path with the values on both sides. * * Supported values: ConfigData, Diff. */ include?: string; /** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */ resource_type?: string; /** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|` splits the path: the left side selects, and the right side is a property of what was selected. On the right side of a `.|`, and only there, `!=` is true when the property is absent: `spec.containers.*.|image != 'nginx'` selects the containers and asks that none of their images be nginx, which a container with no image satisfies. Everywhere else a path that is not present is not a match, `!=` included. String literals are quoted with single quotes, such as `'string'`. Integer and boolean literals are also supported for attributes of those types. The whole string must be query-encoded. */ where_data?: string; /** @description Which engine answers where_data and resource_type: `sql` (the default) evaluates the expression against the stored resource projection in a single query, falling back to the function engine for the expressions it cannot translate; `function` invokes the where-filter function on each candidate Unit, reading every one's configuration; `shadow` runs both, answers with `function`, and logs any disagreement. Temporary: `function` is the escape hatch for one release, after which this parameter goes away. */ where_data_engine?: string; /** @description Where expression to match Triggers. Matched triggers are invoked on each unit to filter by validation results. Use with triggers_passed to control whether passing or failing units are returned (default: failing). */ where_trigger?: string; /** @description Filter UUID (with From=Trigger). The filter's matching triggers are invoked on units to filter by validation results. Can be combined with where_trigger. */ trigger_filter?: string; /** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */ triggers_passed?: boolean; /** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */ view?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["FunctionInvocationsRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FunctionInvocationsResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FunctionInvocationsResponse"][]; }; }; /** @description Function request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Function not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Function data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to process configuration data */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Function. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A Channel's client is unavailable; one or more function sources were not executed */ 503: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Timed out waiting for a Channel's client to return a function result */ 504: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListGroups: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Groups returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Group: CreatedAt, DisplayName, ExternalID, GroupID, Slug, UpdatedAt. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Group list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Group). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Group include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Only return Group entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsGroupGetParametersQueryWhere_permission; /** * @description Select clause for specifying which fields to include in the response for Group. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, GroupID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Hidden Group entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Group, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Group: its Of, or the From of its Filter, must be Group. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Group entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Group results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Group: CreatedAt, DisplayName, ExternalID, GroupID, Slug, UpdatedAt. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Group's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Group entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedGroup"][]; }; }; /** @description Group request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Group not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Group. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetGroup: { parameters: { query?: { /** * @description Select clause for specifying which fields to include in the response for Group. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, GroupID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a group_id */ group_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Group with additional related entities expanded based on the request's include parameter. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedGroup"]; }; }; /** @description Group request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Group not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Group. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; AddGroupBotUser: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a group_id */ group_id: string; /** @description Unique identifier for a user_id */ user_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description a User in Confighub. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["User"]; }; }; /** @description Group request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Group not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Group data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Group. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; RemoveGroupBotUser: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a group_id */ group_id: string; /** @description Unique identifier for a user_id */ user_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description a User in Confighub. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["User"]; }; }; /** @description Group request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Group not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Group is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Group could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Group. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; apiInfo: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Information provided to clients by the server. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApiInfo"]; }; }; }; }; ListAllInvocations: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Invocations returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID. * * The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Invocation list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Invocation). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Invocation include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Invocation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Invocation are ChannelID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Invocation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, InvocationID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Invocation entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsInvocationGetParametersQueryWhere_permission; /** * @description Hidden Invocation entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Invocation, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Invocation: its Of, or the From of its Filter, must be Invocation. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Invocation entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Invocation results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Invocation: BackingUnitID, ChannelID, CreatedAt, DisplayName, Hash, HiddenReason, InvocationID, OrganizationID, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Invocation's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Invocation entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedInvocation"][]; }; }; /** @description Invocation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Invocation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkCreateInvocations: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Invocations returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID. * * The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Invocation list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Invocation). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Invocation include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Invocation entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Invocation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Invocation are ChannelID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Invocation entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Invocation entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Comma-separated list of prefixes to apply to cloned Invocation names */ name_prefixes?: string; /** @description Comma-separated list of labels with multiple values for cloned Invocation labels, in the format of key1=value1|value2,key2=value1|value2|value3 */ variant_labels?: string; /** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */ name_pattern?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of Spaces returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, TriggerOtherUnitIDs, UpdatedAt, UpstreamSpaceID. * * Where expression to select destination spaces for cloning invocations * * The whole string must be query-encoded. */ where_space?: string; /** * @description UUID of a Filter entity to apply to the Space list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Space). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter_space?: string; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description Give each Invocation written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Invocation's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Create Invocations from the ConfigHub/YAML Units where_unit and filter_unit select, each in its Unit's Space, and each with its Unit as its backing Unit. The request body is applied after the Unit's document. Units of other toolchains or describing other entity types are passed over; outstanding ValidationErrors on a Unit are an error. Takes none of the parameters that select entities to clone, name the clones or choose their Spaces. */ from_backing_units?: boolean; /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * The Units to create entities from, with from_backing_units. * * The whole string must be query-encoded. */ where_unit?: string; /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */ filter_unit?: string; /** @description With from_backing_units, patch a Invocation a selected Unit already backs with what the Unit holds that it has not taken yet, as a bulk patch with from_backing_units does, rather than report that the Unit backs it. The request body is applied after it. Without it, such a Unit is an error, or with allow_exists the Invocation is returned as it is. */ patch_existing?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** Format: uuid */ ChannelID?: string | null; Clearance?: (Record | null)[] | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; FunctionInvocations?: (Record | null)[] | null; Guards?: { [key: string]: string | null; } | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; OtherUnitIDs?: { [key: string]: string | null; } | null; Parameters?: (Record | null)[] | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; ToolchainType?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["InvocationCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status (partial success) */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["InvocationCreateOrUpdateResponse"][]; }; }; /** @description Invocation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Invocation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkDeleteInvocations: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Invocations returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID. * * The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Invocation list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Invocation). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Invocation include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Invocation entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Invocation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Invocation are ChannelID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Invocation entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Invocation entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Prune: of the Invocations selected, delete those whose backing Unit is empty, which says the Invocation should not exist, and keep the Unit, empty and backing nothing, so that it keeps the Invocation's history and a document that comes back revives it. The others are left alone and are not in the response, so a broad selection deletes only what was emptied. */ from_backing_units?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Invocation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete entity */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Invocation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkPatchInvocations: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Invocations returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID. * * The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Invocation list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Invocation). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Invocation include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Invocation entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Invocation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Invocation are ChannelID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Invocation entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Invocation entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Give each Invocation written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Invocation's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Patch each selected Invocation with what its backing Unit holds that it has not taken yet: the change to the Unit since its LastReleasedRevisionNum. The request body is applied after it. Selecting one with no backing Unit is an error, and so are outstanding ValidationErrors on a backing Unit. */ from_backing_units?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** Format: uuid */ ChannelID?: string | null; Clearance?: (Record | null)[] | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; FunctionInvocations?: (Record | null)[] | null; Guards?: { [key: string]: string | null; } | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; OtherUnitIDs?: { [key: string]: string | null; } | null; Parameters?: (Record | null)[] | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; ToolchainType?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["InvocationCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["InvocationCreateOrUpdateResponse"][]; }; }; /** @description Invocation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Invocation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkMoveInvocations: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Invocations returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Invocation list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Invocation). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Invocation include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Invocation entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Invocation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Invocation are ChannelID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Report what the move would do, and what would stop it, without moving anything */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["MoveRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description Multi-Status: nothing was moved, or some moved and others did not */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description Invocation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Invocation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; SearchListLinks: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Links returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, ManualBindings, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Link list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Link). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Link include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Link. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Link are FromUnitID, OrganizationID, Permissions, SpaceID, ToSpaceID, ToUnitID, TransformInvocationID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Link. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, LinkID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Link entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsLinkGetParametersQueryWhere_permission; /** * @description Hidden Link entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Link, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Link: its Of, or the From of its Filter, must be Link. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Link entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Link results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Link: AutoUpdate, BackingUnitID, CreatedAt, DisplayName, DownstreamLastMergedRevisionNum, FromUnitID, Hash, HiddenReason, LinkID, MergeEnableSubtraction, OrganizationID, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamLastMergedRevisionNum, UpstreamLinkID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Link's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Link entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedLink"][]; }; }; /** @description Link request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Link. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkCreateLinks: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Links returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, ManualBindings, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID. * * Where expression to select source links to copy * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Link list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Link). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** @description Swap the FromUnit and ToUnit directions of the copied links (for cross-space link reversal) */ reverse?: boolean; /** * @description The specified string is an expression for the purpose of filtering * the list of Links returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, ManualBindings, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID. * * Where expression to find downstream UpgradeUnit links from each source link's FromUnit. Creates one copy per match. Exactly one of reverse, from_downstream_where and where_space/filter_space is required. * * The whole string must be query-encoded. */ from_downstream_where?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of Links returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, ManualBindings, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID. * * Where expression to find downstream UpgradeUnit link from each source link's ToUnit. Exactly one match required. If omitted, ToUnitID/ToSpaceID are unchanged. * * The whole string must be query-encoded. */ to_downstream_where?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of Spaces returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, TriggerOtherUnitIDs, UpdatedAt, UpstreamSpaceID. * * Where expression selecting spaces to copy each source link to, from and to the units of the same slugs there. A link to a unit in another space keeps that unit. A space with no unit of a slug the link needs gets an error for that copy. UpgradeUnit links are not copied. * * The whole string must be query-encoded. */ where_space?: string; /** * @description UUID of a Filter entity to apply to the Space list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Space). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter_space?: string; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** * @description Hidden Link entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** @description Create the NeedsProvides links between the Kubernetes/YAML units where_unit and filter_unit select that their configuration calls for, as upload infers them: from the references a resource makes to another, the Namespace a resource is in, the CRD that defines its type, and the label selectors that select a workload's pods. Links are inferred among the units of one space, and among those of spaces with the same ReleaseTargetID. A resource that names no namespace, or names the placeholder, is in its space's Namespace label, and in a namespace of the space's own if it has none. Each link is created in its from unit's space, with AutoUpdate, and the request body is applied to it, which can set its labels, annotations, delete gates and AutoUpdate but not its UpdateType. No link is created between two units that have a NeedsProvides link between them already, in either direction, and none that would close a cycle among the links created. Units of other toolchains are passed over. Takes none of the parameters that select links to copy or where the copies go. */ from_refs?: boolean; /** @description Give each Link written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Link's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Create Links from the ConfigHub/YAML Units where_unit and filter_unit select, each in its Unit's Space, and each with its Unit as its backing Unit. The request body is applied after the Unit's document. Units of other toolchains or describing other entity types are passed over; outstanding ValidationErrors on a Unit are an error. Takes none of the parameters that select entities to clone, name the clones or choose their Spaces. */ from_backing_units?: boolean; /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * The Units to create entities from, with from_backing_units, or to create links between, with from_refs. * * The whole string must be query-encoded. */ where_unit?: string; /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units, or to create links between, with from_refs. */ filter_unit?: string; /** @description With from_backing_units, patch a Link a selected Unit already backs with what the Unit holds that it has not taken yet, as a bulk patch with from_backing_units does, rather than report that the Unit backs it. The request body is applied after it. Without it, such a Unit is an error, or with allow_exists the Link is returned as it is. */ patch_existing?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; AutoUpdate?: boolean | null; Clearance?: (Record | null)[] | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; DownstreamLastMergedRevisionNum?: number | null; DownstreamPaths?: (Record | null)[] | null; DownstreamSetters?: (Record | null)[] | null; /** Format: uuid */ FromUnitID?: string | null; Guards?: { [key: string]: string | null; } | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; ManualBindings?: (Record | null)[] | null; MergeEnableSubtraction?: boolean | null; Permissions?: { [key: string]: Record | null; } | null; Protect?: boolean | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; Squash?: boolean | null; /** Format: uuid */ ToSpaceID?: string | null; /** Format: uuid */ ToUnitID?: string | null; /** Format: uuid */ TransformInvocationID?: string | null; UpdateType?: string | null; UpstreamGetters?: (Record | null)[] | null; UpstreamLastMergedRevisionNum?: number | null; UpstreamPaths?: (Record | null)[] | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; WhereMutation?: string | null; WhereResource?: string | null; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LinkCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status (partial success) */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LinkCreateOrUpdateResponse"][]; }; }; /** @description Link request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Link. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkDeleteLinks: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Links returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, ManualBindings, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Link list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Link). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Link include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Link entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Link. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Link are FromUnitID, OrganizationID, Permissions, SpaceID, ToSpaceID, ToUnitID, TransformInvocationID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Link entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Link entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Prune: of the Links selected, delete those whose backing Unit is empty, which says the Link should not exist, and keep the Unit, empty and backing nothing, so that it keeps the Link's history and a document that comes back revives it. The others are left alone and are not in the response, so a broad selection deletes only what was emptied. */ from_backing_units?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Link request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete entity */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Link. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkPatchLinks: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Links returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, ManualBindings, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Link list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Link). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Link include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Link entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Link. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Link are FromUnitID, OrganizationID, Permissions, SpaceID, ToSpaceID, ToUnitID, TransformInvocationID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Link entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Link entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Swap the FromUnit and ToUnit directions of the links */ reverse?: boolean; /** @description Give each Link written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Link's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Patch each selected Link with what its backing Unit holds that it has not taken yet: the change to the Unit since its LastReleasedRevisionNum. The request body is applied after it. Selecting one with no backing Unit is an error, and so are outstanding ValidationErrors on a backing Unit. */ from_backing_units?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; AutoUpdate?: boolean | null; Clearance?: (Record | null)[] | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; DownstreamLastMergedRevisionNum?: number | null; DownstreamPaths?: (Record | null)[] | null; DownstreamSetters?: (Record | null)[] | null; /** Format: uuid */ FromUnitID?: string | null; Guards?: { [key: string]: string | null; } | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; ManualBindings?: (Record | null)[] | null; MergeEnableSubtraction?: boolean | null; Permissions?: { [key: string]: Record | null; } | null; Protect?: boolean | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; Squash?: boolean | null; /** Format: uuid */ ToSpaceID?: string | null; /** Format: uuid */ ToUnitID?: string | null; /** Format: uuid */ TransformInvocationID?: string | null; UpdateType?: string | null; UpstreamGetters?: (Record | null)[] | null; UpstreamLastMergedRevisionNum?: number | null; UpstreamPaths?: (Record | null)[] | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; WhereMutation?: string | null; WhereResource?: string | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["LinkCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LinkCreateOrUpdateResponse"][]; }; }; /** @description Link request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Link. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetMe: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description a User given membership on the Organization */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrganizationMember"]; }; }; /** @description UserInfo request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description UserInfo not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing UserInfo. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateBrowserSession: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BrowserSessionResponse"]; }; }; /** @description BrowserSession request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description BrowserSession not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description BrowserSession data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing BrowserSession. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListOAuthClients: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OAuthClient"][]; }; }; /** @description OAuthClient request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description OAuthClient not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing OAuthClient. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateOAuthClient: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["OAuthClient"]; }; }; responses: { /** @description A per-app OAuth public client used by a browser app to authenticate against the ConfigHub API. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OAuthClient"]; }; }; /** @description OAuthClient request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description OAuthClient not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description OAuthClient data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing OAuthClient. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetOAuthClient: { parameters: { query?: never; header?: never; path: { /** @description The OAuth client_id addressing a single registered app. */ oauth_client: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description A per-app OAuth public client used by a browser app to authenticate against the ConfigHub API. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OAuthClient"]; }; }; /** @description OAuthClient request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description OAuthClient not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing OAuthClient. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteOAuthClient: { parameters: { query?: never; header?: never; path: { /** @description The OAuth client_id addressing a single registered app. */ oauth_client: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description OAuthClient request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description OAuthClient not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description OAuthClient is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description OAuthClient could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing OAuthClient. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListOrganizations: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Organizations returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Organization: Annotations, CreatedAt, DeleteGates, DisplayName, EmailDomain, ExternalID, HiddenReason, Labels, OrganizationID, Permissions, Slug, UpdatedAt. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Organization list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Organization). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Organization include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Organization. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Organization are Permissions. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Organization. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, OrganizationID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Organization entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View, ManageChildren, EditChildren, UseChildren, ViewChildren, CreateChildren. */ where_permission?: PathsOrganizationGetParametersQueryWhere_permission; /** * @description Hidden Organization entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Organization, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Organization: its Of, or the From of its Filter, must be Organization. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedOrganization"][]; }; }; /** @description Organization request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Organization not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Organization. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetOrganization: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for Organization. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Organization are Permissions. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Organization. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, OrganizationID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a organization_id */ organization_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedOrganization"]; }; }; /** @description Organization request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Organization not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Organization. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateOrganization: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a organization_id */ organization_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Organization"]; }; }; responses: { /** @description The top-level container for an organization using ConfigHub. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Organization"]; }; }; /** @description Organization request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Organization not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Organization data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Organization. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchOrganization: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a organization_id */ organization_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; EmailDomain?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description The top-level container for an organization using ConfigHub. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Organization"]; }; }; /** @description Organization request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Organization not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Organization data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Organization. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListOrganizationMembers: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of OrganizationMembers returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on OrganizationMember: DisplayName, ExternalID, Slug, UserID, Username. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the OrganizationMember list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (OrganizationMember). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for OrganizationMember include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Only return OrganizationMember entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsOrganizationOrganization_idOrganization_memberGetParametersQueryWhere_permission; /** * @description UUID of a View whose columns to compute for each OrganizationMember, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of OrganizationMember: its Of, or the From of its Filter, must be OrganizationMember. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; }; header?: never; path: { /** @description Unique identifier for a organization_id */ organization_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedOrganizationMember"][]; }; }; /** @description OrganizationMember request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description OrganizationMember not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing OrganizationMember. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateOrganizationMember: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a organization_id */ organization_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["OrganizationMember"]; }; }; responses: { /** @description a User given membership on the Organization */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OrganizationMember"]; }; }; /** @description OrganizationMember request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description OrganizationMember not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description OrganizationMember data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing OrganizationMember. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetOrganizationMember: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a organization_id */ organization_id: string; /** @description Unique identifier for a organization_member_id */ organization_member_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedOrganizationMember"]; }; }; /** @description OrganizationMember request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description OrganizationMember not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing OrganizationMember. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteOrganizationMember: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a organization_id */ organization_id: string; /** @description Unique identifier for a organization_member_id */ organization_member_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description OrganizationMember request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description OrganizationMember not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description OrganizationMember is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description OrganizationMember could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing OrganizationMember. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; Promote: { parameters: { query?: { /** * @deprecated * @description Deprecated: use DryRun in the request body. Plan the promotion, evaluate its gates, and return the same response without writing anything. Either one asks for a dry run. */ dry_run?: boolean; /** * @description Comma-separated parts of the result to return in addition to the actions: Mutations for what each Unit write changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides, and ConfigData for the configuration each Unit write produced, or on a dry run would produce. On a dry run any of them runs the merges a plan otherwise skips, so they are returned only when named. Context, with Diff, adds to each Diff the unchanged paths around the changes: every unchanged child of each map or array that holds a change, up to the resource, as ChangeType None. * * Supported values: Mutations, Diff, Context, ConfigData. */ include?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["PromoteRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PromoteResult"]; }; }; /** @description Multi-Status: some Unit or Link writes failed, each carrying its own error */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PromoteResult"]; }; }; /** @description Promote request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Promote not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description The Stage's entry gates do not hold; the result names each gate and whether it holds. Nothing was written. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PromoteResult"]; }; }; /** @description The plan differs from ExpectedPlan. Nothing was written. */ 412: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Promote. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAllReleases: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Releases returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Release: Annotations, ChangeOrderID, CreatedAt, DeleteGates, Digest, HiddenReason, Labels, LiveStatus, ManifestDigest, OCIRepositoryURL, OrganizationID, Permissions, Published, ReleaseID, ReleaseNum, SkippedUnits, SpaceID, TagID, TargetID, UnitCount, UpdatedAt, UserID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Release list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Release). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Release include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Release. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Release are ChangeOrderID, OrganizationID, Permissions, SpaceID, TagID, TargetID, UserID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Release. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ReleaseID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Release entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsReleaseGetParametersQueryWhere_permission; /** * @description Hidden Release entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Release, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Release: its Of, or the From of its Filter, must be Release. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Release entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Release results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Release: ChangeOrderID, CreatedAt, Digest, HiddenReason, ManifestDigest, OrganizationID, Published, ReleaseID, ReleaseNum, SpaceID, TagID, TargetID, UnitCount, UpdatedAt, UserID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Release's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Release entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; /** * @description Entity to return at most one Release per. The result set applies DISTINCT ON this key, keeping the most recent row for each. * * Supported values: Space, Off. * * If not specified, results are restricted to at most one row per Space. * * Off disables the DISTINCT ON and returns every matching row, so it requires an explicit 'limit' and is rejected with 400 without one. */ distinct_on?: PathsReleaseGetParametersQueryDistinct_on; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedRelease"][]; }; }; /** @description Release request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Release not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Release. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAllResources: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Resources returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Resource: CreatedAt, Data, HiddenReason, OrganizationID, ResourceID, ResourceIndex, ResourceName, ResourceType, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt. * * Sub-paths of the JSON configuration data are addressed with dot notation, such as `Data.spec.replicas > 1`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Resource list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Resource). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Resource include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Resource. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Resource are OrganizationID, SpaceID, TargetID, UnitID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Resource. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ResourceID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Resource entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsResourceGetParametersQueryWhere_permission; /** * @description Hidden Resource entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Resource, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Resource: its Of, or the From of its Filter, must be Resource. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Resource entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Resource results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Resource: CreatedAt, HiddenReason, OrganizationID, ResourceID, ResourceIndex, ResourceName, ResourceType, SpaceID, ToolchainType, UnitID, UpdatedAt. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Resource's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Resource entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; /** * @deprecated * @description Deprecated: use continue. Number of Resource entities to skip before returning results. Cannot be combined with continue. */ offset?: number; /** @description Return each resource's configuration in its original toolchain-native form, as RawData on the response envelope. Off by default: the bodies are bulk, and a table view needs only the queryable Data projection. */ raw_data?: boolean; /** @description The ResourceID of a NetworkPolicy, PodDisruptionBudget or Service: list only the workloads (such as Deployments, StatefulSets, DaemonSets, Jobs and CronJobs: any kind with a pod template) whose pods its selector selects, in its namespace. A resource with no namespace is in default. Selectors apply on one cluster, so the resources matched are those released to the named resource's Target, or in its Space when it has none. */ selected_by?: string; /** @description The ResourceID of a workload: list only the NetworkPolicies, PodDisruptionBudgets and Services whose selectors select its pods, in its namespace, on the same cluster as selected_by. */ selecting?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedResource"][]; }; }; /** @description Resource request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Resource not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Resource. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAllReviewComments: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ReviewComments returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ReviewComment list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ReviewComment). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ReviewComment include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for ReviewComment. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for ReviewComment. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ReviewCommentID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return ReviewComment entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsReview_commentGetParametersQueryWhere_permission; /** * @description Hidden ReviewComment entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each ReviewComment, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of ReviewComment: its Of, or the From of its Filter, must be ReviewComment. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of ReviewComment entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort ReviewComment results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, Text, UnitID, UpdatedAt, UserAgent, UserID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the ReviewComment's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the ReviewComment entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedReviewComment"][]; }; }; /** @description ReviewComment request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ReviewComment not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ReviewComment. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkDeleteReviewComments: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ReviewComments returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ReviewComment list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ReviewComment). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ReviewComment include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden ReviewComment entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for ReviewComment. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of ReviewComment entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the ReviewComment entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description ReviewComment request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ReviewComment not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ReviewComment is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete entity */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ReviewComment. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkPatchReviewComments: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ReviewComments returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ReviewComment list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ReviewComment). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ReviewComment include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden ReviewComment entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for ReviewComment. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of ReviewComment entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the ReviewComment entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** Format: uuid */ ChangeOrderID?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description Path to which the remark is attached; optional */ Path?: string | null; /** Format: uuid */ ReplyToID?: string | null; /** @description Resource to which the remark is attached; optional */ Resource?: Record | null; /** Format: uuid */ RevisionID?: string | null; RevisionNum?: number | null; Text?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReviewCommentCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReviewCommentCreateOrUpdateResponse"][]; }; }; /** @description ReviewComment request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ReviewComment not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ReviewComment data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ReviewComment. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAllRevisions: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Revisions returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, Attestations, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, HiddenReason, LinkFindings, MutationSources, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * To list tagged Revisions use `Tags ? ''`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Revision list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Revision). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Revision include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Revision. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Revision are Attestations, ChangeOrders, ChangeSetID, OrganizationID, Releases, SpaceID, Tags, UnitID, UserID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Revision. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, RevisionID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Revision entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsRevisionGetParametersQueryWhere_permission; /** * @description Hidden Revision entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Revision, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Revision: its Of, or the From of its Filter, must be Revision. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Revision entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Revision results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Revision: ChangeSetID, CreatedAt, DataHash, Description, HiddenReason, OrganizationID, RevisionID, RevisionNum, Source, UnitID, UpdatedAt, UserAgent, UserID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Revision's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Revision entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; /** * @deprecated * @description Deprecated: use continue. Number of Revision entities to skip before returning results. Cannot be combined with continue. */ offset?: number; /** * @description Entity to return at most one Revision per. The result set applies DISTINCT ON this key, keeping the most recent row for each. * * Supported values: Unit, Off. * * If not specified, results are restricted to at most one row per Unit. * * Off disables the DISTINCT ON and returns every matching row, so it requires an explicit 'limit' and is rejected with 400 without one. */ distinct_on?: PathsRevisionGetParametersQueryDistinct_on; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedRevision"][]; }; }; /** @description Revision request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Revision not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Revision. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; SearchRevisionData: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Revisions returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, Attestations, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, HiddenReason, LinkFindings, MutationSources, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * To list tagged Revisions use `Tags ? ''`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Revision list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Revision). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Revision include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Revision. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Revision are Attestations, ChangeOrders, ChangeSetID, OrganizationID, Releases, SpaceID, Tags, UnitID, UserID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Revision. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, RevisionID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Revision entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsRevision_dataGetParametersQueryWhere_permission; /** * @description Hidden Revision entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** @description Maximum number of Revision entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Revision results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Revision: ChangeSetID, CreatedAt, DataHash, Description, HiddenReason, OrganizationID, RevisionID, RevisionNum, Source, UnitID, UpdatedAt, UserAgent, UserID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Revision's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Revision entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; /** * @deprecated * @description Deprecated: use continue. Number of Revision entities to skip before returning results. Cannot be combined with continue. */ offset?: number; /** * @description Entity to return at most one Revision per. The result set applies DISTINCT ON this key, keeping the most recent row for each. * * Supported values: Unit, Off. * * If not specified, results are restricted to at most one row per Unit. * * Off disables the DISTINCT ON and returns every matching row, so it requires an explicit 'limit' and is rejected with 400 without one. */ distinct_on?: PathsRevision_dataGetParametersQueryDistinct_on; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["RevisionData"][]; }; }; /** @description Revision request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Revision not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Revision. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; SearchRevisionMutationSources: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Revisions returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, Attestations, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, HiddenReason, LinkFindings, MutationSources, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * To list tagged Revisions use `Tags ? ''`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Revision list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Revision). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Revision include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Revision. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Revision are Attestations, ChangeOrders, ChangeSetID, OrganizationID, Releases, SpaceID, Tags, UnitID, UserID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Revision. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, RevisionID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Revision entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsRevision_mutation_sourcesGetParametersQueryWhere_permission; /** * @description Hidden Revision entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** @description Maximum number of Revision entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Revision results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Revision: ChangeSetID, CreatedAt, DataHash, Description, HiddenReason, OrganizationID, RevisionID, RevisionNum, Source, UnitID, UpdatedAt, UserAgent, UserID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Revision's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Revision entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; /** * @deprecated * @description Deprecated: use continue. Number of Revision entities to skip before returning results. Cannot be combined with continue. */ offset?: number; /** * @description Entity to return at most one Revision per. The result set applies DISTINCT ON this key, keeping the most recent row for each. * * Supported values: Unit, Off. * * If not specified, results are restricted to at most one row per Unit. * * Off disables the DISTINCT ON and returns every matching row, so it requires an explicit 'limit' and is rejected with 400 without one. */ distinct_on?: PathsRevision_mutation_sourcesGetParametersQueryDistinct_on; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["RevisionMutationSources"][]; }; }; /** @description Revision request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Revision not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Revision. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListServiceAccounts: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ServiceAccounts returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ServiceAccount: Annotations, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrgRole, OrganizationID, Permissions, ServiceAccountID, Slug, UpdatedAt, UserID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ServiceAccount list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ServiceAccount). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ServiceAccount include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for ServiceAccount. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ServiceAccount are OrganizationID, Permissions. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for ServiceAccount. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ServiceAccountID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return ServiceAccount entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View, Impersonate. */ where_permission?: PathsService_accountGetParametersQueryWhere_permission; /** * @description Hidden ServiceAccount entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each ServiceAccount, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of ServiceAccount: its Of, or the From of its Filter, must be ServiceAccount. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of ServiceAccount entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort ServiceAccount results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering ServiceAccount: CreatedAt, DisplayName, HiddenReason, OrgRole, OrganizationID, ServiceAccountID, Slug, UpdatedAt, UserID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the ServiceAccount's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the ServiceAccount entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedServiceAccount"][]; }; }; /** @description ServiceAccount request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ServiceAccount. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateServiceAccount: { parameters: { query?: { /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ServiceAccount"]; }; }; responses: { /** @description An identity of the organization that is not a person and does not log in through the identity provider, such as an automation or an agent. Each ServiceAccount is backed by a User, which is what other entities' Permissions and Groups name to grant it access. The ServiceAccount's own Permissions say who may manage it. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ServiceAccount"]; }; }; /** @description ServiceAccount request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ServiceAccount. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetServiceAccount: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for ServiceAccount. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ServiceAccount are OrganizationID, Permissions. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for ServiceAccount. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ServiceAccountID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a service_account_id */ service_account_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedServiceAccount"]; }; }; /** @description ServiceAccount request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ServiceAccount. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateServiceAccount: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a service_account_id */ service_account_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ServiceAccount"]; }; }; responses: { /** @description An identity of the organization that is not a person and does not log in through the identity provider, such as an automation or an agent. Each ServiceAccount is backed by a User, which is what other entities' Permissions and Groups name to grant it access. The ServiceAccount's own Permissions say who may manage it. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ServiceAccount"]; }; }; /** @description ServiceAccount request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ServiceAccount. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteServiceAccount: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a service_account_id */ service_account_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description ServiceAccount request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ServiceAccount. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchServiceAccount: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a service_account_id */ service_account_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; OrgRole?: string | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description An identity of the organization that is not a person and does not log in through the identity provider, such as an automation or an agent. Each ServiceAccount is backed by a User, which is what other entities' Permissions and Groups name to grant it access. The ServiceAccount's own Permissions say who may manage it. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ServiceAccount"]; }; }; /** @description ServiceAccount request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ServiceAccount. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListServiceAccountUserKeys: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of UserKeys returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on UserKey: CreatedAt, Description, DisplayName, ExpiresAt, HiddenReason, Kid, LastUsedAt, Slug, UpdatedAt, UserID, UserKeyID. * * The whole string must be query-encoded. */ where?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for UserKey include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Select clause for specifying which fields to include in the response for UserKey. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, UserKeyID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Hidden UserKey entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** @description Maximum number of UserKey entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort UserKey results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering UserKey: CreatedAt, Description, DisplayName, ExpiresAt, HiddenReason, Kid, LastUsedAt, Slug, UpdatedAt, UserID, UserKeyID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the UserKey's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the UserKey entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path: { /** @description UUID of the service account whose keys are being managed. */ service_account_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedUserKey"][]; }; }; /** @description ServiceAccount request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ServiceAccount. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateServiceAccountUserKey: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description UUID of the service account whose keys are being managed. */ service_account_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateUserKeyRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UserKey"]; }; }; /** @description ServiceAccount request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ServiceAccount. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetServiceAccountUserKey: { parameters: { query?: { /** * @description Select clause for specifying which fields to include in the response for UserKey. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, UserKeyID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description UUID of the service account whose keys are being managed. */ service_account_id: string; /** @description UUID of the key. To address a key by its thumbprint, list with where "Kid = ''". */ user_key_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedUserKey"]; }; }; /** @description ServiceAccount request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ServiceAccount. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteServiceAccountUserKey: { parameters: { query?: never; header?: never; path: { /** @description UUID of the service account whose keys are being managed. */ service_account_id: string; /** @description UUID of the key. To address a key by its thumbprint, list with where "Kid = ''". */ user_key_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description ServiceAccount request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ServiceAccount. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListServiceAccountUserTokens: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of UserTokens returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on UserToken: CreatedAt, CreatedByUserID, Description, DisplayName, ExpiresAt, HiddenReason, Jti, LastUsedAt, RevokedAt, Slug, UpdatedAt, UserID, UserTokenID. * * The whole string must be query-encoded. */ where?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for UserToken include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Select clause for specifying which fields to include in the response for UserToken. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, UserTokenID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Hidden UserToken entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** @description Maximum number of UserToken entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort UserToken results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering UserToken: CreatedAt, CreatedByUserID, Description, DisplayName, ExpiresAt, HiddenReason, Jti, LastUsedAt, RevokedAt, Slug, UpdatedAt, UserID, UserTokenID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the UserToken's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the UserToken entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path: { /** @description UUID of the service account whose tokens are being managed. */ service_account_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedUserToken"][]; }; }; /** @description ServiceAccount request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ServiceAccount. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateServiceAccountUserToken: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description UUID of the service account whose tokens are being managed. */ service_account_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CreateUserTokenRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["IssuedUserToken"]; }; }; /** @description ServiceAccount request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ServiceAccount. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetServiceAccountUserToken: { parameters: { query?: { /** * @description Select clause for specifying which fields to include in the response for UserToken. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, UserTokenID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description UUID of the service account whose tokens are being managed. */ service_account_id: string; /** @description UUID of the token's record. To address a token by the jti it carries, list with where "Jti = ''". */ user_token_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedUserToken"]; }; }; /** @description ServiceAccount request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ServiceAccount. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteServiceAccountUserToken: { parameters: { query?: never; header?: never; path: { /** @description UUID of the service account whose tokens are being managed. */ service_account_id: string; /** @description UUID of the token's record. To address a token by the jti it carries, list with where "Jti = ''". */ user_token_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description ServiceAccount request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ServiceAccount. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; RevokeServiceAccountUserToken: { parameters: { query?: never; header?: never; path: { /** @description UUID of the service account whose tokens are being managed. */ service_account_id: string; /** @description UUID of the token's record. To address a token by the jti it carries, list with where "Jti = ''". */ user_token_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The record of a long-lived token issued to a ServiceAccount. The token itself is shown once, when it is issued, and is not stored; this record is what lets it be listed, traced to whoever issued it, and revoked on its own. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UserToken"]; }; }; /** @description ServiceAccount request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ServiceAccount data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ServiceAccount. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListSpaces: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Spaces returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, TriggerOtherUnitIDs, UpdatedAt, UpstreamSpaceID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Space list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Space). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Space include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Space. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Space are AttributeFilterID, AttributeIDs, ComponentID, OrganizationID, Permissions, ReleaseTargetID, TriggerFilterID, TriggerIDs, UpstreamSpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Space. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, SpaceID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Space entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View, ManageChildren, EditChildren, UseChildren, ViewChildren, CreateChildren, ApproveChildren, TargetEditChildren, TargetViewChildren. */ where_permission?: PathsSpaceGetParametersQueryWhere_permission; /** * @description Hidden Space entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Space, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Space: its Of, or the From of its Filter, must be Space. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Space entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Space results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Space: AttributeFilterID, AttributeHash, BackingUnitID, ComponentID, CreatedAt, DisplayName, HiddenReason, OrganizationID, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, UpdatedAt, UpstreamSpaceID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Space's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Space entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; /** @description Return summarized entity data */ summary?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedSpace"][]; }; }; /** @description Space request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Space. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateSpace: { parameters: { query?: { /** @description Give each Space written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Space's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description The Space, by slug or ID, for the backing Units with_backing_units creates. Required with it: a Space is in no Space of its own to hold one. */ backing_unit_space?: string; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Space"]; }; }; responses: { /** @description The logical container for most entities in ConfigHub. Namespaces triggers, units, targets, and other entities. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Space"]; }; }; /** @description Space request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Space. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetSpace: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for Space. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Space are AttributeFilterID, AttributeIDs, ComponentID, OrganizationID, Permissions, ReleaseTargetID, TriggerFilterID, TriggerIDs, UpstreamSpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Space. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, SpaceID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** @description Return summarized entity data */ summary?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedSpace"]; }; }; /** @description Space request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Space. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateSpace: { parameters: { query?: { /** @description If true, re-list the Triggers the Space selects (with WhereTrigger and/or TriggerFilterID, or the ones in it with neither) even if these fields have not changed */ refresh_triggers?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Space"]; }; }; responses: { /** @description The logical container for most entities in ConfigHub. Namespaces triggers, units, targets, and other entities. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Space"]; }; }; /** @description Space request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Space. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteSpace: { parameters: { query?: { /** @description Valid values are true and false. False is the default if unspecified. If true, recursively delete all entities within the deleted space(s) so long as none have delete gates. */ recursive?: string; /** @description Valid values are true and false. False is the default if unspecified. If true, recursively delete all entities within the deleted space(s) regardless whether any have delete gates. */ recursive_force?: string; /** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */ detach?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description Space request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Space. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchSpace: { parameters: { query?: { /** @description If true, re-list the Triggers the Space selects (with WhereTrigger and/or TriggerFilterID, or the ones in it with neither) even if these fields have not changed */ refresh_triggers?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** Format: uuid */ AttributeFilterID?: string | null; /** Format: uuid */ ComponentID?: string | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; /** Format: uuid */ ReleaseTargetID?: string | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** Format: uuid */ TriggerFilterID?: string | null; /** Format: uuid */ UpstreamSpaceID?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; WhereAttribute?: string | null; WhereTrigger?: string | null; }; }; }; responses: { /** @description The logical container for most entities in ConfigHub. Namespaces triggers, units, targets, and other entities. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Space"]; }; }; /** @description Space request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Space. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListExtendedAttestations: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Attestations returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Attestation: AttestationID, ChangeOrderID, Claims, CreatedAt, EvidenceAttestationIDs, ExpiresAt, Hash, HiddenReason, Note, OrganizationID, Permissions, ReleaseID, Result, RevokedAttestationID, SpaceID, Type, UserID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Attestation list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Attestation). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Attestation include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Attestation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Attestation are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Attestation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, AttestationID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Attestation entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsSpaceSpace_idAttestationGetParametersQueryWhere_permission; /** * @description Hidden Attestation entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Attestation, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Attestation: its Of, or the From of its Filter, must be Attestation. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Attestation entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Attestation results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Attestation: AttestationID, ChangeOrderID, CreatedAt, ExpiresAt, Hash, HiddenReason, Note, OrganizationID, ReleaseID, Result, RevokedAttestationID, SpaceID, Type, UserID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Attestation's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Attestation entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedAttestation"][]; }; }; /** @description ExtendedAttestation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ExtendedAttestation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ExtendedAttestation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateAttestation: { parameters: { query?: { /** @description Resolve the Revisions that would be covered and return the same response without writing anything. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["AttestationCreateRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AttestationCreateResponse"]; }; }; /** @description Attestation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attestation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attestation data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Attestation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetExtendedAttestation: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for Attestation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Attestation are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Attestation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, AttestationID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a attestation_id */ attestation_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Attestation with additional related entities expanded based on the request's include parameter. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedAttestation"]; }; }; /** @description ExtendedAttestation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ExtendedAttestation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ExtendedAttestation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAttributes: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Attributes returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Attribute: Annotations, AttributeID, BackingUnitID, CreatedAt, DataType, DeleteGates, DisplayName, Hash, HiddenReason, Labels, OrganizationID, Parameters, Permissions, ResourceTypePaths, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamAttributeID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Attribute list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Attribute). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Attribute include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Attribute. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Attribute are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Attribute. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, AttributeID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Attribute entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsSpaceSpace_idAttributeGetParametersQueryWhere_permission; /** * @description Hidden Attribute entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Attribute, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Attribute: its Of, or the From of its Filter, must be Attribute. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Attribute entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Attribute results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Attribute: AttributeID, BackingUnitID, CreatedAt, DataType, DisplayName, Hash, HiddenReason, OrganizationID, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamAttributeID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Attribute's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Attribute entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedAttribute"][]; }; }; /** @description Attribute request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Attribute. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateAttribute: { parameters: { query?: { /** @description Give each Attribute written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Attribute's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Attribute"]; }; }; responses: { /** * @description Defines a dynamic configuration attribute that registers getter and setter functions * and their associated paths in a Space's FunctionExecutor. Attributes enable per-Space * customization of the function registry by specifying a set of paths within a resource * type that can be read and written using generated get- and set- functions. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Attribute"]; }; }; /** @description Attribute request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Attribute. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetAttribute: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for Attribute. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Attribute are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Attribute. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, AttributeID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a attribute_id */ attribute_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedAttribute"]; }; }; /** @description Attribute request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Attribute. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateAttribute: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a attribute_id */ attribute_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Attribute"]; }; }; responses: { /** * @description Defines a dynamic configuration attribute that registers getter and setter functions * and their associated paths in a Space's FunctionExecutor. Attributes enable per-Space * customization of the function registry by specifying a set of paths within a resource * type that can be read and written using generated get- and set- functions. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Attribute"]; }; }; /** @description Attribute request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Attribute. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteAttribute: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a attribute_id */ attribute_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description Attribute request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Attribute. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchAttribute: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a attribute_id */ attribute_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; DataType?: string | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; Description?: string | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Parameters?: (Record | null)[] | null; Permissions?: { [key: string]: Record | null; } | null; ResourceTypePaths?: (Record | null)[] | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; ToolchainType?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** * @description Defines a dynamic configuration attribute that registers getter and setter functions * and their associated paths in a Space's FunctionExecutor. Attributes enable per-Space * customization of the function registry by specifying a set of paths within a resource * type that can be read and written using generated get- and set- functions. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Attribute"]; }; }; /** @description Attribute request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Attribute. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetAttributeDocument: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a attribute_id */ attribute_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityDocument"]; }; }; /** @description Attribute request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Attribute. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateAttributeDocument: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a attribute_id */ attribute_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["EntityDocumentEdit"]; }; }; responses: { /** * @description Defines a dynamic configuration attribute that registers getter and setter functions * and their associated paths in a Space's FunctionExecutor. Attributes enable per-Space * customization of the function registry by specifying a set of paths within a resource * type that can be read and written using generated get- and set- functions. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Attribute"]; }; }; /** @description Attribute request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Attribute not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description The Attribute changed since the document was read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Attribute. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListChangeOrders: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ChangeOrders returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, ReviewRequests, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ChangeOrder list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ChangeOrder). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ChangeOrder include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for ChangeOrder. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, Permissions, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for ChangeOrder. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ChangeOrderID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return ChangeOrder entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsSpaceSpace_idChange_orderGetParametersQueryWhere_permission; /** * @description Hidden ChangeOrder entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each ChangeOrder, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of ChangeOrder: its Of, or the From of its Filter, must be ChangeOrder. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of ChangeOrder entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort ChangeOrder results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering ChangeOrder: AbortedReason, AdoptedEndTagID, ChangeOrderID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, InvocationID, OrganizationID, PriorRevisions, ReleasePriorRevisions, ReleaseTagID, RestoreTagID, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the ChangeOrder's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the ChangeOrder entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedChangeOrder"][]; }; }; /** @description ChangeOrder request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeOrder. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateChangeOrder: { parameters: { query?: { /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ChangeOrder"]; }; }; responses: { /** @description Defines a change's identity as it moves between Spaces. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeOrder"]; }; }; /** @description ChangeOrder request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeOrder. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetChangeOrder: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for ChangeOrder. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, Permissions, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for ChangeOrder. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ChangeOrderID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a change_order_id */ change_order_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedChangeOrder"]; }; }; /** @description ChangeOrder request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeOrder. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateChangeOrder: { parameters: { query?: { /** @description If true, re-evaluate WhereSpace and/or SpaceFilterID into InScopeSpaceIDs, and re-derive what the ChangeOrder covers if the Spaces they select have changed, even if neither field has changed. Has no effect on a ChangeOrder with neither set. */ refresh_spaces?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a change_order_id */ change_order_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ChangeOrder"]; }; }; responses: { /** @description Defines a change's identity as it moves between Spaces. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeOrder"]; }; }; /** @description ChangeOrder request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeOrder. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteChangeOrder: { parameters: { query?: { /** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */ detach?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a change_order_id */ change_order_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description ChangeOrder request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeOrder. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchChangeOrder: { parameters: { query?: { /** @description If true, re-evaluate WhereSpace and/or SpaceFilterID into InScopeSpaceIDs, and re-derive what the ChangeOrder covers if the Spaces they select have changed, even if neither field has changed. Has no effect on a ChangeOrder with neither set. */ refresh_spaces?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a change_order_id */ change_order_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { AbortedReason?: string | null; /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** Format: uuid */ ChangeWorkflowID?: string | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; Description?: string | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** Format: uuid */ EndTagID?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; InScopeSpaceIDs?: (string | null)[] | null; /** Format: uuid */ InvocationID?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Parameters?: Record | null; Permissions?: { [key: string]: Record | null; } | null; PriorRevisions?: string | null; ReleasePriorRevisions?: string | null; ReviewRequests?: (Record | null)[] | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** Format: uuid */ SpaceFilterID?: string | null; /** Format: uuid */ UnitFilterID?: string | null; UpdateType?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; WhereSpace?: string | null; WhereUnit?: string | null; }; }; }; responses: { /** @description Defines a change's identity as it moves between Spaces. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeOrder"]; }; }; /** @description ChangeOrder request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeOrder. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; RefreshChangeOrderStage: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a change_order_id */ change_order_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Defines a change's identity as it moves between Spaces. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeOrder"]; }; }; /** @description ChangeOrder request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeOrder data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeOrder. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListChangeSets: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ChangeSets returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, ChangeWorkflow, ChangeWorkflowID, CloseOverride, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, Labels, OrganizationID, Permissions, ReviewRequests, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ChangeSet list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ChangeSet). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ChangeSet include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for ChangeSet. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeSet are EndTagID, OrganizationID, Permissions, SpaceID, StartTagID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for ChangeSet. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ChangeSetID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return ChangeSet entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsSpaceSpace_idChange_setGetParametersQueryWhere_permission; /** * @description Hidden ChangeSet entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each ChangeSet, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of ChangeSet: its Of, or the From of its Filter, must be ChangeSet. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of ChangeSet entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort ChangeSet results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering ChangeSet: ChangeSetID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, OrganizationID, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the ChangeSet's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the ChangeSet entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedChangeSet"][]; }; }; /** @description ChangeSet request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeSet. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateChangeSet: { parameters: { query?: { /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ChangeSet"]; }; }; responses: { /** @description Defines an entity changeset. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeSet"]; }; }; /** @description ChangeSet request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeSet. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetChangeSet: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for ChangeSet. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeSet are EndTagID, OrganizationID, Permissions, SpaceID, StartTagID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for ChangeSet. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ChangeSetID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a change_set_id */ change_set_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedChangeSet"]; }; }; /** @description ChangeSet request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeSet. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateChangeSet: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a change_set_id */ change_set_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ChangeSet"]; }; }; responses: { /** @description Defines an entity changeset. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeSet"]; }; }; /** @description ChangeSet request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeSet. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteChangeSet: { parameters: { query?: { /** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */ detach?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a change_set_id */ change_set_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description ChangeSet request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeSet. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchChangeSet: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a change_set_id */ change_set_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** Format: uuid */ ChangeWorkflowID?: string | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; Description?: string | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; ReviewRequests?: (Record | null)[] | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description Defines an entity changeset. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeSet"]; }; }; /** @description ChangeSet request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeSet data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeSet. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListChangeWorkflows: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ChangeWorkflows returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ChangeWorkflow: Annotations, AttestationPrerequisites, BackingUnitID, ChangeWorkflowID, CreatedAt, CustomPrerequisites, DeleteGates, DisplayName, Final, Hash, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, Stages, UpdatedAt, UpstreamChangeWorkflowID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ChangeWorkflow list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ChangeWorkflow). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ChangeWorkflow include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for ChangeWorkflow. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeWorkflow are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for ChangeWorkflow. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ChangeWorkflowID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return ChangeWorkflow entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsSpaceSpace_idChange_workflowGetParametersQueryWhere_permission; /** * @description Hidden ChangeWorkflow entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each ChangeWorkflow, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of ChangeWorkflow: its Of, or the From of its Filter, must be ChangeWorkflow. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of ChangeWorkflow entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort ChangeWorkflow results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering ChangeWorkflow: BackingUnitID, ChangeWorkflowID, CreatedAt, DisplayName, Hash, HiddenReason, OrganizationID, Slug, SpaceID, UpdatedAt, UpstreamChangeWorkflowID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the ChangeWorkflow's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the ChangeWorkflow entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedChangeWorkflow"][]; }; }; /** @description ChangeWorkflow request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeWorkflow. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateChangeWorkflow: { parameters: { query?: { /** @description Give each ChangeWorkflow written a backing Unit if it has none: a ConfigHub/YAML Unit holding the ChangeWorkflow's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ChangeWorkflow"]; }; }; responses: { /** @description Declares how a change is promoted: the ordered stages it moves through, which Spaces each stage selects, and the gates that have to pass before it enters one. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeWorkflow"]; }; }; /** @description ChangeWorkflow request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeWorkflow. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetChangeWorkflow: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for ChangeWorkflow. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ChangeWorkflow are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for ChangeWorkflow. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ChangeWorkflowID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a change_workflow_id */ change_workflow_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedChangeWorkflow"]; }; }; /** @description ChangeWorkflow request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeWorkflow. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateChangeWorkflow: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a change_workflow_id */ change_workflow_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ChangeWorkflow"]; }; }; responses: { /** @description Declares how a change is promoted: the ordered stages it moves through, which Spaces each stage selects, and the gates that have to pass before it enters one. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeWorkflow"]; }; }; /** @description ChangeWorkflow request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeWorkflow. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteChangeWorkflow: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a change_workflow_id */ change_workflow_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description ChangeWorkflow request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeWorkflow. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchChangeWorkflow: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a change_workflow_id */ change_workflow_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description The Attestations a stage, its releases, or Final may require. Declared once and named wherever they apply. */ AttestationPrerequisites?: (Record | null)[] | null; /** @description The checks a stage or Final may gate on beyond the built-in ones. Declared once and named wherever they apply. */ CustomPrerequisites?: (Record | null)[] | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. In a workflow with no stages, which governs a ChangeSet, what every Space the ChangeSet was opened in must satisfy for it to close. */ Final?: Record | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one. A workflow governing a ChangeOrder needs at least one; one governing a ChangeSet has none. */ Stages?: (Record | null)[] | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description Declares how a change is promoted: the ordered stages it moves through, which Spaces each stage selects, and the gates that have to pass before it enters one. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeWorkflow"]; }; }; /** @description ChangeWorkflow request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeWorkflow. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetChangeWorkflowDocument: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a change_workflow_id */ change_workflow_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityDocument"]; }; }; /** @description ChangeWorkflow request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeWorkflow. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateChangeWorkflowDocument: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a change_workflow_id */ change_workflow_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["EntityDocumentEdit"]; }; }; responses: { /** @description Declares how a change is promoted: the ordered stages it moves through, which Spaces each stage selects, and the gates that have to pass before it enters one. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChangeWorkflow"]; }; }; /** @description ChangeWorkflow request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ChangeWorkflow not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description The ChangeWorkflow changed since the document was read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ChangeWorkflow. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListChannels: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Channels returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Channel: Annotations, BackingUnitID, ChannelID, Commands, Condition, CreatedAt, DeleteGates, DisplayName, EventPosition, HiddenReason, IPAddress, Labels, LastMessage, LastSeenAt, OrganizationID, Permissions, Slug, SpaceID, Subscriptions, UpdatedAt, UpstreamChannelID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Channel list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Channel). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Channel include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Channel. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Channel are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Channel. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ChannelID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Channel entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View, Claim. */ where_permission?: PathsSpaceSpace_idChannelGetParametersQueryWhere_permission; /** * @description Hidden Channel entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Channel, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Channel: its Of, or the From of its Filter, must be Channel. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Channel entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Channel results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Channel: BackingUnitID, ChannelID, Condition, CreatedAt, DisplayName, EventPosition, HiddenReason, IPAddress, LastMessage, LastSeenAt, OrganizationID, Slug, SpaceID, UpdatedAt, UpstreamChannelID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Channel's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Channel entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedChannel"][]; }; }; /** @description Channel request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Channel. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateChannel: { parameters: { query?: { /** @description Give each Channel written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Channel's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Channel"]; }; }; responses: { /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Commands and Subscriptions are set by whoever manages it, not by the client. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Channel"]; }; }; /** @description Channel request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Channel. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetChannel: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for Channel. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Channel are OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Channel. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ChannelID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a channel_id */ channel_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedChannel"]; }; }; /** @description Channel request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Channel. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateChannel: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a channel_id */ channel_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Channel"]; }; }; responses: { /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Commands and Subscriptions are set by whoever manages it, not by the client. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Channel"]; }; }; /** @description Channel request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Channel. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteChannel: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a channel_id */ channel_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description Channel request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Channel. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchChannel: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a channel_id */ channel_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; Commands?: { [key: string]: Record | null; } | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; EventPosition?: number | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; Subscriptions?: (Record | null)[] | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Commands and Subscriptions are set by whoever manages it, not by the client. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Channel"]; }; }; /** @description Channel request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Channel. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ReportCommandRunResult: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a channel_id */ channel_id: string; /** @description Unique identifier for a command_run_id */ command_run_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CommandRunResult"]; }; }; responses: { /** @description CommandRun is one execution of a command on a Channel: the request, from the caller, and the outcome, from the channel's client. Create one at the Space, naming the command and optionally the Channel; without a Channel, the command is resolved to the one Channel in the Space that declares it. A Pending run waits for the client until its Deadline; a Delivered run has a fixed time to its outcome. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CommandRun"]; }; }; /** @description CommandRun request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description CommandRun not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description CommandRun data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing CommandRun. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetChannelDocument: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a channel_id */ channel_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityDocument"]; }; }; /** @description Channel request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Channel. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateChannelDocument: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a channel_id */ channel_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["EntityDocumentEdit"]; }; }; responses: { /** @description A Channel is a mailbox between ConfigHub and one bot. A client claims it and polls it; callers run the commands it declares on it, each as a CommandRun; it subscribes to events and bookmarks how far it has read. It owns no identity: a ServiceAccount claims it by holding Claim on it. Its Commands and Subscriptions are set by whoever manages it, not by the client. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Channel"]; }; }; /** @description Channel request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description The Channel changed since the document was read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Channel. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; AcquireChannelLease: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a channel_id */ channel_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description ChannelLease is the lease a client holds on a Channel: its ClaimToken, carried by every poll and release, and the TTL in seconds a poll renews it for. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChannelLease"]; }; }; /** @description Channel request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description The lease is held. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Channel. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ReleaseChannelLease: { parameters: { query: { /** @description The ClaimToken of the lease to release. */ claim_token: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a channel_id */ channel_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Channel request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Channel. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PollChannel: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a channel_id */ channel_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ChannelPollRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ChannelMessage"][]; }; }; /** @description Nothing to deliver within the timeout. */ 204: { headers: { [name: string]: unknown; }; content: { "application/json": string; }; }; /** @description Channel request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Channel not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description The lease is not held by this token. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Channel. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListCommands: { parameters: { query?: { /** @description List only the Channels declaring this command. */ command?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeclaredCommand"][]; }; }; /** @description DeclaredCommand request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description DeclaredCommand not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing DeclaredCommand. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListCommandRuns: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of CommandRuns returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, HiddenReason, OrganizationID, SpaceID, Status, TimeoutAt, UpdatedAt. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the CommandRun list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (CommandRun). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for CommandRun include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for CommandRun. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for CommandRun are ChannelID, OrganizationID, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for CommandRun. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, CommandRunID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return CommandRun entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsSpaceSpace_idCommand_runGetParametersQueryWhere_permission; /** * @description Hidden CommandRun entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each CommandRun, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of CommandRun: its Of, or the From of its Filter, must be CommandRun. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of CommandRun entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort CommandRun results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, HiddenReason, OrganizationID, Status, TimeoutAt, UpdatedAt. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the CommandRun's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the CommandRun entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedCommandRun"][]; }; }; /** @description CommandRun request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description CommandRun not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing CommandRun. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateCommandRun: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CommandRun"]; }; }; responses: { /** @description CommandRun is one execution of a command on a Channel: the request, from the caller, and the outcome, from the channel's client. Create one at the Space, naming the command and optionally the Channel; without a Channel, the command is resolved to the one Channel in the Space that declares it. A Pending run waits for the client until its Deadline; a Delivered run has a fixed time to its outcome. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CommandRun"]; }; }; /** @description CommandRun request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description CommandNotDeclared: no Channel in the Space declares the command. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CommandRunRefusal"]; }; }; /** @description CommandDeclaredByMany: several Channels in the Space declare the command; name one of Channels with ChannelID. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CommandRunRefusal"]; }; }; /** @description ChannelDoesNotDeclare: the Channel named by ChannelID does not declare the command. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CommandRunRefusal"]; }; }; /** @description Something went wrong while processing CommandRun. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetCommandRun: { parameters: { query?: { /** @description Seconds to hold for a terminal status; at most 25. */ wait?: number; /** * @description Include clause for expanding related entities in the response for CommandRun. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for CommandRun are ChannelID, OrganizationID, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for CommandRun. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, CommandRunID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a command_run_id */ command_run_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description CommandRun with additional related entities expanded based on the request's include parameter. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedCommandRun"]; }; }; /** @description CommandRun request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description CommandRun not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing CommandRun. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CancelCommandRun: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a command_run_id */ command_run_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description CommandRun is one execution of a command on a Channel: the request, from the caller, and the outcome, from the channel's client. Create one at the Space, naming the command and optionally the Channel; without a Channel, the command is resolved to the one Channel in the Space that declares it. A Pending run waits for the client until its Deadline; a Delivered run has a fixed time to its outcome. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CommandRun"]; }; }; /** @description CommandRun request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description CommandRun not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description The run is not Pending. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing CommandRun. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetSpaceDocument: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityDocument"]; }; }; /** @description Space request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Space. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateSpaceDocument: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["EntityDocumentEdit"]; }; }; responses: { /** @description The logical container for most entities in ConfigHub. Namespaces triggers, units, targets, and other entities. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Space"]; }; }; /** @description Space request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Space not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description The Space changed since the document was read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Space. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListFilters: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Filters returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Filter: Annotations, BackingUnitID, CreatedAt, DeleteGates, DisplayName, FilterID, From, FromSpaceID, Hash, HiddenReason, IncludeHidden, Labels, OrganizationID, Permissions, ResourceType, Slug, SpaceID, UpdatedAt, UpstreamFilterID, Where, WhereData. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Filter list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Filter). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Filter include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Filter. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Filter are FromSpaceID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Filter. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, FilterID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Filter entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsSpaceSpace_idFilterGetParametersQueryWhere_permission; /** * @description Hidden Filter entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Filter, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Filter: its Of, or the From of its Filter, must be Filter. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Filter entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Filter results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Filter: BackingUnitID, CreatedAt, DisplayName, FilterID, From, FromSpaceID, Hash, HiddenReason, IncludeHidden, OrganizationID, ResourceType, Slug, SpaceID, UpdatedAt, UpstreamFilterID, Where, WhereData. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Filter's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Filter entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; /** @description Entity type to filter for (e.g., Unit, Space). Must be specified together with 'id' parameter. */ entity?: string; /** @description Entity ID to filter for. Must be specified together with 'entity' parameter. */ id?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedFilter"][]; }; }; /** @description Filter request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Filter. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateFilter: { parameters: { query?: { /** @description Give each Filter written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Filter's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Filter"]; }; }; responses: { /** @description Defines an entity filter. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Filter"]; }; }; /** @description Filter request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Filter. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetFilter: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for Filter. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Filter are FromSpaceID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Filter. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, FilterID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a filter_id */ filter_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedFilter"]; }; }; /** @description Filter request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Filter. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateFilter: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a filter_id */ filter_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Filter"]; }; }; responses: { /** @description Defines an entity filter. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Filter"]; }; }; /** @description Filter request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Filter. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteFilter: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a filter_id */ filter_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description Filter request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Filter. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchFilter: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a filter_id */ filter_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; From?: string | null; /** Format: uuid */ FromSpaceID?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; IncludeHidden?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; ResourceType?: string | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; Where?: string | null; WhereData?: string | null; }; }; }; responses: { /** @description Defines an entity filter. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Filter"]; }; }; /** @description Filter request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Filter. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetFilterDocument: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a filter_id */ filter_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityDocument"]; }; }; /** @description Filter request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Filter. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateFilterDocument: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a filter_id */ filter_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["EntityDocumentEdit"]; }; }; responses: { /** @description Defines an entity filter. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Filter"]; }; }; /** @description Filter request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Filter not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description The Filter changed since the document was read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Filter. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListFunctions: { parameters: { query?: { /** @description Type of entity whose functions should be listed: channel */ entity?: string; /** @description ID of the channel whose functions should be listed */ id?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of FunctionSignatures returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on FunctionSignature: AttributeName, Description, FunctionName, FunctionType, Hermetic, Idempotent, Mutating, OutputInfo.Description, OutputInfo.OutputType, OutputInfo.ResultName, Replayable, RequiredParameters, ToolchainType, Validating, VarArgs. * * The whole string must be query-encoded. */ where?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { [key: string]: { [key: string]: components["schemas"]["FunctionSignature"]; }; }; }; }; /** @description Function request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Function not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Function. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; InvokeFunctions: { parameters: { query?: { /** @description Unit ID of the Revision to invoke functions on */ unit_id?: string; /** @description Revision ID to invoke functions on instead of units */ revision_id?: string; /** @description Dry run mode: when true, skip updating configuration data even if it changed */ dry_run?: string; /** * @deprecated * @description Deprecated: use guards, as {"Override":"Upstream"} or {"Override":"External"}. Records the paths this operation writes as local overrides a merge must not overwrite: each Unit's Override guard -- Override=Upstream for a Unit with an upstream Unit, Override=External for one without -- with the clearance to write over one. A guard this request names under Override wins. */ protect?: boolean; /** @description The classes of guarded reason this operation is cleared for, as a JSON Clearance -- a list of {Key, Operator, Values} requirements, where Operator is Exists, In, NotIn, or DoesNotExist. A path whose guards this does not cover is not written, and the withheld change is reported as a Guarded conflict. An absent or empty clearance clears nothing, which only matters for a Unit that has guards. */ clearance?: string; /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */ guards?: string; /** @description The guards this operation records on the paths it writes as inherited guards, in the form guards takes: a clone of the Unit receives them, and a merge carries them, and any later change to them, to the Units downstream of it. Guards set through guards stay with the Unit they are on. A key may not be in both. The clearance has to cover these as it covers guards. */ inherited_guards?: string; /** @description Must match ChangeSetID of affected Units unless in dry run mode; not valid when invoked on Revisions */ change_set_id?: string; /** @description ChangeOrder to promote, which must have UpdateType Invoke. What runs then comes from the ChangeOrder rather than from the request body, which may not carry functions, triggers or invocations of its own; that is what holds every Space in scope to the same change. Only the Units the ChangeOrder covers are reached, a Unit that has already taken it is passed over, and every Unit reached is marked with the ChangeOrder's start and end Tags -- both on the head, with no Revision made, where the invocation changed nothing. Not valid when invoked on Revisions. */ change_order?: string; /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */ subgroup?: string; /** @description Additional configuration data to pass as OtherData to the functions the request names, and to the invocations that name none of their own; triggers pass what they name. Either a revision of each Unit, named LastReleasedRevisionNum or HeadRevisionNum, optionally prefixed with 'Before:' (e.g., Before:HeadRevisionNum), which the functions read under that name, or another Unit, as Unit::, whose head data the functions read under (e.g., Unit:policy: for vet-validating-admission-policy); the caller needs View permission on it. May be repeated or comma-separated. A function passed no revision is passed the revisions its signature lists in OtherDataExpected. */ other_data_source?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Unit list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Unit). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Comma-separated parts of the result to return in addition to the default: ConfigData for the configuration the invocation produced, carried whether or not the invocation changed it. Without it, the configuration is present only when the invocation changed it, and an unchanged result is reported by DataHash alone. Diff for what the invocation changed in each Unit, path by path with the values on both sides. * * Supported values: ConfigData, Diff. */ include?: string; /** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */ resource_type?: string; /** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|` splits the path: the left side selects, and the right side is a property of what was selected. On the right side of a `.|`, and only there, `!=` is true when the property is absent: `spec.containers.*.|image != 'nginx'` selects the containers and asks that none of their images be nginx, which a container with no image satisfies. Everywhere else a path that is not present is not a match, `!=` included. String literals are quoted with single quotes, such as `'string'`. Integer and boolean literals are also supported for attributes of those types. The whole string must be query-encoded. */ where_data?: string; /** @description Which engine answers where_data and resource_type: `sql` (the default) evaluates the expression against the stored resource projection in a single query, falling back to the function engine for the expressions it cannot translate; `function` invokes the where-filter function on each candidate Unit, reading every one's configuration; `shadow` runs both, answers with `function`, and logs any disagreement. Temporary: `function` is the escape hatch for one release, after which this parameter goes away. */ where_data_engine?: string; /** @description Where expression to match Triggers. Matched triggers are invoked on each unit to filter by validation results. Use with triggers_passed to control whether passing or failing units are returned (default: failing). */ where_trigger?: string; /** @description Filter UUID (with From=Trigger). The filter's matching triggers are invoked on units to filter by validation results. Can be combined with where_trigger. */ trigger_filter?: string; /** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */ triggers_passed?: boolean; /** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */ view?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["FunctionInvocationsRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FunctionInvocationsResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FunctionInvocationsResponse"][]; }; }; /** @description Function request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Function not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Function data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to process configuration data */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Function. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A Channel's client is unavailable; one or more function sources were not executed */ 503: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Timed out waiting for a Channel's client to return a function result */ 504: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListInvocations: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Invocations returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID. * * The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Invocation list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Invocation). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Invocation include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Invocation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Invocation are ChannelID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Invocation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, InvocationID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Invocation entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsSpaceSpace_idInvocationGetParametersQueryWhere_permission; /** * @description Hidden Invocation entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Invocation, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Invocation: its Of, or the From of its Filter, must be Invocation. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Invocation entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Invocation results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Invocation: BackingUnitID, ChannelID, CreatedAt, DisplayName, Hash, HiddenReason, InvocationID, OrganizationID, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Invocation's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Invocation entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedInvocation"][]; }; }; /** @description Invocation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Invocation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateInvocation: { parameters: { query?: { /** @description Give each Invocation written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Invocation's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Invocation"]; }; }; responses: { /** @description Defines a stored, reusable call to one or more functions, executed in the order they are listed. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Invocation"]; }; }; /** @description Invocation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Invocation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetInvocation: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for Invocation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Invocation are ChannelID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Invocation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, InvocationID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a invocation_id */ invocation_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedInvocation"]; }; }; /** @description Invocation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Invocation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateInvocation: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a invocation_id */ invocation_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Invocation"]; }; }; responses: { /** @description Defines a stored, reusable call to one or more functions, executed in the order they are listed. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Invocation"]; }; }; /** @description Invocation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Invocation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteInvocation: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a invocation_id */ invocation_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description Invocation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Invocation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchInvocation: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a invocation_id */ invocation_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** Format: uuid */ ChannelID?: string | null; Clearance?: (Record | null)[] | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; FunctionInvocations?: (Record | null)[] | null; Guards?: { [key: string]: string | null; } | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; OtherUnitIDs?: { [key: string]: string | null; } | null; Parameters?: (Record | null)[] | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; ToolchainType?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description Defines a stored, reusable call to one or more functions, executed in the order they are listed. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Invocation"]; }; }; /** @description Invocation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Invocation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetInvocationDocument: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a invocation_id */ invocation_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityDocument"]; }; }; /** @description Invocation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Invocation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateInvocationDocument: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a invocation_id */ invocation_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["EntityDocumentEdit"]; }; }; responses: { /** @description Defines a stored, reusable call to one or more functions, executed in the order they are listed. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Invocation"]; }; }; /** @description Invocation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Invocation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description The Invocation changed since the document was read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Invocation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListLinks: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Links returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, ManualBindings, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Link list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Link). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Link include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Link. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Link are FromUnitID, OrganizationID, Permissions, SpaceID, ToSpaceID, ToUnitID, TransformInvocationID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Link. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, LinkID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Link entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsSpaceSpace_idLinkGetParametersQueryWhere_permission; /** * @description Hidden Link entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Link, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Link: its Of, or the From of its Filter, must be Link. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Link entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Link results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Link: AutoUpdate, BackingUnitID, CreatedAt, DisplayName, DownstreamLastMergedRevisionNum, FromUnitID, Hash, HiddenReason, LinkID, MergeEnableSubtraction, OrganizationID, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamLastMergedRevisionNum, UpstreamLinkID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Link's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Link entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedLink"][]; }; }; /** @description Link request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Link. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateLink: { parameters: { query?: { /** @description Give each Link written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Link's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Link"]; }; }; responses: { /** * @description Link connects two config Units in a dependency / producer-consumer relationship. * A Link indicates that selected config data from the upstream To Unit (the producer) * should be propagated to the downstream From Unit (the consumer). * Links must be created in the same Space as the From Unit. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Link"]; }; }; /** @description Link request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Link. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetLink: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for Link. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Link are FromUnitID, OrganizationID, Permissions, SpaceID, ToSpaceID, ToUnitID, TransformInvocationID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Link. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, LinkID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a link_id */ link_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedLink"]; }; }; /** @description Link request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Link. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateLink: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a link_id */ link_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Link"]; }; }; responses: { /** * @description Link connects two config Units in a dependency / producer-consumer relationship. * A Link indicates that selected config data from the upstream To Unit (the producer) * should be propagated to the downstream From Unit (the consumer). * Links must be created in the same Space as the From Unit. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Link"]; }; }; /** @description Link request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Link. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteLink: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a link_id */ link_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description Link request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Link. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchLink: { parameters: { query?: { /** @description Swap the FromUnit and ToUnit directions of the link */ reverse?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a link_id */ link_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; AutoUpdate?: boolean | null; Clearance?: (Record | null)[] | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; DownstreamLastMergedRevisionNum?: number | null; DownstreamPaths?: (Record | null)[] | null; DownstreamSetters?: (Record | null)[] | null; /** Format: uuid */ FromUnitID?: string | null; Guards?: { [key: string]: string | null; } | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; ManualBindings?: (Record | null)[] | null; MergeEnableSubtraction?: boolean | null; Permissions?: { [key: string]: Record | null; } | null; Protect?: boolean | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; Squash?: boolean | null; /** Format: uuid */ ToSpaceID?: string | null; /** Format: uuid */ ToUnitID?: string | null; /** Format: uuid */ TransformInvocationID?: string | null; UpdateType?: string | null; UpstreamGetters?: (Record | null)[] | null; UpstreamLastMergedRevisionNum?: number | null; UpstreamPaths?: (Record | null)[] | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; WhereMutation?: string | null; WhereResource?: string | null; }; }; }; responses: { /** * @description Link connects two config Units in a dependency / producer-consumer relationship. * A Link indicates that selected config data from the upstream To Unit (the producer) * should be propagated to the downstream From Unit (the consumer). * Links must be created in the same Space as the From Unit. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Link"]; }; }; /** @description Link request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Link. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetLinkDocument: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a link_id */ link_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityDocument"]; }; }; /** @description Link request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Link. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateLinkDocument: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a link_id */ link_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["EntityDocumentEdit"]; }; }; responses: { /** * @description Link connects two config Units in a dependency / producer-consumer relationship. * A Link indicates that selected config data from the upstream To Unit (the producer) * should be propagated to the downstream From Unit (the consumer). * Links must be created in the same Space as the From Unit. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Link"]; }; }; /** @description Link request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Link not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description The Link changed since the document was read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Link. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListExtendedReleases: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Releases returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Release: Annotations, ChangeOrderID, CreatedAt, DeleteGates, Digest, HiddenReason, Labels, LiveStatus, ManifestDigest, OCIRepositoryURL, OrganizationID, Permissions, Published, ReleaseID, ReleaseNum, SkippedUnits, SpaceID, TagID, TargetID, UnitCount, UpdatedAt, UserID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Release list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Release). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Release include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Release. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Release are ChangeOrderID, OrganizationID, Permissions, SpaceID, TagID, TargetID, UserID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Release. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ReleaseID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Release entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsSpaceSpace_idReleaseGetParametersQueryWhere_permission; /** * @description Hidden Release entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Release, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Release: its Of, or the From of its Filter, must be Release. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Release entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Release results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Release: ChangeOrderID, CreatedAt, Digest, HiddenReason, ManifestDigest, OrganizationID, Published, ReleaseID, ReleaseNum, SpaceID, TagID, TargetID, UnitCount, UpdatedAt, UserID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Release's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Release entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedRelease"][]; }; }; /** @description ExtendedRelease request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ExtendedRelease not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ExtendedRelease. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PublishRelease: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ReleasePublishRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReleasePublishResponse"]; }; }; /** @description Release request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Release not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Release data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A Unit to be bundled has outstanding validation errors, or, for a change order, the bundled Revisions do not satisfy the ReleasePrerequisites of the stage the Space belongs to. Error says why, Message repeats its message, and Gates lists each ReleasePrerequisite evaluated. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReleasePublishResponse"]; }; }; /** @description Something went wrong while processing Release. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetExtendedRelease: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for Release. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Release are ChangeOrderID, OrganizationID, Permissions, SpaceID, TagID, TargetID, UserID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Release. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ReleaseID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a release_id */ release_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Release with additional related entities expanded based on the request's include parameter. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedRelease"]; }; }; /** @description ExtendedRelease request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ExtendedRelease not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ExtendedRelease. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateRelease: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a release_id */ release_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Release"]; }; }; responses: { /** @description Release is a published bundle of the configuration of the Units in a Space that are not Unreleasable, for the Space's release Target. It is created by publishing, taken out of service by withdrawing, and removed by deleting; its bundled content is never updated, though its Labels, Annotations, DeleteGates, and LiveStatus can be. The bundle is stored as an OCI image (a tar.gz layer plus manifest) so it can be served to and consumed by the Target. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Release"]; }; }; /** @description Release request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Release not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Release data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Release. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteRelease: { parameters: { query?: { /** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */ detach?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a release_id */ release_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description Release request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Release not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Release is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Release could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Release. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchRelease: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a release_id */ release_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; LiveStatus?: Record | null; Permissions?: { [key: string]: Record | null; } | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description Release is a published bundle of the configuration of the Units in a Space that are not Unreleasable, for the Space's release Target. It is created by publishing, taken out of service by withdrawing, and removed by deleting; its bundled content is never updated, though its Labels, Annotations, DeleteGates, and LiveStatus can be. The bundle is stored as an OCI image (a tar.gz layer plus manifest) so it can be served to and consumed by the Target. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Release"]; }; }; /** @description Release request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Release not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Release data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Release. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DownloadReleaseData: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a release_id */ release_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/gzip": string; }; }; /** @description Release request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Release not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Release. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; WithdrawRelease: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a release_id */ release_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Release is a published bundle of the configuration of the Units in a Space that are not Unreleasable, for the Space's release Target. It is created by publishing, taken out of service by withdrawing, and removed by deleting; its bundled content is never updated, though its Labels, Annotations, DeleteGates, and LiveStatus can be. The bundle is stored as an OCI image (a tar.gz layer plus manifest) so it can be served to and consumed by the Target. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Release"]; }; }; /** @description Release request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Release not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Release data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A Unit in the Release's bundle has outstanding destroy gates */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Release. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListTags: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Tags returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrganizationID, Permissions, ReleaseID, Slug, SpaceID, TagID, UpdatedAt. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Tag list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Tag). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Tag include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Tag. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Tag are ChangeSetID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Tag. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, TagID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Tag entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsSpaceSpace_idTagGetParametersQueryWhere_permission; /** * @description Hidden Tag entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Tag, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Tag: its Of, or the From of its Filter, must be Tag. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Tag entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Tag results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Tag: ChangeOrderID, ChangeSetID, CreatedAt, DisplayName, HiddenReason, OrganizationID, ReleaseID, Slug, SpaceID, TagID, UpdatedAt. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Tag's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Tag entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedTag"][]; }; }; /** @description Tag request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Tag. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateTag: { parameters: { query?: { /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Tag"]; }; }; responses: { /** @description Defines a Tag that can be used to identify a set of Revisions across Units. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Tag"]; }; }; /** @description Tag request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Tag. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetTag: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for Tag. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Tag are ChangeSetID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Tag. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, TagID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a tag_id */ tag_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedTag"]; }; }; /** @description Tag request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Tag. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateTag: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a tag_id */ tag_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Tag"]; }; }; responses: { /** @description Defines a Tag that can be used to identify a set of Revisions across Units. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Tag"]; }; }; /** @description Tag request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Tag. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteTag: { parameters: { query?: { /** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */ detach?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a tag_id */ tag_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description Tag request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Tag. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchTag: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a tag_id */ tag_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description Defines a Tag that can be used to identify a set of Revisions across Units. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Tag"]; }; }; /** @description Tag request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Tag. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListTargets: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Targets returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Target: Annotations, BackingUnitID, CreatedAt, DeleteGates, DisplayName, Facts, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, TargetID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamTargetID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Target list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Target). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Target include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Target. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Target are OrganizationID, Permissions, SpaceID, TriggerFilterID, TriggerIDs. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Target. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, TargetID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Target entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View, ManageChildren, EditChildren, UseChildren, ViewChildren, CreateChildren, ApproveChildren, TargetEditChildren, TargetViewChildren. */ where_permission?: PathsSpaceSpace_idTargetGetParametersQueryWhere_permission; /** * @description Hidden Target entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Target, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Target: its Of, or the From of its Filter, must be Target. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Target entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Target results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Target: BackingUnitID, CreatedAt, DisplayName, HiddenReason, OrganizationID, Slug, SpaceID, TargetID, TriggerFilterID, TriggerHash, UpdatedAt, UpstreamTargetID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Target's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Target entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedTarget"][]; }; }; /** @description Target request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Target. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateTarget: { parameters: { query?: { /** @description Give each Target written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Target's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Target"]; }; }; responses: { /** @description Target represents a deployment target in ConfigHub: where configuration is destined. A Space's Releases are published for its release Target and pulled from ConfigHub's OCI registry by a GitOps tool such as Argo CD or Flux. Access to a Target is granted through its Permissions. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Target"]; }; }; /** @description Target request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Target. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetTarget: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for Target. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Target are OrganizationID, Permissions, SpaceID, TriggerFilterID, TriggerIDs. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Target. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, TargetID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a target_id */ target_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedTarget"]; }; }; /** @description Target request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Target. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateTarget: { parameters: { query?: { /** @description Re-list the Triggers matching WhereTrigger and/or TriggerFilterID even if these fields have not changed */ refresh_triggers?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a target_id */ target_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Target"]; }; }; responses: { /** @description Target represents a deployment target in ConfigHub: where configuration is destined. A Space's Releases are published for its release Target and pulled from ConfigHub's OCI registry by a GitOps tool such as Argo CD or Flux. Access to a Target is granted through its Permissions. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Target"]; }; }; /** @description Target request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Target. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteTarget: { parameters: { query?: { /** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */ detach?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a target_id */ target_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description Target request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Target. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchTarget: { parameters: { query?: { /** @description Re-list the Triggers matching WhereTrigger and/or TriggerFilterID even if these fields have not changed */ refresh_triggers?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a target_id */ target_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; Facts?: { [key: string]: string | null; } | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** Format: uuid */ TriggerFilterID?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; WhereTrigger?: string | null; }; }; }; responses: { /** @description Target represents a deployment target in ConfigHub: where configuration is destined. A Space's Releases are published for its release Target and pulled from ConfigHub's OCI registry by a GitOps tool such as Argo CD or Flux. Access to a Target is granted through its Permissions. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Target"]; }; }; /** @description Target request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Target. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetTargetDocument: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a target_id */ target_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityDocument"]; }; }; /** @description Target request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Target. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateTargetDocument: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a target_id */ target_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["EntityDocumentEdit"]; }; }; responses: { /** @description Target represents a deployment target in ConfigHub: where configuration is destined. A Space's Releases are published for its release Target and pulled from ConfigHub's OCI registry by a GitOps tool such as Argo CD or Flux. Access to a Target is granted through its Permissions. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Target"]; }; }; /** @description Target request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description The Target changed since the document was read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Target. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListTriggers: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Triggers returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, OtherUnitSelections, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit. * * A Trigger returns the function it invokes inline rather than in a FunctionInvocation object, so `where` names FunctionName and Arguments directly. The arguments are addressed with dot notation into `Arguments`, which is a list: `Arguments.?ParameterName=attribute-name.Value = 'owner'` reads the argument bound to a named parameter, `Arguments.*.Value` matches any argument's value, and `Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Trigger list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Trigger). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Trigger include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Trigger. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Trigger are ChannelID, InvocationID, OrganizationID, Permissions, SpaceID, UnitFilterID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Trigger. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, TriggerID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Trigger entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsSpaceSpace_idTriggerGetParametersQueryWhere_permission; /** * @description Hidden Trigger entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Trigger, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Trigger: its Of, or the From of its Filter, must be Trigger. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Trigger entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Trigger results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Trigger: BackingUnitID, ChannelID, CreatedAt, Description, Disabled, DisplayName, Event, FunctionName, Hash, HiddenReason, InvocationID, OrganizationID, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Trigger's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Trigger entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedTrigger"][]; }; }; /** @description Trigger request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Trigger. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateTrigger: { parameters: { query?: { /** @description Give each Trigger written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Trigger's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Trigger"]; }; }; responses: { /** * @description Defines an automated function invocation that executes in response to specific * Unit lifecycle events in ConfigHub. Triggers can be used to implement validation rules, * automated transformations, or other custom logic that should run when configuration * changes occur. Each Trigger is associated with a specific Space and can be configured * to execute on events. * * Triggers can be either validating (checking configuration validity without modifying it) * or mutating (making changes to the configuration). They can be disabled, and validating * triggers can be set to Warn mode to produce non-blocking ValidationWarnings instead of ValidationErrors. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Trigger"]; }; }; /** @description Trigger request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Trigger. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetTrigger: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for Trigger. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Trigger are ChannelID, InvocationID, OrganizationID, Permissions, SpaceID, UnitFilterID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Trigger. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, TriggerID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a trigger_id */ trigger_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedTrigger"]; }; }; /** @description Trigger request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Trigger. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateTrigger: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a trigger_id */ trigger_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Trigger"]; }; }; responses: { /** * @description Defines an automated function invocation that executes in response to specific * Unit lifecycle events in ConfigHub. Triggers can be used to implement validation rules, * automated transformations, or other custom logic that should run when configuration * changes occur. Each Trigger is associated with a specific Space and can be configured * to execute on events. * * Triggers can be either validating (checking configuration validity without modifying it) * or mutating (making changes to the configuration). They can be disabled, and validating * triggers can be set to Warn mode to produce non-blocking ValidationWarnings instead of ValidationErrors. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Trigger"]; }; }; /** @description Trigger request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Trigger. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteTrigger: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a trigger_id */ trigger_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description Trigger request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Trigger. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchTrigger: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a trigger_id */ trigger_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description Function arguments */ Arguments?: (Record | null)[] | null; /** Format: uuid */ ChannelID?: string | null; Clearance?: (Record | null)[] | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; Description?: string | null; Disabled?: boolean | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; Event?: string | null; /** @description Function name */ FunctionName?: string | null; Guards?: { [key: string]: string | null; } | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** Format: uuid */ InvocationID?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; OtherUnitIDs?: { [key: string]: string | null; } | null; OtherUnitSelections?: { [key: string]: Record | null; } | null; Permissions?: { [key: string]: Record | null; } | null; Protect?: boolean | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; ToolchainType?: string | null; /** Format: uuid */ UnitFilterID?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; Warn?: boolean | null; /** @description Per-invocation resource filter. AND-combined with the request-level WhereResource. Same path syntax as the request-level field (see ParseAndValidateWhereResource). */ WhereResource?: string | null; WhereUnit?: string | null; }; }; }; responses: { /** * @description Defines an automated function invocation that executes in response to specific * Unit lifecycle events in ConfigHub. Triggers can be used to implement validation rules, * automated transformations, or other custom logic that should run when configuration * changes occur. Each Trigger is associated with a specific Space and can be configured * to execute on events. * * Triggers can be either validating (checking configuration validity without modifying it) * or mutating (making changes to the configuration). They can be disabled, and validating * triggers can be set to Warn mode to produce non-blocking ValidationWarnings instead of ValidationErrors. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Trigger"]; }; }; /** @description Trigger request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Trigger. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetTriggerDocument: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a trigger_id */ trigger_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityDocument"]; }; }; /** @description Trigger request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Trigger. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateTriggerDocument: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a trigger_id */ trigger_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["EntityDocumentEdit"]; }; }; responses: { /** * @description Defines an automated function invocation that executes in response to specific * Unit lifecycle events in ConfigHub. Triggers can be used to implement validation rules, * automated transformations, or other custom logic that should run when configuration * changes occur. Each Trigger is associated with a specific Space and can be configured * to execute on events. * * Triggers can be either validating (checking configuration validity without modifying it) * or mutating (making changes to the configuration). They can be disabled, and validating * triggers can be set to Warn mode to produce non-blocking ValidationWarnings instead of ValidationErrors. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["Trigger"]; }; }; /** @description Trigger request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description The Trigger changed since the document was read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Trigger. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListUnits: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Unit list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Unit). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Unit include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Unit. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Unit. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, UnitID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Unit entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View, Approve, TargetEdit, TargetView. */ where_permission?: PathsSpaceSpace_idUnitGetParametersQueryWhere_permission; /** * @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Unit, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Unit: its Of, or the From of its Filter, must be Unit. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Unit entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Unit results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Unit: ChangeSetID, CreatedAt, DataHash, DisplayName, HeadRevisionID, HeadRevisionNum, HiddenReason, LastChangeDescription, LastReleasedRevisionNum, OrganizationID, Slug, SpaceID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamUnitID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Unit's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Unit entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; /** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */ resource_type?: string; /** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|` splits the path: the left side selects, and the right side is a property of what was selected. On the right side of a `.|`, and only there, `!=` is true when the property is absent: `spec.containers.*.|image != 'nginx'` selects the containers and asks that none of their images be nginx, which a container with no image satisfies. Everywhere else a path that is not present is not a match, `!=` included. String literals are quoted with single quotes, such as `'string'`. Integer and boolean literals are also supported for attributes of those types. The whole string must be query-encoded. */ where_data?: string; /** @description Which engine answers where_data and resource_type: `sql` (the default) evaluates the expression against the stored resource projection in a single query, falling back to the function engine for the expressions it cannot translate; `function` invokes the where-filter function on each candidate Unit, reading every one's configuration; `shadow` runs both, answers with `function`, and logs any disagreement. Temporary: `function` is the escape hatch for one release, after which this parameter goes away. */ where_data_engine?: string; /** @description Where expression to match Triggers. Matched triggers are invoked on each unit to filter by validation results. Use with triggers_passed to control whether passing or failing units are returned (default: failing). */ where_trigger?: string; /** @description Filter UUID (with From=Trigger). The filter's matching triggers are invoked on units to filter by validation results. Can be combined with where_trigger. */ trigger_filter?: string; /** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */ triggers_passed?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedUnit"][]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateUnit: { parameters: { query?: { /** @description Unique identifier for a upstream_space_id */ upstream_space_id?: string; /** @description Unique identifier for a upstream_unit_id */ upstream_unit_id?: string; /** @description Revision of the upstream Unit to copy. The default is its head, which is what a clone has always taken. Takes the same forms as merge_end and restore -- a revision number, a named revision, 'Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Before:...' -- resolved against the Unit being cloned from, so a bulk clone lands on a different revision of each source Unit. 'Before:ChangeOrder:uuid' is what a promotion uses: it names the state the change starts from, which for a Unit no target has taken yet is its first revision, so the upgrade that follows replays the change into the clone rather than the clone arriving with the change already folded in. Requires upstream_unit_id (or, in bulk, a source Unit to clone). */ upstream_revision?: string; /** @description Also create a MergeUnits Link from each upstream Unit back to its clone, alongside the UpgradeUnit Link a clone always gets. The upgrade Link carries changes from the upstream Unit into the clone; this one carries them the other way, which is what makes a clone usable as a draft: change it, review it, then resolve the Link (resolve=Link:...) on the upstream Unit to merge the change home. A Unit may be the source of several of these -- one per outstanding draft -- so each is named for the clone it takes changes from (syncback--) rather than for the Unit they all point at. The Link is created in the upstream Unit's Space, which the caller must be allowed to create Links in. Requires upstream_unit_id (or, in bulk, a source Unit to clone). */ syncback?: boolean; /** @description Identifier of the external source. Sets the source type to MergeExternal and appends the source name to the change description. */ merge_external_source?: string; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** * @description Comma-separated parts of the result to return in addition to the Unit: ConfigData for the configuration the operation produced, MutationSources for what set each value in it, and Diff for what the operation changed, path by path with the values on both sides. None is a field of a Unit, and each costs something to return, so they are returned only when named. A dry run stores nothing, so this is the only way to see what it would have produced. * * Supported values: ConfigData, MutationSources, Diff. */ include?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Unit"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitCreateOrUpdateResponse"]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to create unit(s) due to configuration data problem */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetUnit: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for Unit. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Unit. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, UnitID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Unit with capability to extend additional related entities. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedUnit"]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateUnit: { parameters: { query?: { /** @description Unique identifier for a revision_id */ revision_id?: string; /** @description Dry run mode: return changed unit(s) but don't update configuration data */ dry_run?: boolean; /** * @deprecated * @description Deprecated: use guards, as {"Override":"Upstream"} or {"Override":"External"}. Records the paths this operation writes as local overrides a merge must not overwrite: each Unit's Override guard -- Override=Upstream for a Unit with an upstream Unit, Override=External for one without -- with the clearance to write over one. A guard this request names under Override wins. Has no effect with restore. */ protect?: boolean; /** @description The classes of guarded reason this operation is cleared for, as a JSON Clearance -- a list of {Key, Operator, Values} requirements, where Operator is Exists, In, NotIn, or DoesNotExist. A path whose guards this does not cover is not written, and the withheld change is reported as a Guarded conflict. An absent or empty clearance clears nothing, which only matters for a Unit that has guards. */ clearance?: string; /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */ guards?: string; /** @description The guards this operation records on the paths it writes as inherited guards, in the form guards takes: a clone of the Unit receives them, and a merge carries them, and any later change to them, to the Units downstream of it. Guards set through guards stay with the Unit they are on. A key may not be in both. The clearance has to cover these as it covers guards. */ inherited_guards?: string; /** @description Merge the range as one rebased diff and record it as one Revision, instead of walking it. By default a merge replays: it takes the source's Revisions in order and, where a Revision records function invocations that can be re-executed, runs them against this Unit rather than rebasing their recorded paths onto it -- so a change lands where this Unit's own structure puts it -- and records each source Revision that has an effect here as a Revision of its own, carrying that Revision's change description, its own conflicts, and one Mutation per source Mutation. Squashing gives up both: the range arrives as a single rebased patch in a single Revision, which is what a merge did before replay existed. Accepted with upgrade, merge_source, and resolve of an UpgradeUnit or MergeUnits Link, and refused elsewhere, since there is no range to walk. A Link can ask for it standingly with its Squash field. */ squash?: boolean; /** @description Upgrade the unit to the latest version of its upstream unit */ upgrade?: boolean; /** @description Restore revision source. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */ restore?: string; /** @description Resolve Links from this (downstream) Unit to another (upstream) Unit, propagating what each Link's UpdateType says to propagate. Expects Link:*, Link:, or Link:. Link:* selects every Link from this Unit that can resolve; a where expression selects among those, evaluated against the Links themselves (e.g. UpdateType = 'MergeUnits'), which is how to name one Link in a bulk operation, where a UUID cannot be. A Link with UpdateType None resolves nothing and is never selected. An AutoUpdate Link may be resolved by hand: it does what the queue would have done, and nothing when the Link is already level with its source. */ resolve?: string; /** @description Merge source unit. Currently it must be a unit ID or 'Self'. */ merge_source?: string; /** @description Merge base revision, which provides the base configuration data of the changes to merge. With merge_source, this is a revision of the merge source unit. With merge_external_source, this is a revision of the unit being updated and overrides the default selection of the latest MergeExternal revision. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */ merge_base?: string; /** @description Merge end revision of the merge source, which provides the final configuration of the changes to merge. Also accepted with upgrade and with resolve, where it names how far along the source to take the propagation; the default there is the source's head. Naming a ChangeSet or Tag that ends a change is what leaves a change still being made at the source behind. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */ merge_end?: string; /** @description Identifier of the external source for merge-on-update. When set, computes mutations between the last MergeExternal revision and the provided data, then patches the current unit data with those mutations. */ merge_external_source?: string; /** @description Enable the subtraction (override-preservation) step of upgrade and merge_source. By default (false), the source patch is applied without subtraction and the target's local differences are preserved by the stored Mutation Protected values; set true to additionally subtract the target's local differences from the source patch. Has no effect on a self merge (merge_source=Self), where subtraction is always disabled. */ merge_enable_subtraction?: boolean; /** * @description The specified string is an expression for the purpose of filtering * the list of Mutations returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Mutation: ChannelID, Clearance, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.FunctionName, FunctionInvocation.WhereResource, FunctionName, Guards, HiddenReason, InheritedGuards, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt. * * Selects Mutations of this Unit whose paths the merge must not overwrite, unioned with the Protected values stored on the Unit's MutationSources. * * The whole string must be query-encoded. */ where_mutation?: string; /** * @description UUID of a Filter entity to apply to the Mutation list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Mutation). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter_mutation?: string; /** @description Tag ID to add to the head revision */ tag?: string; /** @description Must match ChangeSetID of affected Units if config Data is changed unless in dry run mode */ change_set_id?: string; /** @description ChangeOrder to promote, with upgrade or resolve, or to undo, with restore. The change order fixed the range when it was created -- the interval on each source Unit, marked with its Tags -- so it supplies both ends of the merge and merge_end is refused alongside it. A Unit whose source the change order does not cover is passed over rather than failed, which is what lets a bulk upgrade name a whole Space and take only the Units the change is in. A Unit whose last merged revision is past where the change order starts is an error, since merging anyway would replay what it already has; one that is short of it is handled as prior_revisions says. With resolve a selected Link whose UpdateType the change order does not follow is an error too. The revisions the promotion creates carry the ChangeOrder, and its start Tag is placed on the revision before them and its end Tag on the one it arrives at, so 'restore Before:ChangeOrder:uuid' undoes it whether it landed as one revision or as one per source revision. With restore the change order is being undone rather than promoted: the restore must be 'Before:ChangeOrder:' the same change order, the change order must have an AbortedReason -- undoing a change nobody has said is not coming is a race with whoever is still promoting it -- and a Unit the change order never marked is an error rather than passed over, since naming it says the Unit is part of the undoing. The first restore mints the change order's restore Tag and records it as RestoreTagID; every restore after that marks with the same Tag, which is what RestoredSpaceIDs is read off. A Unit the change order carried nothing for takes the restore Tag on the revision its start and end Tags are already on, and no revision is made. A Unit already carrying the restore Tag has had the change order taken back out of it and is passed over, since undoing one in a Unit happens once as promoting it into one does -- so the revisions a Unit has taken since it was undone are its own work rather than this undoing's to drop. Restoring also advances the merge pointers of the Links of the change order's UpdateType that follow the restored Unit onto the revision the restore made, so a later upgrade does not replay the change that was just taken out; the downstream Units are not restored with it, since each has to be restored and released on its own account. */ change_order?: string; /** @description With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. All merges them as Include does. A Unit that has already merged past the change order's start is an error whatever this says. Defaults to the change order's PriorRevisions. */ prior_revisions?: string; /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */ subgroup?: string; /** @description Close a ChangeSet a ChangeWorkflow governs although the gates of the workflow's Final do not hold. Applies to a write that clears a Unit's ChangeSetID, which closes its ChangeSet. Requires force_reason, and Edit permission on the ChangeSet, whose CloseOverride records the override. */ force_close?: boolean; /** @description Why a ChangeSet's gates are overridden; required with force_close. */ force_reason?: string; /** * @description Comma-separated parts of the result to return in addition to the Unit: ConfigData for the configuration the operation produced, MutationSources for what set each value in it, and Diff for what the operation changed, path by path with the values on both sides. None is a field of a Unit, and each costs something to return, so they are returned only when named. A dry run stores nothing, so this is the only way to see what it would have produced. * * Supported values: ConfigData, MutationSources, Diff. */ include?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["Unit"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitCreateOrUpdateResponse"]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to update unit(s) due to configuration data problem */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteUnit: { parameters: { query?: { /** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */ detach?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete the unit(s) due to an inflight operation on the unit(s) */ 423: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchUnit: { parameters: { query?: { /** @description Unique identifier for a revision_id */ revision_id?: string; /** @description Dry run mode: return changed unit(s) but don't update configuration data */ dry_run?: boolean; /** * @deprecated * @description Deprecated: use guards, as {"Override":"Upstream"} or {"Override":"External"}. Records the paths this operation writes as local overrides a merge must not overwrite: each Unit's Override guard -- Override=Upstream for a Unit with an upstream Unit, Override=External for one without -- with the clearance to write over one. A guard this request names under Override wins. Has no effect with restore. */ protect?: boolean; /** @description The classes of guarded reason this operation is cleared for, as a JSON Clearance -- a list of {Key, Operator, Values} requirements, where Operator is Exists, In, NotIn, or DoesNotExist. A path whose guards this does not cover is not written, and the withheld change is reported as a Guarded conflict. An absent or empty clearance clears nothing, which only matters for a Unit that has guards. */ clearance?: string; /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */ guards?: string; /** @description The guards this operation records on the paths it writes as inherited guards, in the form guards takes: a clone of the Unit receives them, and a merge carries them, and any later change to them, to the Units downstream of it. Guards set through guards stay with the Unit they are on. A key may not be in both. The clearance has to cover these as it covers guards. */ inherited_guards?: string; /** @description Merge the range as one rebased diff and record it as one Revision, instead of walking it. By default a merge replays: it takes the source's Revisions in order and, where a Revision records function invocations that can be re-executed, runs them against this Unit rather than rebasing their recorded paths onto it -- so a change lands where this Unit's own structure puts it -- and records each source Revision that has an effect here as a Revision of its own, carrying that Revision's change description, its own conflicts, and one Mutation per source Mutation. Squashing gives up both: the range arrives as a single rebased patch in a single Revision, which is what a merge did before replay existed. Accepted with upgrade, merge_source, and resolve of an UpgradeUnit or MergeUnits Link, and refused elsewhere, since there is no range to walk. A Link can ask for it standingly with its Squash field. */ squash?: boolean; /** @description Upgrade the unit to the latest version of its upstream unit */ upgrade?: boolean; /** @description Restore revision source. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */ restore?: string; /** @description Resolve Links from this (downstream) Unit to another (upstream) Unit, propagating what each Link's UpdateType says to propagate. Expects Link:*, Link:, or Link:. Link:* selects every Link from this Unit that can resolve; a where expression selects among those, evaluated against the Links themselves (e.g. UpdateType = 'MergeUnits'), which is how to name one Link in a bulk operation, where a UUID cannot be. A Link with UpdateType None resolves nothing and is never selected. An AutoUpdate Link may be resolved by hand: it does what the queue would have done, and nothing when the Link is already level with its source. */ resolve?: string; /** @description Merge source unit. Currently it must be a unit ID or 'Self'. */ merge_source?: string; /** @description Merge base revision, which provides the base configuration data of the changes to merge. With merge_source, this is a revision of the merge source unit. With merge_external_source, this is a revision of the unit being updated and overrides the default selection of the latest MergeExternal revision. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */ merge_base?: string; /** @description Merge end revision of the merge source, which provides the final configuration of the changes to merge. Also accepted with upgrade and with resolve, where it names how far along the source to take the propagation; the default there is the source's head. Naming a ChangeSet or Tag that ends a change is what leaves a change still being made at the source behind. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */ merge_end?: string; /** @description Identifier of the external source for merge-on-update. When set, computes mutations between the last MergeExternal revision and the provided data, then patches the current unit data with those mutations. */ merge_external_source?: string; /** @description Enable the subtraction (override-preservation) step of upgrade and merge_source. By default (false), the source patch is applied without subtraction and the target's local differences are preserved by the stored Mutation Protected values; set true to additionally subtract the target's local differences from the source patch. Has no effect on a self merge (merge_source=Self), where subtraction is always disabled. */ merge_enable_subtraction?: boolean; /** * @description The specified string is an expression for the purpose of filtering * the list of Mutations returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Mutation: ChannelID, Clearance, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.FunctionName, FunctionInvocation.WhereResource, FunctionName, Guards, HiddenReason, InheritedGuards, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt. * * Selects Mutations of this Unit whose paths the merge must not overwrite, unioned with the Protected values stored on the Unit's MutationSources. * * The whole string must be query-encoded. */ where_mutation?: string; /** * @description UUID of a Filter entity to apply to the Mutation list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Mutation). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter_mutation?: string; /** @description Tag ID to add to the head revision */ tag?: string; /** @description Must match ChangeSetID of affected Units if config Data is changed unless in dry run mode */ change_set_id?: string; /** @description ChangeOrder to promote, with upgrade or resolve, or to undo, with restore. The change order fixed the range when it was created -- the interval on each source Unit, marked with its Tags -- so it supplies both ends of the merge and merge_end is refused alongside it. A Unit whose source the change order does not cover is passed over rather than failed, which is what lets a bulk upgrade name a whole Space and take only the Units the change is in. A Unit whose last merged revision is past where the change order starts is an error, since merging anyway would replay what it already has; one that is short of it is handled as prior_revisions says. With resolve a selected Link whose UpdateType the change order does not follow is an error too. The revisions the promotion creates carry the ChangeOrder, and its start Tag is placed on the revision before them and its end Tag on the one it arrives at, so 'restore Before:ChangeOrder:uuid' undoes it whether it landed as one revision or as one per source revision. With restore the change order is being undone rather than promoted: the restore must be 'Before:ChangeOrder:' the same change order, the change order must have an AbortedReason -- undoing a change nobody has said is not coming is a race with whoever is still promoting it -- and a Unit the change order never marked is an error rather than passed over, since naming it says the Unit is part of the undoing. The first restore mints the change order's restore Tag and records it as RestoreTagID; every restore after that marks with the same Tag, which is what RestoredSpaceIDs is read off. A Unit the change order carried nothing for takes the restore Tag on the revision its start and end Tags are already on, and no revision is made. A Unit already carrying the restore Tag has had the change order taken back out of it and is passed over, since undoing one in a Unit happens once as promoting it into one does -- so the revisions a Unit has taken since it was undone are its own work rather than this undoing's to drop. Restoring also advances the merge pointers of the Links of the change order's UpdateType that follow the restored Unit onto the revision the restore made, so a later upgrade does not replay the change that was just taken out; the downstream Units are not restored with it, since each has to be restored and released on its own account. */ change_order?: string; /** @description With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. All merges them as Include does. A Unit that has already merged past the change order's start is an error whatever this says. Defaults to the change order's PriorRevisions. */ prior_revisions?: string; /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */ subgroup?: string; /** @description Close a ChangeSet a ChangeWorkflow governs although the gates of the workflow's Final do not hold. Applies to a write that clears a Unit's ChangeSetID, which closes its ChangeSet. Requires force_reason, and Edit permission on the ChangeSet, whose CloseOverride records the override. */ force_close?: boolean; /** @description Why a ChangeSet's gates are overridden; required with force_close. */ force_reason?: string; /** * @description Comma-separated parts of the result to return in addition to the Unit: ConfigData for the configuration the operation produced, MutationSources for what set each value in it, and Diff for what the operation changed, path by path with the values on both sides. None is a field of a Unit, and each costs something to return, so they are returned only when named. A dry run stores nothing, so this is the only way to see what it would have produced. * * Supported values: ConfigData, MutationSources, Diff. */ include?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** * Format: uuid * @description Unique identifier for the ChangeSet to which the current Revision belongs. Optional. Units are not required to belong to ChangeSets. */ ChangeSetID?: string | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description An optional set of gates that, if any is present, will block destroy operations */ DestroyGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; /** @description LastChangeDescription is a human-readable description of the last change. This description is copied to the new Revision when the Data is changed. */ LastChangeDescription?: string | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description ToolchainType specifies the type of toolchain for this unit. Possible values include "Kubernetes/YAML", "AppConfig/Properties", "AppConfig/YAML", "AppConfig/TOML", "AppConfig/INI", "AppConfig/JSON", "AppConfig/Env", "AppConfig/Text", "ConfigHub/YAML". */ ToolchainType?: string | null; Unreleasable?: boolean | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitCreateOrUpdateResponse"]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to patch unit(s) due to configuration data problem */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetUnitBlame: { parameters: { query?: { /** @description Only the fields whose path contains this substring. */ path?: string; /** @description Only the fields of this resource, named as / or ; a substring of either matches. */ resource?: string; /** * @description Only the fields with at least one of these flags, comma-separated. Conflict,Absent,Finding,ValidationError,ValidationWarning selects the fields that need attention. * * Supported values: Protected, Guarded, Conflict, ConflictDismissed, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided. */ flags?: string; /** @description Follow each merge and Link resolve into the unit it took the value from, to where the value was set. Default true; false reports each unit's own record, which names the upstream unit without reading it. */ upstream?: boolean; /** @description How many upstream units to follow before stopping. */ upstream_depth?: number; /** @description Include the $comment$ pseudo-fields that carry YAML comments. */ include_comments?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitBlame"]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ResolveUnitConflicts: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UnitConflictsRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitConflictsResponse"]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DownloadUnitData: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/octet-stream": string; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UploadUnitData: { parameters: { query?: { /** @description Human-readable description of this change, copied to the Revision it creates. */ last_change_description?: string; /** * @description Comma-separated parts of the result to return in addition to the Unit: ConfigData for the configuration the operation produced, MutationSources for what set each value in it, and Diff for what the operation changed, path by path with the values on both sides. None is a field of a Unit, and each costs something to return, so they are returned only when named. A dry run stores nothing, so this is the only way to see what it would have produced. * * Supported values: ConfigData, MutationSources, Diff. */ include?: string; /** @description Dry run mode: return changed unit(s) but don't update configuration data */ dry_run?: boolean; /** * @deprecated * @description Deprecated: use guards, as {"Override":"Upstream"} or {"Override":"External"}. Records the paths this operation writes as local overrides a merge must not overwrite: each Unit's Override guard -- Override=Upstream for a Unit with an upstream Unit, Override=External for one without -- with the clearance to write over one. A guard this request names under Override wins. Has no effect with restore. */ protect?: boolean; /** @description The classes of guarded reason this operation is cleared for, as a JSON Clearance -- a list of {Key, Operator, Values} requirements, where Operator is Exists, In, NotIn, or DoesNotExist. A path whose guards this does not cover is not written, and the withheld change is reported as a Guarded conflict. An absent or empty clearance clears nothing, which only matters for a Unit that has guards. */ clearance?: string; /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */ guards?: string; /** @description The guards this operation records on the paths it writes as inherited guards, in the form guards takes: a clone of the Unit receives them, and a merge carries them, and any later change to them, to the Units downstream of it. Guards set through guards stay with the Unit they are on. A key may not be in both. The clearance has to cover these as it covers guards. */ inherited_guards?: string; /** @description Merge base revision, which provides the base configuration data of the changes to merge. With merge_source, this is a revision of the merge source unit. With merge_external_source, this is a revision of the unit being updated and overrides the default selection of the latest MergeExternal revision. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */ merge_base?: string; /** @description Identifier of the external source for merge-on-update. When set, computes mutations between the last MergeExternal revision and the provided data, then patches the current unit data with those mutations. */ merge_external_source?: string; /** @description Enable the subtraction (override-preservation) step of upgrade and merge_source. By default (false), the source patch is applied without subtraction and the target's local differences are preserved by the stored Mutation Protected values; set true to additionally subtract the target's local differences from the source patch. Has no effect on a self merge (merge_source=Self), where subtraction is always disabled. */ merge_enable_subtraction?: boolean; /** @description Tag ID to add to the head revision */ tag?: string; /** @description Must match ChangeSetID of affected Units if config Data is changed unless in dry run mode */ change_set_id?: string; /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */ subgroup?: string; }; header?: { /** @description The DataHash of the configuration this write replaces, as the ETag a read of the Unit's data served it (quoted) or bare. The write is refused with 409 Conflict when the Unit's configuration is not that one, so an edit made from one Unit's configuration, or before somebody else's write, cannot land over another. Omitted, the write is unconditional. */ "If-Match"?: string; }; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; }; cookie?: never; }; requestBody?: { content: { "application/octet-stream": string; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitCreateOrUpdateResponse"]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetUnitDiff: { parameters: { query?: { /** @description The Revision on the From side: a number, a Revision ID, HeadRevisionNum, LastReleasedRevisionNum, Tag:, ChangeSet:, ChangeOrder:, or Release: (the Revision the Release bundled), any of them optionally prefixed with Before:. */ from?: string; /** @description The Revision on the To side, in the same syntax as from. */ to?: string; /** * @description Comma-separated: Attribution to attach to each changed path the To side's MutationSources entry, which says what set the new value, Unchanged to also list resources with no changes, and Context to also list, within each changed resource, the unchanged paths around the changes: every unchanged child of each map or array that holds a change, up to the resource, as ChangeType None. * * Supported values: Attribution, Unchanged, Context. */ include?: string; /** @description Limit the diff to the resources this where expression selects on either side. */ where_resource?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitDiff"]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; SetUnitGuard: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UnitGuardRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitGuardResponse"]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListExtendedMutations: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Mutations returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Mutation: ChannelID, Clearance, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.FunctionName, FunctionInvocation.WhereResource, FunctionName, Guards, HiddenReason, InheritedGuards, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt. * * The function invoked is returned as a FunctionInvocation object, and `where` names its fields the same way: `FunctionInvocation.FunctionName` and `FunctionInvocation.Arguments`, which is a list addressed with dot notation. `FunctionInvocation.Arguments.?ParameterName=container-image.Value LIKE 'nginx%'` reads the argument bound to a named parameter, `FunctionInvocation.Arguments.*.Value` matches any argument's value, and `FunctionInvocation.Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName. `Guards.` reads the guards the change recorded on the paths it wrote, as in `Guards.Link = 'TransformPaths'`, and `Clearance.*.Key = 'RunAsRoot'` finds the changes written under a clearance for that reason. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Mutation list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Mutation). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Mutation include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Mutation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Mutation are InvocationID, LinkID, MergeSourceID, OrganizationID, RevisionID, SpaceID, TriggerID, UnitID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Mutation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, MutationID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Mutation entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsSpaceSpace_idUnitUnit_idMutationGetParametersQueryWhere_permission; /** * @description Hidden Mutation entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Mutation, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Mutation: its Of, or the From of its Filter, must be Mutation. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Mutation entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Mutation results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Mutation: ChannelID, CreatedAt, FunctionName, HiddenReason, InvocationID, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, Subgroup, TriggerID, UnitID, UpdatedAt. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Mutation's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Mutation entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedMutation"][]; }; }; /** @description ExtendedMutation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ExtendedMutation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ExtendedMutation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetExtendedMutation: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for Mutation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Mutation are InvocationID, LinkID, MergeSourceID, OrganizationID, RevisionID, SpaceID, TriggerID, UnitID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Mutation. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, MutationID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; /** @description Unique identifier for a mutation_id */ mutation_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedMutation"]; }; }; /** @description ExtendedMutation request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ExtendedMutation not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ExtendedMutation. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetUnitMutationSources: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MutationSourcesResponse"]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetUnitPath: { parameters: { query: { /** @description The field: its REF, a prefix of a REF of at least four characters, or its path. */ field: string; /** @description Also return every change the Unit recorded to the field. Reads the record of every Revision of the Unit. */ history?: boolean; /** @description Only the fields of this resource, named as / or ; a substring of either matches. */ resource?: string; /** @description Follow each merge and Link resolve into the unit it took the value from, to where the value was set. Default true; false reports each unit's own record, which names the upstream unit without reading it. */ upstream?: boolean; /** @description How many upstream units to follow before stopping. */ upstream_depth?: number; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitPathReport"]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; SetUnitProtection: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UnitProtectionRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitProtectionResponse"]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListExtendedResources: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Resources returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Resource: CreatedAt, Data, HiddenReason, OrganizationID, ResourceID, ResourceIndex, ResourceName, ResourceType, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt. * * Sub-paths of the JSON configuration data are addressed with dot notation, such as `Data.spec.replicas > 1`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Resource list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Resource). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Resource include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Resource. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Resource are OrganizationID, SpaceID, TargetID, UnitID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Resource. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ResourceID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Resource entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsSpaceSpace_idUnitUnit_idResourceGetParametersQueryWhere_permission; /** * @description Hidden Resource entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Resource, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Resource: its Of, or the From of its Filter, must be Resource. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Resource entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Resource results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Resource: CreatedAt, HiddenReason, OrganizationID, ResourceID, ResourceIndex, ResourceName, ResourceType, SpaceID, ToolchainType, UnitID, UpdatedAt. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Resource's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Resource entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; /** * @deprecated * @description Deprecated: use continue. Number of Resource entities to skip before returning results. Cannot be combined with continue. */ offset?: number; /** @description Return each resource's configuration in its original toolchain-native form, as RawData on the response envelope. Off by default: the bodies are bulk, and a table view needs only the queryable Data projection. */ raw_data?: boolean; /** @description The ResourceID of a NetworkPolicy, PodDisruptionBudget or Service: list only the workloads (such as Deployments, StatefulSets, DaemonSets, Jobs and CronJobs: any kind with a pod template) whose pods its selector selects, in its namespace. A resource with no namespace is in default. Selectors apply on one cluster, so the resources matched are those released to the named resource's Target, or in its Space when it has none. */ selected_by?: string; /** @description The ResourceID of a workload: list only the NetworkPolicies, PodDisruptionBudgets and Services whose selectors select its pods, in its namespace, on the same cluster as selected_by. */ selecting?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedResource"][]; }; }; /** @description ExtendedResource request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ExtendedResource not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ExtendedResource. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetExtendedResource: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for Resource. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Resource are OrganizationID, SpaceID, TargetID, UnitID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Resource. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ResourceID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** @description Return each resource's configuration in its original toolchain-native form, as RawData on the response envelope. Off by default: the bodies are bulk, and a table view needs only the queryable Data projection. */ raw_data?: boolean; /** @description The ResourceID of a NetworkPolicy, PodDisruptionBudget or Service: list only the workloads (such as Deployments, StatefulSets, DaemonSets, Jobs and CronJobs: any kind with a pod template) whose pods its selector selects, in its namespace. A resource with no namespace is in default. Selectors apply on one cluster, so the resources matched are those released to the named resource's Target, or in its Space when it has none. */ selected_by?: string; /** @description The ResourceID of a workload: list only the NetworkPolicies, PodDisruptionBudgets and Services whose selectors select its pods, in its namespace, on the same cluster as selected_by. */ selecting?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; /** @description Unique identifier for a resource_id */ resource_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedResource"]; }; }; /** @description ExtendedResource request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ExtendedResource not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ExtendedResource. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListReviewComments: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of ReviewComments returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the ReviewComment list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (ReviewComment). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for ReviewComment include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for ReviewComment. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for ReviewComment. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ReviewCommentID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return ReviewComment entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsSpaceSpace_idUnitUnit_idReview_commentGetParametersQueryWhere_permission; /** * @description Hidden ReviewComment entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each ReviewComment, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of ReviewComment: its Of, or the From of its Filter, must be ReviewComment. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of ReviewComment entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort ReviewComment results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, Text, UnitID, UpdatedAt, UserAgent, UserID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the ReviewComment's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the ReviewComment entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedReviewComment"][]; }; }; /** @description ReviewComment request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ReviewComment not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ReviewComment. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateReviewComment: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ReviewComment"]; }; }; responses: { /** @description ReviewComment is a remark made in review of a Revision of a Unit, optionally about one resource or path in it. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReviewComment"]; }; }; /** @description ReviewComment request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ReviewComment not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ReviewComment data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ReviewComment. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetReviewComment: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for ReviewComment. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for ReviewComment. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ReviewCommentID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; /** @description Unique identifier for a review_comment_id */ review_comment_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedReviewComment"]; }; }; /** @description ReviewComment request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ReviewComment not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ReviewComment. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateReviewComment: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; /** @description Unique identifier for a review_comment_id */ review_comment_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ReviewComment"]; }; }; responses: { /** @description ReviewComment is a remark made in review of a Revision of a Unit, optionally about one resource or path in it. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReviewComment"]; }; }; /** @description ReviewComment request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ReviewComment not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ReviewComment data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ReviewComment. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteReviewComment: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; /** @description Unique identifier for a review_comment_id */ review_comment_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description ReviewComment request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ReviewComment not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ReviewComment is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ReviewComment could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ReviewComment. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchReviewComment: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; /** @description Unique identifier for a review_comment_id */ review_comment_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** Format: uuid */ ChangeOrderID?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description Path to which the remark is attached; optional */ Path?: string | null; /** Format: uuid */ ReplyToID?: string | null; /** @description Resource to which the remark is attached; optional */ Resource?: Record | null; /** Format: uuid */ RevisionID?: string | null; RevisionNum?: number | null; Text?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description ReviewComment is a remark made in review of a Revision of a Unit, optionally about one resource or path in it. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReviewComment"]; }; }; /** @description ReviewComment request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ReviewComment not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ReviewComment data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ReviewComment. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListExtendedRevisions: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Revisions returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, Attestations, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, HiddenReason, LinkFindings, MutationSources, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * To list a tagged Revision use `Tags ? ''`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Revision list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Revision). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Revision include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Revision. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Revision are Attestations, ChangeOrders, ChangeSetID, OrganizationID, Releases, SpaceID, Tags, UnitID, UserID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Revision. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, RevisionID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Revision entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsSpaceSpace_idUnitUnit_idRevisionGetParametersQueryWhere_permission; /** * @description Hidden Revision entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Revision, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Revision: its Of, or the From of its Filter, must be Revision. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Revision entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Revision results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Revision: ChangeSetID, CreatedAt, DataHash, Description, HiddenReason, OrganizationID, RevisionID, RevisionNum, Source, UnitID, UpdatedAt, UserAgent, UserID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Revision's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Revision entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; /** * @deprecated * @description Deprecated: use continue. Number of Revision entities to skip before returning results. Cannot be combined with continue. */ offset?: number; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedRevision"][]; }; }; /** @description ExtendedRevision request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ExtendedRevision not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ExtendedRevision. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetExtendedRevision: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for Revision. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Revision are Attestations, ChangeOrders, ChangeSetID, OrganizationID, Releases, SpaceID, Tags, UnitID, UserID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Revision. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, RevisionID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; /** @description Unique identifier for a revision_id */ revision_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedRevision"]; }; }; /** @description ExtendedRevision request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description ExtendedRevision not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing ExtendedRevision. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DownloadRevisionData: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; /** @description Unique identifier for a revision_id */ revision_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/octet-stream": string; }; }; /** @description Revision request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Revision not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Revision. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetRevisionMutationSources: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a unit_id */ unit_id: string; /** @description Unique identifier for a revision_id */ revision_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MutationSourcesResponse"]; }; }; /** @description Revision request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Revision not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Revision. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListViews: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Views returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on View: Annotations, BackingUnitID, Columns, CreatedAt, DisplayName, FilterID, GroupBy, Hash, HiddenReason, Labels, Of, OrderBy, OrderByDirection, OrganizationID, Permissions, Slug, SpaceID, UpdatedAt, UpstreamViewID, ViewID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the View list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (View). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for View include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for View. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for View are FilterID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for View. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ViewID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return View entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsSpaceSpace_idViewGetParametersQueryWhere_permission; /** * @description Hidden View entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each View, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of View: its Of, or the From of its Filter, must be View. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of View entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort View results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering View: BackingUnitID, CreatedAt, DisplayName, FilterID, GroupBy, Hash, HiddenReason, Of, OrderBy, OrderByDirection, OrganizationID, Slug, SpaceID, UpdatedAt, UpstreamViewID, ViewID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the View's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the View entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedView"][]; }; }; /** @description View request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing View. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; CreateView: { parameters: { query?: { /** @description Give each View written a backing Unit if it has none: a ConfigHub/YAML Unit holding the View's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["View"]; }; }; responses: { /** @description Defines an entity view. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["View"]; }; }; /** @description View request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing View. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetView: { parameters: { query?: { /** * @description Include clause for expanding related entities in the response for View. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for View are FilterID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for View. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ViewID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a view_id */ view_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedView"]; }; }; /** @description View request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing View. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateView: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a view_id */ view_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["View"]; }; }; responses: { /** @description Defines an entity view. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["View"]; }; }; /** @description View request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing View. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; DeleteView: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a view_id */ view_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response for successful delete operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"]; }; }; /** @description View request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View could not be deleted. */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing View. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; PatchView: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a view_id */ view_id: string; }; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; Columns?: (Record | null)[] | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** Format: uuid */ FilterID?: string | null; GroupBy?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Of?: string | null; OrderBy?: string | null; OrderByDirection?: string | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description Defines an entity view. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["View"]; }; }; /** @description View request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing View. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetViewDocument: { parameters: { query?: never; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a view_id */ view_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityDocument"]; }; }; /** @description View request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing View. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; UpdateViewDocument: { parameters: { query?: { /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path: { /** @description Unique identifier for a space_id */ space_id: string; /** @description Unique identifier for a view_id */ view_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["EntityDocumentEdit"]; }; }; responses: { /** @description Defines an entity view. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["View"]; }; }; /** @description View request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description The View changed since the document was read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing View. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAllTags: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Tags returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrganizationID, Permissions, ReleaseID, Slug, SpaceID, TagID, UpdatedAt. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Tag list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Tag). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Tag include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Tag. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Tag are ChangeSetID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Tag. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, TagID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Tag entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsTagGetParametersQueryWhere_permission; /** * @description Hidden Tag entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Tag, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Tag: its Of, or the From of its Filter, must be Tag. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Tag entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Tag results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Tag: ChangeOrderID, ChangeSetID, CreatedAt, DisplayName, HiddenReason, OrganizationID, ReleaseID, Slug, SpaceID, TagID, UpdatedAt. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Tag's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Tag entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedTag"][]; }; }; /** @description Tag request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Tag. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkCreateTags: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Tags returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrganizationID, Permissions, ReleaseID, Slug, SpaceID, TagID, UpdatedAt. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Tag list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Tag). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Tag include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Tag entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Tag. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Tag are ChangeSetID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Tag entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Tag entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Comma-separated list of prefixes to apply to cloned Tag names */ name_prefixes?: string; /** @description Comma-separated list of labels with multiple values for cloned Tag labels, in the format of key1=value1|value2,key2=value1|value2|value3 */ variant_labels?: string; /** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */ name_pattern?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of Spaces returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, TriggerOtherUnitIDs, UpdatedAt, UpstreamSpaceID. * * Where expression to select destination spaces for cloning tags * * The whole string must be query-encoded. */ where_space?: string; /** * @description UUID of a Filter entity to apply to the Space list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Space). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter_space?: string; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["TagCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status (partial success) */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TagCreateOrUpdateResponse"][]; }; }; /** @description Tag request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Tag. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkDeleteTags: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Tags returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrganizationID, Permissions, ReleaseID, Slug, SpaceID, TagID, UpdatedAt. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Tag list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Tag). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Tag include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Tag entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Tag. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Tag are ChangeSetID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Tag entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Tag entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */ detach?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Tag request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete entity */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Tag. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkPatchTags: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Tags returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrganizationID, Permissions, ReleaseID, Slug, SpaceID, TagID, UpdatedAt. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Tag list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Tag). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Tag include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Tag entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Tag. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Tag are ChangeSetID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Tag entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Tag entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["TagCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TagCreateOrUpdateResponse"][]; }; }; /** @description Tag request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Tag. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkMoveTags: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Tags returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrganizationID, Permissions, ReleaseID, Slug, SpaceID, TagID, UpdatedAt. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Tag list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Tag). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Tag include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Tag entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Tag. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Tag are ChangeSetID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Report what the move would do, and what would stop it, without moving anything */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["MoveRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description Multi-Status: nothing was moved, or some moved and others did not */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description Tag request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Tag data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Tag. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAllTargets: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Targets returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Target: Annotations, BackingUnitID, CreatedAt, DeleteGates, DisplayName, Facts, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, TargetID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamTargetID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Target list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Target). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Target include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Target. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Target are OrganizationID, Permissions, SpaceID, TriggerFilterID, TriggerIDs. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Target. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, TargetID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Target entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View, ManageChildren, EditChildren, UseChildren, ViewChildren, CreateChildren, ApproveChildren, TargetEditChildren, TargetViewChildren. */ where_permission?: PathsTargetGetParametersQueryWhere_permission; /** * @description Hidden Target entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Target, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Target: its Of, or the From of its Filter, must be Target. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Target entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Target results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Target: BackingUnitID, CreatedAt, DisplayName, HiddenReason, OrganizationID, Slug, SpaceID, TargetID, TriggerFilterID, TriggerHash, UpdatedAt, UpstreamTargetID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Target's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Target entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedTarget"][]; }; }; /** @description Target request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Target. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkCreateTargets: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Targets returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Target: Annotations, BackingUnitID, CreatedAt, DeleteGates, DisplayName, Facts, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, TargetID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamTargetID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Target list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Target). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Target include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Target entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Target. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Target are OrganizationID, Permissions, SpaceID, TriggerFilterID, TriggerIDs. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Target entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Target entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Comma-separated list of prefixes to apply to cloned Target names */ name_prefixes?: string; /** @description Comma-separated list of labels with multiple values for cloned Target labels, in the format of key1=value1|value2,key2=value1|value2|value3 */ variant_labels?: string; /** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */ name_pattern?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of Spaces returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, TriggerOtherUnitIDs, UpdatedAt, UpstreamSpaceID. * * Where expression to select destination spaces for cloning targets * * The whole string must be query-encoded. */ where_space?: string; /** * @description UUID of a Filter entity to apply to the Space list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Space). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter_space?: string; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description Give each Target written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Target's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Create Targets from the ConfigHub/YAML Units where_unit and filter_unit select, each in its Unit's Space, and each with its Unit as its backing Unit. The request body is applied after the Unit's document. Units of other toolchains or describing other entity types are passed over; outstanding ValidationErrors on a Unit are an error. Takes none of the parameters that select entities to clone, name the clones or choose their Spaces. */ from_backing_units?: boolean; /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * The Units to create entities from, with from_backing_units. * * The whole string must be query-encoded. */ where_unit?: string; /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */ filter_unit?: string; /** @description With from_backing_units, patch a Target a selected Unit already backs with what the Unit holds that it has not taken yet, as a bulk patch with from_backing_units does, rather than report that the Unit backs it. The request body is applied after it. Without it, such a Unit is an error, or with allow_exists the Target is returned as it is. */ patch_existing?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; Facts?: { [key: string]: string | null; } | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** Format: uuid */ TriggerFilterID?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; WhereTrigger?: string | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["TargetCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status (partial success) */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TargetCreateOrUpdateResponse"][]; }; }; /** @description Target request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Target. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkDeleteTargets: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Targets returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Target: Annotations, BackingUnitID, CreatedAt, DeleteGates, DisplayName, Facts, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, TargetID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamTargetID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Target list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Target). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Target include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Target entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Target. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Target are OrganizationID, Permissions, SpaceID, TriggerFilterID, TriggerIDs. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Target entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Target entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */ detach?: boolean; /** @description Prune: of the Targets selected, delete those whose backing Unit is empty, which says the Target should not exist, and keep the Unit, empty and backing nothing, so that it keeps the Target's history and a document that comes back revives it. The others are left alone and are not in the response, so a broad selection deletes only what was emptied. */ from_backing_units?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Target request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete entity */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Target. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkPatchTargets: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Targets returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Target: Annotations, BackingUnitID, CreatedAt, DeleteGates, DisplayName, Facts, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, TargetID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamTargetID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Target list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Target). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Target include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Target entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Target. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Target are OrganizationID, Permissions, SpaceID, TriggerFilterID, TriggerIDs. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Target entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Target entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Re-list the Triggers matching WhereTrigger and/or TriggerFilterID even if these fields have not changed */ refresh_triggers?: boolean; /** @description Give each Target written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Target's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Patch each selected Target with what its backing Unit holds that it has not taken yet: the change to the Unit since its LastReleasedRevisionNum. The request body is applied after it. Selecting one with no backing Unit is an error, and so are outstanding ValidationErrors on a backing Unit. */ from_backing_units?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; Facts?: { [key: string]: string | null; } | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** Format: uuid */ TriggerFilterID?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; WhereTrigger?: string | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["TargetCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TargetCreateOrUpdateResponse"][]; }; }; /** @description Target request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Target. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkMoveTargets: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Targets returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Target: Annotations, BackingUnitID, CreatedAt, DeleteGates, DisplayName, Facts, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, TargetID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamTargetID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Target list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Target). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Target include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Target entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Target. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Target are OrganizationID, Permissions, SpaceID, TriggerFilterID, TriggerIDs. * * The whole string must be query-encoded. */ include?: string; /** @description Report what the move would do, and what would stop it, without moving anything */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["MoveRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description Multi-Status: nothing was moved, or some moved and others did not */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description Target request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Target data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Target. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAllTriggers: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Triggers returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, OtherUnitSelections, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit. * * A Trigger returns the function it invokes inline rather than in a FunctionInvocation object, so `where` names FunctionName and Arguments directly. The arguments are addressed with dot notation into `Arguments`, which is a list: `Arguments.?ParameterName=attribute-name.Value = 'owner'` reads the argument bound to a named parameter, `Arguments.*.Value` matches any argument's value, and `Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Trigger list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Trigger). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Trigger include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Trigger. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Trigger are ChannelID, InvocationID, OrganizationID, Permissions, SpaceID, UnitFilterID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Trigger. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, TriggerID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Trigger entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsTriggerGetParametersQueryWhere_permission; /** * @description Hidden Trigger entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Trigger, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Trigger: its Of, or the From of its Filter, must be Trigger. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Trigger entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Trigger results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Trigger: BackingUnitID, ChannelID, CreatedAt, Description, Disabled, DisplayName, Event, FunctionName, Hash, HiddenReason, InvocationID, OrganizationID, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Trigger's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Trigger entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedTrigger"][]; }; }; /** @description Trigger request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Trigger. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkCreateTriggers: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Triggers returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, OtherUnitSelections, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit. * * A Trigger returns the function it invokes inline rather than in a FunctionInvocation object, so `where` names FunctionName and Arguments directly. The arguments are addressed with dot notation into `Arguments`, which is a list: `Arguments.?ParameterName=attribute-name.Value = 'owner'` reads the argument bound to a named parameter, `Arguments.*.Value` matches any argument's value, and `Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Trigger list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Trigger). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Trigger include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Trigger entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Trigger. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Trigger are ChannelID, InvocationID, OrganizationID, Permissions, SpaceID, UnitFilterID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Trigger entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Trigger entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Comma-separated list of prefixes to apply to cloned Trigger names */ name_prefixes?: string; /** @description Comma-separated list of labels with multiple values for cloned Trigger labels, in the format of key1=value1|value2,key2=value1|value2|value3 */ variant_labels?: string; /** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */ name_pattern?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of Spaces returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, TriggerOtherUnitIDs, UpdatedAt, UpstreamSpaceID. * * Where expression to select destination spaces for cloning triggers * * The whole string must be query-encoded. */ where_space?: string; /** * @description UUID of a Filter entity to apply to the Space list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Space). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter_space?: string; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description Give each Trigger written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Trigger's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Create Triggers from the ConfigHub/YAML Units where_unit and filter_unit select, each in its Unit's Space, and each with its Unit as its backing Unit. The request body is applied after the Unit's document. Units of other toolchains or describing other entity types are passed over; outstanding ValidationErrors on a Unit are an error. Takes none of the parameters that select entities to clone, name the clones or choose their Spaces. */ from_backing_units?: boolean; /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * The Units to create entities from, with from_backing_units. * * The whole string must be query-encoded. */ where_unit?: string; /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */ filter_unit?: string; /** @description With from_backing_units, patch a Trigger a selected Unit already backs with what the Unit holds that it has not taken yet, as a bulk patch with from_backing_units does, rather than report that the Unit backs it. The request body is applied after it. Without it, such a Unit is an error, or with allow_exists the Trigger is returned as it is. */ patch_existing?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description Function arguments */ Arguments?: (Record | null)[] | null; /** Format: uuid */ ChannelID?: string | null; Clearance?: (Record | null)[] | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; Description?: string | null; Disabled?: boolean | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; Event?: string | null; /** @description Function name */ FunctionName?: string | null; Guards?: { [key: string]: string | null; } | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** Format: uuid */ InvocationID?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; OtherUnitIDs?: { [key: string]: string | null; } | null; OtherUnitSelections?: { [key: string]: Record | null; } | null; Permissions?: { [key: string]: Record | null; } | null; Protect?: boolean | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; ToolchainType?: string | null; /** Format: uuid */ UnitFilterID?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; Warn?: boolean | null; /** @description Per-invocation resource filter. AND-combined with the request-level WhereResource. Same path syntax as the request-level field (see ParseAndValidateWhereResource). */ WhereResource?: string | null; WhereUnit?: string | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["TriggerCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status (partial success) */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TriggerCreateOrUpdateResponse"][]; }; }; /** @description Trigger request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Trigger. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkDeleteTriggers: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Triggers returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, OtherUnitSelections, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit. * * A Trigger returns the function it invokes inline rather than in a FunctionInvocation object, so `where` names FunctionName and Arguments directly. The arguments are addressed with dot notation into `Arguments`, which is a list: `Arguments.?ParameterName=attribute-name.Value = 'owner'` reads the argument bound to a named parameter, `Arguments.*.Value` matches any argument's value, and `Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Trigger list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Trigger). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Trigger include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Trigger entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Trigger. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Trigger are ChannelID, InvocationID, OrganizationID, Permissions, SpaceID, UnitFilterID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Trigger entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Trigger entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Prune: of the Triggers selected, delete those whose backing Unit is empty, which says the Trigger should not exist, and keep the Unit, empty and backing nothing, so that it keeps the Trigger's history and a document that comes back revives it. The others are left alone and are not in the response, so a broad selection deletes only what was emptied. */ from_backing_units?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Trigger request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete entity */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Trigger. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkPatchTriggers: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Triggers returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, OtherUnitSelections, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit. * * A Trigger returns the function it invokes inline rather than in a FunctionInvocation object, so `where` names FunctionName and Arguments directly. The arguments are addressed with dot notation into `Arguments`, which is a list: `Arguments.?ParameterName=attribute-name.Value = 'owner'` reads the argument bound to a named parameter, `Arguments.*.Value` matches any argument's value, and `Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Trigger list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Trigger). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Trigger include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Trigger entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Trigger. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Trigger are ChannelID, InvocationID, OrganizationID, Permissions, SpaceID, UnitFilterID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Trigger entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Trigger entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Give each Trigger written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Trigger's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Patch each selected Trigger with what its backing Unit holds that it has not taken yet: the change to the Unit since its LastReleasedRevisionNum. The request body is applied after it. Selecting one with no backing Unit is an error, and so are outstanding ValidationErrors on a backing Unit. */ from_backing_units?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** @description Function arguments */ Arguments?: (Record | null)[] | null; /** Format: uuid */ ChannelID?: string | null; Clearance?: (Record | null)[] | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; Description?: string | null; Disabled?: boolean | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; Event?: string | null; /** @description Function name */ FunctionName?: string | null; Guards?: { [key: string]: string | null; } | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** Format: uuid */ InvocationID?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; OtherUnitIDs?: { [key: string]: string | null; } | null; OtherUnitSelections?: { [key: string]: Record | null; } | null; Permissions?: { [key: string]: Record | null; } | null; Protect?: boolean | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; ToolchainType?: string | null; /** Format: uuid */ UnitFilterID?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; Warn?: boolean | null; /** @description Per-invocation resource filter. AND-combined with the request-level WhereResource. Same path syntax as the request-level field (see ParseAndValidateWhereResource). */ WhereResource?: string | null; WhereUnit?: string | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["TriggerCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TriggerCreateOrUpdateResponse"][]; }; }; /** @description Trigger request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Trigger. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkMoveTriggers: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Triggers returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, OtherUnitSelections, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Trigger list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Trigger). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Trigger include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Trigger entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Trigger. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Trigger are ChannelID, InvocationID, OrganizationID, Permissions, SpaceID, UnitFilterID. * * The whole string must be query-encoded. */ include?: string; /** @description Report what the move would do, and what would stop it, without moving anything */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["MoveRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description Multi-Status: nothing was moved, or some moved and others did not */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description Trigger request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Trigger data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Trigger. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAllUnits: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Unit list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Unit). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Unit include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Unit. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Unit. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, UnitID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Unit entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View, Approve, TargetEdit, TargetView. */ where_permission?: PathsUnitGetParametersQueryWhere_permission; /** * @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each Unit, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of Unit: its Of, or the From of its Filter, must be Unit. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of Unit entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Unit results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Unit: ChangeSetID, CreatedAt, DataHash, DisplayName, HeadRevisionID, HeadRevisionNum, HiddenReason, LastChangeDescription, LastReleasedRevisionNum, OrganizationID, Slug, SpaceID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamUnitID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Unit's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Unit entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; /** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */ resource_type?: string; /** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|` splits the path: the left side selects, and the right side is a property of what was selected. On the right side of a `.|`, and only there, `!=` is true when the property is absent: `spec.containers.*.|image != 'nginx'` selects the containers and asks that none of their images be nginx, which a container with no image satisfies. Everywhere else a path that is not present is not a match, `!=` included. String literals are quoted with single quotes, such as `'string'`. Integer and boolean literals are also supported for attributes of those types. The whole string must be query-encoded. */ where_data?: string; /** @description Which engine answers where_data and resource_type: `sql` (the default) evaluates the expression against the stored resource projection in a single query, falling back to the function engine for the expressions it cannot translate; `function` invokes the where-filter function on each candidate Unit, reading every one's configuration; `shadow` runs both, answers with `function`, and logs any disagreement. Temporary: `function` is the escape hatch for one release, after which this parameter goes away. */ where_data_engine?: string; /** @description Where expression to match Triggers. Matched triggers are invoked on each unit to filter by validation results. Use with triggers_passed to control whether passing or failing units are returned (default: failing). */ where_trigger?: string; /** @description Filter UUID (with From=Trigger). The filter's matching triggers are invoked on units to filter by validation results. Can be combined with where_trigger. */ trigger_filter?: string; /** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */ triggers_passed?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedUnit"][]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkCreateUnits: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Unit list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Unit). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Unit include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Unit. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID. * * A write also accepts the parts of its result: ConfigData for the configuration the operation produced, MutationSources for what set each value in it, and Diff for what the operation changed, path by path with the values on both sides. None is a field of a Unit, and each costs something to return, so they are returned only when named. A dry run stores nothing, so this is the only way to see what it would have produced. * * Supported values: ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID, ConfigData, MutationSources, Diff. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Unit entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Unit entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Comma-separated list of prefixes to apply to cloned Unit names */ name_prefixes?: string; /** @description Comma-separated list of labels with multiple values for cloned Unit labels, in the format of key1=value1|value2,key2=value1|value2|value3 */ variant_labels?: string; /** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */ name_pattern?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of Spaces returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, TriggerOtherUnitIDs, UpdatedAt, UpstreamSpaceID. * * Where expression to select destination spaces for cloning units * * The whole string must be query-encoded. */ where_space?: string; /** * @description UUID of a Filter entity to apply to the Space list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Space). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter_space?: string; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of Links returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, ManualBindings, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID. * * Where expression to filter outgoing links (links to units outside the cloned set) for copying. If non-empty, matching outgoing links are also copied with FromUnitID retargeted to the cloned unit. * * The whole string must be query-encoded. */ include_outgoing_links_where?: string; /** @description Revision of the upstream Unit to copy. The default is its head, which is what a clone has always taken. Takes the same forms as merge_end and restore -- a revision number, a named revision, 'Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Before:...' -- resolved against the Unit being cloned from, so a bulk clone lands on a different revision of each source Unit. 'Before:ChangeOrder:uuid' is what a promotion uses: it names the state the change starts from, which for a Unit no target has taken yet is its first revision, so the upgrade that follows replays the change into the clone rather than the clone arriving with the change already folded in. Requires upstream_unit_id (or, in bulk, a source Unit to clone). */ upstream_revision?: string; /** @description Also create a MergeUnits Link from each upstream Unit back to its clone, alongside the UpgradeUnit Link a clone always gets. The upgrade Link carries changes from the upstream Unit into the clone; this one carries them the other way, which is what makes a clone usable as a draft: change it, review it, then resolve the Link (resolve=Link:...) on the upstream Unit to merge the change home. A Unit may be the source of several of these -- one per outstanding draft -- so each is named for the clone it takes changes from (syncback--) rather than for the Unit they all point at. The Link is created in the upstream Unit's Space, which the caller must be allowed to create Links in. Requires upstream_unit_id (or, in bulk, a source Unit to clone). */ syncback?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** * Format: uuid * @description Unique identifier for the ChangeSet to which the current Revision belongs. Optional. Units are not required to belong to ChangeSets. */ ChangeSetID?: string | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description An optional set of gates that, if any is present, will block destroy operations */ DestroyGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; /** @description LastChangeDescription is a human-readable description of the last change. This description is copied to the new Revision when the Data is changed. */ LastChangeDescription?: string | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description ToolchainType specifies the type of toolchain for this unit. Possible values include "Kubernetes/YAML", "AppConfig/Properties", "AppConfig/YAML", "AppConfig/TOML", "AppConfig/INI", "AppConfig/JSON", "AppConfig/Env", "AppConfig/Text", "ConfigHub/YAML". */ ToolchainType?: string | null; Unreleasable?: boolean | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status (partial success) */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitCreateOrUpdateResponse"][]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to create unit(s) due to configuration data problem */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkDeleteUnits: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Unit list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Unit). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Unit include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Unit. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Unit entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Unit entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */ detach?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete entity */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete entities due to a inflight operation using one or more of the entities */ 423: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkPatchUnits: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Unit list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Unit). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Unit include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Unit. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID. * * A write also accepts the parts of its result: ConfigData for the configuration the operation produced, MutationSources for what set each value in it, and Diff for what the operation changed, path by path with the values on both sides. None is a field of a Unit, and each costs something to return, so they are returned only when named. A dry run stores nothing, so this is the only way to see what it would have produced. * * Supported values: ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID, ConfigData, MutationSources, Diff. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of Unit entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Unit entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Dry run mode: return changed unit(s) but don't update configuration data */ dry_run?: boolean; /** * @deprecated * @description Deprecated: use guards, as {"Override":"Upstream"} or {"Override":"External"}. Records the paths this operation writes as local overrides a merge must not overwrite: each Unit's Override guard -- Override=Upstream for a Unit with an upstream Unit, Override=External for one without -- with the clearance to write over one. A guard this request names under Override wins. Has no effect with restore. */ protect?: boolean; /** @description The classes of guarded reason this operation is cleared for, as a JSON Clearance -- a list of {Key, Operator, Values} requirements, where Operator is Exists, In, NotIn, or DoesNotExist. A path whose guards this does not cover is not written, and the withheld change is reported as a Guarded conflict. An absent or empty clearance clears nothing, which only matters for a Unit that has guards. */ clearance?: string; /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */ guards?: string; /** @description The guards this operation records on the paths it writes as inherited guards, in the form guards takes: a clone of the Unit receives them, and a merge carries them, and any later change to them, to the Units downstream of it. Guards set through guards stay with the Unit they are on. A key may not be in both. The clearance has to cover these as it covers guards. */ inherited_guards?: string; /** @description Merge the range as one rebased diff and record it as one Revision, instead of walking it. By default a merge replays: it takes the source's Revisions in order and, where a Revision records function invocations that can be re-executed, runs them against this Unit rather than rebasing their recorded paths onto it -- so a change lands where this Unit's own structure puts it -- and records each source Revision that has an effect here as a Revision of its own, carrying that Revision's change description, its own conflicts, and one Mutation per source Mutation. Squashing gives up both: the range arrives as a single rebased patch in a single Revision, which is what a merge did before replay existed. Accepted with upgrade, merge_source, and resolve of an UpgradeUnit or MergeUnits Link, and refused elsewhere, since there is no range to walk. A Link can ask for it standingly with its Squash field. */ squash?: boolean; /** @description Upgrade the unit to the latest version of its upstream unit */ upgrade?: boolean; /** @description Restore revision source. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */ restore?: string; /** @description Resolve Links from this (downstream) Unit to another (upstream) Unit, propagating what each Link's UpdateType says to propagate. Expects Link:*, Link:, or Link:. Link:* selects every Link from this Unit that can resolve; a where expression selects among those, evaluated against the Links themselves (e.g. UpdateType = 'MergeUnits'), which is how to name one Link in a bulk operation, where a UUID cannot be. A Link with UpdateType None resolves nothing and is never selected. An AutoUpdate Link may be resolved by hand: it does what the queue would have done, and nothing when the Link is already level with its source. */ resolve?: string; /** @description Merge source unit. Currently it must be a unit ID or 'Self'. */ merge_source?: string; /** @description Merge base revision, which provides the base configuration data of the changes to merge. With merge_source, this is a revision of the merge source unit. With merge_external_source, this is a revision of the unit being updated and overrides the default selection of the latest MergeExternal revision. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */ merge_base?: string; /** @description Merge end revision of the merge source, which provides the final configuration of the changes to merge. Also accepted with upgrade and with resolve, where it names how far along the source to take the propagation; the default there is the source's head. Naming a ChangeSet or Tag that ends a change is what leaves a change still being made at the source behind. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */ merge_end?: string; /** @description Identifier of the external source for merge-on-update. When set, computes mutations between the last MergeExternal revision and the provided data, then patches the current unit data with those mutations. */ merge_external_source?: string; /** @description Enable the subtraction (override-preservation) step of upgrade and merge_source. By default (false), the source patch is applied without subtraction and the target's local differences are preserved by the stored Mutation Protected values; set true to additionally subtract the target's local differences from the source patch. Has no effect on a self merge (merge_source=Self), where subtraction is always disabled. */ merge_enable_subtraction?: boolean; /** * @description The specified string is an expression for the purpose of filtering * the list of Mutations returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Mutation: ChannelID, Clearance, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.FunctionName, FunctionInvocation.WhereResource, FunctionName, Guards, HiddenReason, InheritedGuards, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt. * * Selects Mutations of this Unit whose paths the merge must not overwrite, unioned with the Protected values stored on the Unit's MutationSources. * * The whole string must be query-encoded. */ where_mutation?: string; /** * @description UUID of a Filter entity to apply to the Mutation list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Mutation). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter_mutation?: string; /** @description Tag ID to add to the head revision */ tag?: string; /** @description Must match ChangeSetID of affected Units if config Data is changed unless in dry run mode */ change_set_id?: string; /** @description ChangeOrder to promote, with upgrade or resolve, or to undo, with restore. The change order fixed the range when it was created -- the interval on each source Unit, marked with its Tags -- so it supplies both ends of the merge and merge_end is refused alongside it. A Unit whose source the change order does not cover is passed over rather than failed, which is what lets a bulk upgrade name a whole Space and take only the Units the change is in. A Unit whose last merged revision is past where the change order starts is an error, since merging anyway would replay what it already has; one that is short of it is handled as prior_revisions says. With resolve a selected Link whose UpdateType the change order does not follow is an error too. The revisions the promotion creates carry the ChangeOrder, and its start Tag is placed on the revision before them and its end Tag on the one it arrives at, so 'restore Before:ChangeOrder:uuid' undoes it whether it landed as one revision or as one per source revision. With restore the change order is being undone rather than promoted: the restore must be 'Before:ChangeOrder:' the same change order, the change order must have an AbortedReason -- undoing a change nobody has said is not coming is a race with whoever is still promoting it -- and a Unit the change order never marked is an error rather than passed over, since naming it says the Unit is part of the undoing. The first restore mints the change order's restore Tag and records it as RestoreTagID; every restore after that marks with the same Tag, which is what RestoredSpaceIDs is read off. A Unit the change order carried nothing for takes the restore Tag on the revision its start and end Tags are already on, and no revision is made. A Unit already carrying the restore Tag has had the change order taken back out of it and is passed over, since undoing one in a Unit happens once as promoting it into one does -- so the revisions a Unit has taken since it was undone are its own work rather than this undoing's to drop. Restoring also advances the merge pointers of the Links of the change order's UpdateType that follow the restored Unit onto the revision the restore made, so a later upgrade does not replay the change that was just taken out; the downstream Units are not restored with it, since each has to be restored and released on its own account. */ change_order?: string; /** @description With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. All merges them as Include does. A Unit that has already merged past the change order's start is an error whatever this says. Defaults to the change order's PriorRevisions. */ prior_revisions?: string; /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */ subgroup?: string; /** @description Close a ChangeSet a ChangeWorkflow governs although the gates of the workflow's Final do not hold. Applies to a write that clears a Unit's ChangeSetID, which closes its ChangeSet. Requires force_reason, and Edit permission on the ChangeSet, whose CloseOverride records the override. */ force_close?: boolean; /** @description Why a ChangeSet's gates are overridden; required with force_close. */ force_reason?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; /** * Format: uuid * @description Unique identifier for the ChangeSet to which the current Revision belongs. Optional. Units are not required to belong to ChangeSets. */ ChangeSetID?: string | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description An optional set of gates that, if any is present, will block destroy operations */ DestroyGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; /** @description LastChangeDescription is a human-readable description of the last change. This description is copied to the new Revision when the Data is changed. */ LastChangeDescription?: string | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description ToolchainType specifies the type of toolchain for this unit. Possible values include "Kubernetes/YAML", "AppConfig/Properties", "AppConfig/YAML", "AppConfig/TOML", "AppConfig/INI", "AppConfig/JSON", "AppConfig/Env", "AppConfig/Text", "ConfigHub/YAML". */ ToolchainType?: string | null; Unreleasable?: boolean | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitCreateOrUpdateResponse"][]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to patch unit(s) due to configuration data problem */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkMoveUnits: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Unit list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Unit). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Unit include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Unit. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID. * * The whole string must be query-encoded. */ include?: string; /** @description Report what the move would do, and what would stop it, without moving anything */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UnitMoveRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitMoveResponse"][]; }; }; /** @description Multi-Status: nothing was moved, or some Units moved and others did not */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitMoveResponse"][]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkTagUnits: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Unit list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Unit). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Unit include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for Unit. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID. * * The whole string must be query-encoded. */ include?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UnitTagRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitTagResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitTagResponse"][]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Moving a change order's release tag to a Revision a release of the change could not deliver: before its end tag or the last released Revision, with validation errors, or in a Space where a release has been published at it */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; SearchUnitBlame: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Unit list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Unit). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Unit include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Only return Unit entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View, Approve, TargetEdit, TargetView. */ where_permission?: PathsUnit_blameGetParametersQueryWhere_permission; /** * @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */ view?: string; /** @description Maximum number of Units to return the blame of; 50 when not given, and larger values are rejected with 400. When there may be more, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Unit results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Unit: ChangeSetID, CreatedAt, DataHash, DisplayName, HeadRevisionID, HeadRevisionNum, HiddenReason, LastChangeDescription, LastReleasedRevisionNum, OrganizationID, Slug, SpaceID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamUnitID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Unit's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Unit entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; /** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */ resource_type?: string; /** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|` splits the path: the left side selects, and the right side is a property of what was selected. On the right side of a `.|`, and only there, `!=` is true when the property is absent: `spec.containers.*.|image != 'nginx'` selects the containers and asks that none of their images be nginx, which a container with no image satisfies. Everywhere else a path that is not present is not a match, `!=` included. String literals are quoted with single quotes, such as `'string'`. Integer and boolean literals are also supported for attributes of those types. The whole string must be query-encoded. */ where_data?: string; /** @description Which engine answers where_data and resource_type: `sql` (the default) evaluates the expression against the stored resource projection in a single query, falling back to the function engine for the expressions it cannot translate; `function` invokes the where-filter function on each candidate Unit, reading every one's configuration; `shadow` runs both, answers with `function`, and logs any disagreement. Temporary: `function` is the escape hatch for one release, after which this parameter goes away. */ where_data_engine?: string; /** @description Where expression to match Triggers. Matched triggers are invoked on each unit to filter by validation results. Use with triggers_passed to control whether passing or failing units are returned (default: failing). */ where_trigger?: string; /** @description Filter UUID (with From=Trigger). The filter's matching triggers are invoked on units to filter by validation results. Can be combined with where_trigger. */ trigger_filter?: string; /** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */ triggers_passed?: boolean; /** @description Only the fields whose path contains this substring. */ path?: string; /** @description Only the fields of this resource, named as / or ; a substring of either matches. */ resource?: string; /** * @description Only the fields with at least one of these flags, comma-separated. Conflict,Absent,Finding,ValidationError,ValidationWarning selects the fields that need attention. * * Supported values: Protected, Guarded, Conflict, ConflictDismissed, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided. */ flags?: string; /** @description Follow each merge and Link resolve into the unit it took the value from, to where the value was set. Default true; false reports each unit's own record, which names the upstream unit without reading it. */ upstream?: boolean; /** @description How many upstream units to follow before stopping. */ upstream_depth?: number; /** @description Include the $comment$ pseudo-fields that carry YAML comments. */ include_comments?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitBlame"][]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; SearchUnitData: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Unit list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Unit). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Unit include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Unit. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Unit. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, UnitID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Unit entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View, Approve, TargetEdit, TargetView. */ where_permission?: PathsUnit_dataGetParametersQueryWhere_permission; /** * @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */ view?: string; /** @description Maximum number of Unit entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Unit results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Unit: ChangeSetID, CreatedAt, DataHash, DisplayName, HeadRevisionID, HeadRevisionNum, HiddenReason, LastChangeDescription, LastReleasedRevisionNum, OrganizationID, Slug, SpaceID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamUnitID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Unit's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Unit entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; /** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */ resource_type?: string; /** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|` splits the path: the left side selects, and the right side is a property of what was selected. On the right side of a `.|`, and only there, `!=` is true when the property is absent: `spec.containers.*.|image != 'nginx'` selects the containers and asks that none of their images be nginx, which a container with no image satisfies. Everywhere else a path that is not present is not a match, `!=` included. String literals are quoted with single quotes, such as `'string'`. Integer and boolean literals are also supported for attributes of those types. The whole string must be query-encoded. */ where_data?: string; /** @description Which engine answers where_data and resource_type: `sql` (the default) evaluates the expression against the stored resource projection in a single query, falling back to the function engine for the expressions it cannot translate; `function` invokes the where-filter function on each candidate Unit, reading every one's configuration; `shadow` runs both, answers with `function`, and logs any disagreement. Temporary: `function` is the escape hatch for one release, after which this parameter goes away. */ where_data_engine?: string; /** @description Where expression to match Triggers. Matched triggers are invoked on each unit to filter by validation results. Use with triggers_passed to control whether passing or failing units are returned (default: failing). */ where_trigger?: string; /** @description Filter UUID (with From=Trigger). The filter's matching triggers are invoked on units to filter by validation results. Can be combined with where_trigger. */ trigger_filter?: string; /** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */ triggers_passed?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitData"][]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; SearchUnitDiff: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Unit list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Unit). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Unit include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Only return Unit entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View, Approve, TargetEdit, TargetView. */ where_permission?: PathsUnit_diffGetParametersQueryWhere_permission; /** * @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */ view?: string; /** @description Maximum number of Unit entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Unit results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Unit: ChangeSetID, CreatedAt, DataHash, DisplayName, HeadRevisionID, HeadRevisionNum, HiddenReason, LastChangeDescription, LastReleasedRevisionNum, OrganizationID, Slug, SpaceID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamUnitID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Unit's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Unit entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; /** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */ resource_type?: string; /** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|` splits the path: the left side selects, and the right side is a property of what was selected. On the right side of a `.|`, and only there, `!=` is true when the property is absent: `spec.containers.*.|image != 'nginx'` selects the containers and asks that none of their images be nginx, which a container with no image satisfies. Everywhere else a path that is not present is not a match, `!=` included. String literals are quoted with single quotes, such as `'string'`. Integer and boolean literals are also supported for attributes of those types. The whole string must be query-encoded. */ where_data?: string; /** @description Which engine answers where_data and resource_type: `sql` (the default) evaluates the expression against the stored resource projection in a single query, falling back to the function engine for the expressions it cannot translate; `function` invokes the where-filter function on each candidate Unit, reading every one's configuration; `shadow` runs both, answers with `function`, and logs any disagreement. Temporary: `function` is the escape hatch for one release, after which this parameter goes away. */ where_data_engine?: string; /** @description Where expression to match Triggers. Matched triggers are invoked on each unit to filter by validation results. Use with triggers_passed to control whether passing or failing units are returned (default: failing). */ where_trigger?: string; /** @description Filter UUID (with From=Trigger). The filter's matching triggers are invoked on units to filter by validation results. Can be combined with where_trigger. */ trigger_filter?: string; /** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */ triggers_passed?: boolean; /** @description The Revision on the From side: a number, a Revision ID, HeadRevisionNum, LastReleasedRevisionNum, Tag:, ChangeSet:, ChangeOrder:, or Release: (the Revision the Release bundled), any of them optionally prefixed with Before:. */ from?: string; /** @description The Revision on the To side, in the same syntax as from. */ to?: string; /** * @description Comma-separated: Attribution to attach to each changed path the To side's MutationSources entry, which says what set the new value, Unchanged to also list resources with no changes, and Context to also list, within each changed resource, the unchanged paths around the changes: every unchanged child of each map or array that holds a change, up to the resource, as ChangeType None. * * Supported values: Attribution, Unchanged, Context. */ include?: string; /** @description Limit the diff to the resources this where expression selects on either side. */ where_resource?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitDiff"][]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; SearchUnitMutationSources: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the Unit list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Unit). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for Unit include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for Unit. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for Unit. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, UnitID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return Unit entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View, Approve, TargetEdit, TargetView. */ where_permission?: PathsUnit_mutation_sourcesGetParametersQueryWhere_permission; /** * @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */ view?: string; /** @description Maximum number of Unit entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort Unit results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering Unit: ChangeSetID, CreatedAt, DataHash, DisplayName, HeadRevisionID, HeadRevisionNum, HiddenReason, LastChangeDescription, LastReleasedRevisionNum, OrganizationID, Slug, SpaceID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamUnitID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the Unit's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the Unit entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; /** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */ resource_type?: string; /** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|` splits the path: the left side selects, and the right side is a property of what was selected. On the right side of a `.|`, and only there, `!=` is true when the property is absent: `spec.containers.*.|image != 'nginx'` selects the containers and asks that none of their images be nginx, which a container with no image satisfies. Everywhere else a path that is not present is not a match, `!=` included. String literals are quoted with single quotes, such as `'string'`. Integer and boolean literals are also supported for attributes of those types. The whole string must be query-encoded. */ where_data?: string; /** @description Which engine answers where_data and resource_type: `sql` (the default) evaluates the expression against the stored resource projection in a single query, falling back to the function engine for the expressions it cannot translate; `function` invokes the where-filter function on each candidate Unit, reading every one's configuration; `shadow` runs both, answers with `function`, and logs any disagreement. Temporary: `function` is the escape hatch for one release, after which this parameter goes away. */ where_data_engine?: string; /** @description Where expression to match Triggers. Matched triggers are invoked on each unit to filter by validation results. Use with triggers_passed to control whether passing or failing units are returned (default: failing). */ where_trigger?: string; /** @description Filter UUID (with From=Trigger). The filter's matching triggers are invoked on units to filter by validation results. Can be combined with where_trigger. */ trigger_filter?: string; /** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */ triggers_passed?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitMutationSources"][]; }; }; /** @description Unit request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unit not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Unit. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; Upload: { parameters: { query?: { /** * @deprecated * @description Deprecated: use DryRun in the request body. Plan the upload and return the same response without writing anything. Either one asks for a dry run. */ dry_run?: boolean; /** * @description Comma-separated parts of the result to return in addition to the actions: Mutations for what each Unit write changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides. They cost something to return, and on a dry run either one runs the merges a plan otherwise skips, so they are returned only when named. Context, with Diff, adds to each Diff the unchanged paths around the changes: every unchanged child of each map or array that holds a change, up to the resource, as ChangeType None. * * Supported values: Mutations, Diff, Context. */ include?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["UploadRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UploadResult"]; }; }; /** @description Multi-Status: some Unit or Link writes failed, each carrying its own error */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UploadResult"]; }; }; /** @description Upload request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Upload not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Upload data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description The bundle could not be pulled from Source.Ref */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing Upload. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Pulling the bundle from Source.Ref took too long */ 504: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListUsers: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Users returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on User: CreatedAt, DisplayName, ExternalID, GroupIDs, HiddenReason, Slug, UpdatedAt, UserID, Username. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the User list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (User). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for User include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Only return User entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsUserGetParametersQueryWhere_permission; /** * @description Select clause for specifying which fields to include in the response for User. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, UserID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Hidden User entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each User, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of User: its Of, or the From of its Filter, must be User. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of User entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort User results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering User: CreatedAt, DisplayName, ExternalID, HiddenReason, Slug, UpdatedAt, UserID, Username. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the User's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the User entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedUser"][]; }; }; /** @description User request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description User not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing User. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; GetUser: { parameters: { query?: { /** * @description Select clause for specifying which fields to include in the response for User. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, UserID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; }; header?: never; path: { /** @description Unique identifier for a user_id */ user_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedUser"]; }; }; /** @description User request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description User not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing User. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; ListAllViews: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Views returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on View: Annotations, BackingUnitID, Columns, CreatedAt, DisplayName, FilterID, GroupBy, Hash, HiddenReason, Labels, Of, OrderBy, OrderByDirection, OrganizationID, Permissions, Slug, SpaceID, UpdatedAt, UpstreamViewID, ViewID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the View list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (View). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for View include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Include clause for expanding related entities in the response for View. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for View are FilterID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** * @description Select clause for specifying which fields to include in the response for View. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * If not specified, all fields are returned. * Entity and parent IDs (like OrganizationID, SpaceID, ViewID) and Slug are always returned regardless of the select parameter. * Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included. * Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields. * The whole string must be query-encoded. */ select?: string; /** * @description Only return View entities on which the caller has this permission, as well as View, which every entity listed needs. * * A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on. * * Supported values: Manage, Edit, Use, View. */ where_permission?: PathsViewGetParametersQueryWhere_permission; /** * @description Hidden View entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description UUID of a View whose columns to compute for each View, returned as ViewColumns. * * The View must be in the same Organization as the user credentials, and be a View of View: its Of, or the From of its Filter, must be View. * * If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified. * * The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them. */ view?: string; /** @description Maximum number of View entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */ limit?: number; /** * @description Comma-separated list of fields to sort View results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'. * * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted. * * Supported attributes for ordering View: BackingUnitID, CreatedAt, DisplayName, FilterID, GroupBy, Hash, HiddenReason, Of, OrderBy, OrderByDirection, OrganizationID, Slug, SpaceID, UpdatedAt, UpstreamViewID, ViewID. * * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'. * * Results are ordered by the View's ID after the fields named, and by the ID alone if none are. * * The whole string must be query-encoded. */ order_by?: string; /** * @description The token from the ConfigHub-Continue header of the previous page, to return the View entities after it. * * The request's other parameters, except limit, must be the same as those of the request that returned the token. * * Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more. */ continue?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtendedView"][]; }; }; /** @description View request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing View. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkCreateViews: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Views returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on View: Annotations, BackingUnitID, Columns, CreatedAt, DisplayName, FilterID, GroupBy, Hash, HiddenReason, Labels, Of, OrderBy, OrderByDirection, OrganizationID, Permissions, Slug, SpaceID, UpdatedAt, UpstreamViewID, ViewID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the View list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (View). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for View include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden View entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for View. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for View are FilterID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of View entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the View entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Comma-separated list of prefixes to apply to cloned View names */ name_prefixes?: string; /** @description Comma-separated list of labels with multiple values for cloned View labels, in the format of key1=value1|value2,key2=value1|value2|value3 */ variant_labels?: string; /** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */ name_pattern?: string; /** * @description The specified string is an expression for the purpose of filtering * the list of Spaces returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, TriggerOtherUnitIDs, UpdatedAt, UpstreamSpaceID. * * Where expression to select destination spaces for cloning views * * The whole string must be query-encoded. */ where_space?: string; /** * @description UUID of a Filter entity to apply to the Space list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (Space). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter_space?: string; /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */ allow_exists?: string; /** @description Give each View written a backing Unit if it has none: a ConfigHub/YAML Unit holding the View's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Create Views from the ConfigHub/YAML Units where_unit and filter_unit select, each in its Unit's Space, and each with its Unit as its backing Unit. The request body is applied after the Unit's document. Units of other toolchains or describing other entity types are passed over; outstanding ValidationErrors on a Unit are an error. Takes none of the parameters that select entities to clone, name the clones or choose their Spaces. */ from_backing_units?: boolean; /** * @description The specified string is an expression for the purpose of filtering * the list of Units returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values. * * The Units to create entities from, with from_backing_units. * * The whole string must be query-encoded. */ where_unit?: string; /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */ filter_unit?: string; /** @description With from_backing_units, patch a View a selected Unit already backs with what the Unit holds that it has not taken yet, as a bulk patch with from_backing_units does, rather than report that the Unit backs it. The request body is applied after it. Without it, such a Unit is an error, or with allow_exists the View is returned as it is. */ patch_existing?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; Columns?: (Record | null)[] | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** Format: uuid */ FilterID?: string | null; GroupBy?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Of?: string | null; OrderBy?: string | null; OrderByDirection?: string | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ViewCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status (partial success) */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ViewCreateOrUpdateResponse"][]; }; }; /** @description View request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing View. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkDeleteViews: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Views returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on View: Annotations, BackingUnitID, Columns, CreatedAt, DisplayName, FilterID, GroupBy, Hash, HiddenReason, Labels, Of, OrderBy, OrderByDirection, OrganizationID, Permissions, Slug, SpaceID, UpdatedAt, UpstreamViewID, ViewID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the View list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (View). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for View include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden View entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for View. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for View are FilterID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of View entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the View entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Prune: of the Views selected, delete those whose backing Unit is empty, which says the View should not exist, and keep the Unit, empty and backing nothing, so that it keeps the View's history and a document that comes back revives it. The others are left alone and are not in the response, so a broad selection deletes only what was emptied. */ from_backing_units?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeleteResponse"][]; }; }; /** @description View request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unable to delete entity */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing View. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkPatchViews: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Views returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on View: Annotations, BackingUnitID, Columns, CreatedAt, DisplayName, FilterID, GroupBy, Hash, HiddenReason, Labels, Of, OrderBy, OrderByDirection, OrganizationID, Permissions, Slug, SpaceID, UpdatedAt, UpstreamViewID, ViewID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the View list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (View). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for View include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden View entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for View. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for View are FilterID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Maximum number of View entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */ limit?: number; /** @description The token from the ConfigHub-Continue header of the previous request, to act on the View entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */ continue?: string; /** @description Give each View written a backing Unit if it has none: a ConfigHub/YAML Unit holding the View's configuration, which is then kept in step with it. */ with_backing_units?: boolean; /** @description Patch each selected View with what its backing Unit holds that it has not taken yet: the change to the Unit since its LastReleasedRevisionNum. The request body is applied after it. Selecting one with no backing Unit is an error, and so are outstanding ValidationErrors on a backing Unit. */ from_backing_units?: boolean; /** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/merge-patch+json": { /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */ Annotations?: { [key: string]: string | null; } | null; Columns?: (Record | null)[] | null; /** @description An optional set of gates that, if any is present, will block deletion */ DeleteGates?: { [key: string]: boolean | null; } | null; /** @description Friendly name for the entity. */ DisplayName?: string | null; /** Format: uuid */ FilterID?: string | null; GroupBy?: string | null; /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */ HiddenReason?: string | null; /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */ Labels?: { [key: string]: string | null; } | null; Of?: string | null; OrderBy?: string | null; OrderByDirection?: string | null; Permissions?: { [key: string]: Record | null; } | null; /** @description Unique URL-safe identifier for the entity. */ Slug?: string | null; /** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */ Version?: number | null; }; }; }; responses: { /** @description OK */ 200: { headers: { /** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */ "ConfigHub-Continue"?: string; [name: string]: unknown; }; content: { "application/json": components["schemas"]["ViewCreateOrUpdateResponse"][]; }; }; /** @description Multi-Status: Mixed success and failure results */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ViewCreateOrUpdateResponse"][]; }; }; /** @description View request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description A backing Unit has outstanding ValidationErrors */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing View. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; BulkMoveViews: { parameters: { query?: { /** * @description The specified string is an expression for the purpose of filtering * the list of Views returned. The expression syntax was inspired by SQL. * It supports conjunctions using `AND` of relational expressions of the form *attribute* * *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase, * as in the JSON encoding. * Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`. * String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, * `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching. * String regex operators: `~` for regex matching, `~*` for case-insensitive regex, * `!~` and `!~*` for regex not matching (case-sensitive and insensitive). * Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. * UUIDs and boolean attributes support equality and inequality only. * UUID and time literals must be quoted as string literals. * String literals are quoted with single quotes, such as `'string'`. * Time literals use the same form as when serialized as JSON, * such as: `CreatedAt > '2025-02-18T23:16:34'`. * Integer and boolean literals are also supported for attributes of those types. * Arrays support the `?` operator to to match any element of the array, * as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`. * Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`. * An attribute naming a list of other entities can be filtered on their attributes with a `*` segment, * as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it. * Without the `*` such a reference is an error, since it names no single value to compare. * Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`. * Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence, * as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists). * Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`. * These are useful for nullable columns: `MergeSourceID = '' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL. * The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, * such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`. * Conjunctions are supported using the `AND` operator. * An example conjunction is: * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`. * * Supported attributes for filtering on View: Annotations, BackingUnitID, Columns, CreatedAt, DisplayName, FilterID, GroupBy, Hash, HiddenReason, Labels, Of, OrderBy, OrderByDirection, OrganizationID, Permissions, Slug, SpaceID, UpdatedAt, UpstreamViewID, ViewID. * * The whole string must be query-encoded. */ where?: string; /** * @description UUID of a Filter entity to apply to the View list. * * The Filter must be in the same Organization as the user credentials. * * The Filter's From field must match the entity type being filtered (View). * * For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID. * * The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic. * * If both 'filter' and 'where' parameters are specified, they are combined with AND logic. */ filter?: string; /** * @description Free text search that approximately matches the specified string against string fields and map keys/values. * * The search is case-insensitive and uses pattern matching to find entities containing the text. * * Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields. * * For map fields (like Labels and Annotations), the search matches both map keys and values. * * The search uses OR logic across all searchable fields, so matching any field will return the entity. * * If both 'where' and 'contains' parameters are specified, they are combined with AND logic. * * Searchable fields for View include string and map-type attributes from the queryable attributes list. * * The whole string must be query-encoded. */ contains?: string; /** * @description Hidden View entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason. * * It is a comma-separated list of HiddenReasons, or `*` for all of them. * * A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects. * * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */ include_hidden?: string; /** * @description Include clause for expanding related entities in the response for View. * The attribute names are case-sensitive, PascalCase, and * expected in a comma-separated list format as in the JSON encoding. * * Supported attributes for View are FilterID, OrganizationID, Permissions, SpaceID. * * The whole string must be query-encoded. */ include?: string; /** @description Report what the move would do, and what would stop it, without moving anything */ dry_run?: boolean; }; header?: never; path?: never; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["MoveRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description Multi-Status: nothing was moved, or some moved and others did not */ 207: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoveResponse"][]; }; }; /** @description View request is invalid (Bad Request). */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unauthorized access. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Forbidden access. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description View data conflict. Data has changed since last read. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Something went wrong while processing View. */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; /** @description Unexpected error. */ default: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["StandardErrorResponse"]; }; }; }; }; } declare enum PathsAttestationGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsAttributeGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsChange_orderGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsChange_setGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsChange_workflowGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsChannelGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View", Claim = "Claim" } declare enum PathsCommand_runGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsComponentGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsFilterGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsGroupGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsInvocationGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsLinkGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsOrganizationGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View", ManageChildren = "ManageChildren", EditChildren = "EditChildren", UseChildren = "UseChildren", ViewChildren = "ViewChildren", CreateChildren = "CreateChildren" } declare enum PathsOrganizationOrganization_idOrganization_memberGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsReleaseGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsReleaseGetParametersQueryDistinct_on { Space = "Space", Off = "Off" } declare enum PathsResourceGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsReview_commentGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsRevisionGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsRevisionGetParametersQueryDistinct_on { Unit = "Unit", Off = "Off" } declare enum PathsRevision_dataGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsRevision_dataGetParametersQueryDistinct_on { Unit = "Unit", Off = "Off" } declare enum PathsRevision_mutation_sourcesGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsRevision_mutation_sourcesGetParametersQueryDistinct_on { Unit = "Unit", Off = "Off" } declare enum PathsService_accountGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View", Impersonate = "Impersonate" } declare enum PathsSpaceGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View", ManageChildren = "ManageChildren", EditChildren = "EditChildren", UseChildren = "UseChildren", ViewChildren = "ViewChildren", CreateChildren = "CreateChildren", ApproveChildren = "ApproveChildren", TargetEditChildren = "TargetEditChildren", TargetViewChildren = "TargetViewChildren" } declare enum PathsSpaceSpace_idAttestationGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsSpaceSpace_idAttributeGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsSpaceSpace_idChange_orderGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsSpaceSpace_idChange_setGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsSpaceSpace_idChange_workflowGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsSpaceSpace_idChannelGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View", Claim = "Claim" } declare enum PathsSpaceSpace_idCommand_runGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsSpaceSpace_idFilterGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsSpaceSpace_idInvocationGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsSpaceSpace_idLinkGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsSpaceSpace_idReleaseGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsSpaceSpace_idTagGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsSpaceSpace_idTargetGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View", ManageChildren = "ManageChildren", EditChildren = "EditChildren", UseChildren = "UseChildren", ViewChildren = "ViewChildren", CreateChildren = "CreateChildren", ApproveChildren = "ApproveChildren", TargetEditChildren = "TargetEditChildren", TargetViewChildren = "TargetViewChildren" } declare enum PathsSpaceSpace_idTriggerGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsSpaceSpace_idUnitGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View", Approve = "Approve", TargetEdit = "TargetEdit", TargetView = "TargetView" } declare enum PathsSpaceSpace_idUnitUnit_idMutationGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsSpaceSpace_idUnitUnit_idResourceGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsSpaceSpace_idUnitUnit_idReview_commentGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsSpaceSpace_idUnitUnit_idRevisionGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsSpaceSpace_idViewGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsTagGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsTargetGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View", ManageChildren = "ManageChildren", EditChildren = "EditChildren", UseChildren = "UseChildren", ViewChildren = "ViewChildren", CreateChildren = "CreateChildren", ApproveChildren = "ApproveChildren", TargetEditChildren = "TargetEditChildren", TargetViewChildren = "TargetViewChildren" } declare enum PathsTriggerGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsUnitGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View", Approve = "Approve", TargetEdit = "TargetEdit", TargetView = "TargetView" } declare enum PathsUnit_blameGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View", Approve = "Approve", TargetEdit = "TargetEdit", TargetView = "TargetView" } declare enum PathsUnit_dataGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View", Approve = "Approve", TargetEdit = "TargetEdit", TargetView = "TargetView" } declare enum PathsUnit_diffGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View", Approve = "Approve", TargetEdit = "TargetEdit", TargetView = "TargetView" } declare enum PathsUnit_mutation_sourcesGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View", Approve = "Approve", TargetEdit = "TargetEdit", TargetView = "TargetView" } declare enum PathsUserGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum PathsViewGetParametersQueryWhere_permission { Manage = "Manage", Edit = "Edit", Use = "Use", View = "View" } declare enum AttestationResult { Pass = "Pass", Fail = "Fail" } declare enum ChangeOrderPriorRevisions { Include = "Include", Skip = "Skip", Error = "Error", All = "All" } declare enum ChangeOrderReleasePriorRevisions { Include = "Include", Error = "Error" } declare enum ChannelCondition { Claimed = "Claimed", Unclaimed = "Unclaimed" } declare enum MutationType { Add = "Add", Delete = "Delete", Update = "Update", Replace = "Replace", None = "None" } declare enum PromoteRequestPriorRevisions { Include = "Include", Skip = "Skip", Error = "Error", All = "All" } declare enum ReleaseLiveStatusHealth { Healthy = "Healthy", Progressing = "Progressing", Degraded = "Degraded", Suspended = "Suspended", Missing = "Missing", Unknown = "Unknown" } declare enum ReleaseLiveStatusOperation { Running = "Running", Succeeded = "Succeeded", Failed = "Failed" } declare enum ReleaseLiveStatusSync { Synced = "Synced", OutOfSync = "OutOfSync", Unknown = "Unknown" } declare enum ReleasePublishRequestPriorRevisions { Include = "Include", Error = "Error" } interface ConfigHubClientOptions { /** * Base URL of the ConfigHub instance, e.g. `https://hub.confighub.com` — the same * value passed to the auth provider. The ConfigHub API is mounted under `/api` * (the spec's paths are relative to it), so the client targets `{baseUrl}/api`. * Passing a URL that already ends in `/api` is accepted as-is. */ baseUrl: string; /** * Returns the current bearer token, or undefined when unauthenticated. May be * async so the caller can await a refresh. Wired as an openapi-fetch middleware * that sets `Authorization: Bearer ` per request. The client never stores * or refreshes tokens itself — that is the auth layer's job (see * `@confighub/react-auth`). */ getToken?: () => string | undefined | Promise; /** * Called when a request returns 401. A library must not redirect on its own, so * this hands control back to the caller — typically to trigger a token refresh * or re-login. The originating request is not retried automatically. */ onUnauthorized?: () => void | Promise; /** Override the fetch implementation (tests, non-browser runtimes). */ fetch?: typeof globalThis.fetch; } type ConfigHubClient = Client; /** * Create a typed ConfigHub API client. Every path, param, and response is derived * from the pinned OpenAPI spec (`src/schema.d.ts`), so it stays in lockstep with * the server. * * ```ts * const api = createConfigHubClient({ baseUrl, getToken: () => session.accessToken }); * const { data, error } = await api.GET('/me'); * const units = await api.GET('/space/{space_id}/unit', { params: { path: { space_id } } }); * ``` */ declare function createConfigHubClient(options: ConfigHubClientOptions): ConfigHubClient; /** * Configuration data is not a field of a Unit, a Revision, or a Release. It is read from * and written to its own endpoints, which serve the document itself as * `application/octet-stream` rather than a JSON envelope around it. * * These helpers exist because the two defaults of the underlying fetch client are both * wrong for that shape, and neither failure is visible to the type checker: * * - a read is parsed with `response.json()`, which throws on YAML, and * - a write is serialized with `JSON.stringify`, which would upload a quoted string. * * Everything else in the API is ordinary JSON and needs no wrapper — call the client * directly. In particular the bulk reads (`/unit_data`, `/revision_data`, * `/unit_mutation_sources`, `/revision_mutation_sources`) return JSON arrays, and a list * view should use those rather than one request per Unit. */ type UnitCreateOrUpdateResponse = components['schemas']['UnitCreateOrUpdateResponse']; type MutationSourcesResponse = components['schemas']['MutationSourcesResponse']; /** Identifies a Unit. Both ids are required: the data endpoints are Space-scoped. */ interface UnitRef { spaceId: string; unitId: string; } /** Identifies one Revision of a Unit. */ interface RevisionRef extends UnitRef { revisionId: string; } /** Identifies a Release. */ interface ReleaseRef { spaceId: string; releaseId: string; } interface ReadDataOptions { /** * A `DataHash` a previous read served, sent as `If-None-Match`. The server answers 304 * when the configuration has not changed, which surfaces as `notModified: true` and no * `data` — keep what you already had. */ ifNoneMatch?: string; signal?: AbortSignal; } interface ReadDataResult { /** The configuration, as text. Undefined on a 304 or an error. */ data?: string; /** The `DataHash`, taken from the ETag. Pass it back as `ifNoneMatch` or `ifMatch`. */ dataHash?: string; /** True when the server answered 304 because `ifNoneMatch` still matched. */ notModified: boolean; /** The parsed error body, when the request failed. */ error?: unknown; response: Response; } /** * Everything describing *how* a configuration should land belongs on the write that * carries it, not on a metadata update that precedes it. A metadata call changes no * configuration, so each of these has nothing to act on there and is silently dropped — * `mergeExternalSource` degrades to a plain overwrite that ignores protected paths, and * `dryRun` leaves the metadata call a dry run while this one really writes. */ interface WriteDataOptions { /** Description recorded on the Revision this write creates. */ lastChangeDescription?: string; /** * Extra parts of the result to return: `'ConfigData'`, `'MutationSources'`, or both, * comma-separated. For a `dryRun` nothing is stored, so this is the only way to see what * the operation produced. A name that is neither of these nor an expandable field is a 400. */ include?: string; /** Compute the result and report it without storing anything. */ dryRun?: boolean; /** Record the paths this write sets as protected local overrides. */ protect?: boolean; /** The classes of guarded reason this write is cleared for, as a JSON Clearance. */ clearance?: string; /** Revision providing the base configuration for a merge. */ mergeBase?: string; /** Merge the body against the Unit as an external source rather than replacing it. */ mergeExternalSource?: string; /** Also subtract the target's local differences from the source patch. */ mergeEnableSubtraction?: boolean; /** Tag id to attach to the head Revision. */ tag?: string; /** ChangeSet the write belongs to. */ changeSetId?: string; /** User-defined category for the Mutation. */ subgroup?: string; /** * A `DataHash` a read served, sent as `If-Match`, so the write fails rather than * clobbering a configuration somebody else changed in the meantime. */ ifMatch?: string; signal?: AbortSignal; } interface WriteDataResult { /** * The operation's result. The Unit is in its `Unit` field — a write answers with what * it did, not with the entity. */ data?: UnitCreateOrUpdateResponse; error?: unknown; response: Response; } /** A Unit's configuration, as text. */ declare function getUnitData(client: ConfigHubClient, ref: UnitRef, options?: ReadDataOptions): Promise; /** One Revision's configuration, as text. */ declare function getRevisionData(client: ConfigHubClient, ref: RevisionRef, options?: ReadDataOptions): Promise; /** A Release's bundle. Its ETag is the Release digest rather than a DataHash. */ declare function getReleaseData(client: ConfigHubClient, ref: ReleaseRef, options?: ReadDataOptions): Promise; /** * Replace a Unit's configuration. This is the only way configuration reaches a Unit other * than a clone, which copies it server-side: a metadata write has nowhere to put one, and * therefore nowhere to lose one. * * `data` is the document. An empty string is a real configuration — emptying a Unit is how * its resources are withdrawn — so never guard this call on the string being non-empty. * Track whether a configuration was *supplied* separately from what it contains. */ declare function putUnitData(client: ConfigHubClient, ref: UnitRef, data: string, options?: WriteDataOptions): Promise; /** What set each value in a Unit's configuration. Ordinary JSON. */ declare function getUnitMutationSources(client: ConfigHubClient, ref: UnitRef): Promise>; /** The Revision counterpart of {@link getUnitMutationSources}. */ declare function getRevisionMutationSources(client: ConfigHubClient, ref: RevisionRef): Promise>; declare const SLUG_PATTERN: RegExp; declare const SLUG_MAX_LENGTH = 128; declare const SLUG_PATTERN_MESSAGE = "Must start and end with a letter or number. May contain letters, numbers, hyphens (-), underscores (_), and periods (.)"; declare const LABEL_KEY_PATTERN: RegExp; declare const LABEL_KEY_MAX_LENGTH = 128; declare const LABEL_KEY_PATTERN_MESSAGE = "Must start and end with a letter or number. May contain letters, numbers, hyphens (-), underscores (_), periods (.), and forward slashes (/)"; declare const LABEL_VALUE_PATTERN: RegExp; declare const LABEL_VALUE_MAX_LENGTH = 128; declare const LABEL_VALUE_PATTERN_MESSAGE = "Must start and end with a printable character (no leading/trailing spaces). Quotes, backslashes, and wildcards are not allowed"; declare const ANNOTATION_KEY_PATTERN: RegExp; declare const ANNOTATION_KEY_MAX_LENGTH = 128; declare const ANNOTATION_KEY_PATTERN_MESSAGE = "Must start and end with a letter or number. May contain letters, numbers, hyphens (-), underscores (_), periods (.), and forward slashes (/)"; declare const ANNOTATION_VALUE_PATTERN: RegExp; declare const ANNOTATION_VALUE_MAX_LENGTH = 1024; declare const ANNOTATION_VALUE_PATTERN_MESSAGE = "Any content is allowed, including multiline text"; export { ANNOTATION_KEY_MAX_LENGTH, ANNOTATION_KEY_PATTERN, ANNOTATION_KEY_PATTERN_MESSAGE, ANNOTATION_VALUE_MAX_LENGTH, ANNOTATION_VALUE_PATTERN, ANNOTATION_VALUE_PATTERN_MESSAGE, type ConfigHubClient, type ConfigHubClientOptions, LABEL_KEY_MAX_LENGTH, LABEL_KEY_PATTERN, LABEL_KEY_PATTERN_MESSAGE, LABEL_VALUE_MAX_LENGTH, LABEL_VALUE_PATTERN, LABEL_VALUE_PATTERN_MESSAGE, type MutationSourcesResponse, type ReadDataOptions, type ReadDataResult, type ReleaseRef, type RevisionRef, SLUG_MAX_LENGTH, SLUG_PATTERN, SLUG_PATTERN_MESSAGE, type UnitCreateOrUpdateResponse, type UnitRef, type WriteDataOptions, type WriteDataResult, type components, createConfigHubClient, getReleaseData, getRevisionData, getRevisionMutationSources, getUnitData, getUnitMutationSources, type operations, type paths, putUnitData };