canvas package
Classes
<table><thead><tr><th>
Class
</th><th>
Description
</th></tr></thead> <tbody><tr><td>
</td><td>
A single entry in a batch of queued enhancements.
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Builds a definition of the enhancers to run on Canvas components to add data from other systems. Note that only the first matching enhancer will be run.
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
API client to make comms with the Next Gen Mesh Data Source API simpler
</td></tr> <tr><td>
</td><td>
API client to make comms with the Next Gen Mesh Data Type API simpler
</td></tr> <tr><td>
</td><td>
Builds a definition of the enhancers to run on Canvas components to add data from other systems. Note that only the first matching enhancer will be run.
</td></tr> <tr><td>
</td><td>
API client to enable managing project locales
</td></tr> <tr><td>
</td><td>
API client to make comms with the Next Gen Mesh Data Source API simpler
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
API client to enable managing project releases
</td></tr> <tr><td>
</td><td>
API client to enable managing project releases
</td></tr> <tr><td>
</td><td>
Resolves a route using Uniform Project Map and Uniform Redirects, returning a composition, redirection, or not found result.
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Given a batch of enhancements containing potentially duplicate entries (i.e. several components referencing the same thing), group them together by some unique identifier and enable simpler batch processing.
</td></tr> </tbody></table>
Functions
<table><thead><tr><th>
Function
</th><th>
Description
</th></tr></thead> <tbody><tr><td>
bindVariables({ variables, value, errorPrefix, handleBinding, })
</td><td>
Binds variables to a string that could have variable values in it. Variables are referenced in the string as $}
</td></tr> <tr><td>
bindVariablesToObject(options)
</td><td>
Binds composition variables to an object whose string keys may have variable expressions in them. Binding is recursive.
</td></tr> <tr><td>
</td><td>
Converts a content entry to a put content entry body that has only the properties expected to the PUT API. Removes things like author, stats, etc.
</td></tr> <tr><td>
createBatchEnhancer({ handleBatch, shouldQueue, limitPolicy, })
</td><td>
Creates an enhancer that batches up all enhancements for a composition into a set of promises, and then handles them all in a single batch. Used to reduce the number of HTTP requests needed to fulfill layout enhancements when a layout uses many resources from other systems.
</td></tr> <tr><td>
</td><td>
Creates an event bus client to receive updates from Canvas IMPORTANT: in a server-side context this will always return undefined IMPORTANT: in a browser context this is cached in window and does not create multiple instances
</td></tr> <tr><td>
createLimitPolicy({ throttle, retry, })
</td><td>
</td></tr> <tr><td>
createVariableReference(variableName)
</td><td>
</td></tr> <tr><td>
enhance({ composition, enhancers, context, onErrors, })
</td><td>
Applies enhancer functions to a component tree. IMPORTANT: the input composition object is mutated. Plan accordingly. Want immutability? Grab immer :)
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
findParameterInNodeTree(data, predicate)
</td><td>
Walk a Composition or Entry tree to find parameters or fields based on the predicate returning true
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
getBlockValue(component, parameterName)
</td><td>
Gets the typed value of a block parameter or block field
</td></tr> <tr><td>
getChannelName(projectId, compositionId, state)
</td><td>
</td></tr> <tr><td>
getComponentJsonPointer(ancestorsAndSelf)
</td><td>
Returns the JSON pointer of a component based on its location
</td></tr> <tr><td>
getComponentPath(ancestorsAndSelf)
</td><td>
</td></tr> <tr><td>
getNounForLocation(parentLocation)
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Gets the object holding the properties (fields or parameters) of an entry or component instance If no properties are defined, returns undefined.
</td></tr> <tr><td>
</td><td>
Get the data stored in the value of a component parameter or a field attached to an Entry, Block or Asset
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
A fast, non-exhaustive guard which checks that the value is an array as well as the first item, if there is one, looks like an asset item
</td></tr> <tr><td>
</td><td>
A fast, non-exhaustive guard which checks the required structure of an asset item
</td></tr> <tr><td>
</td><td>
Check to see if some generic composition data structure looks like Entry data
</td></tr> <tr><td>
</td><td>
Any types which hold an array of nodes and therefore should be iterated over as child nodes
</td></tr> <tr><td>
</td><td>
When walking a node tree, is the node the root node and look like Entry data
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Localizes a composition or entry that may contain: * Structural localization with localization components (locale specific layout) * Property localization with localizable property values (translations)
The result will contain only parameters and localizations that match one of the input locales. Information for other locales will be discarded in the result.
NOTE: this function mutates its input object for maximum performance. If you desire immutability wrap it in immer.
</td></tr> <tr><td>
mapSlotToPersonalizedVariations(slot)
</td><td>
Converts components in a slot into personalized variations (based on each component's intent tag in Canvas) suitable to pass to a personalize component Useful when implementing custom personalization settings for Canvas components.
</td></tr> <tr><td>
</td><td>
Converts components in a slot into test variations (based on each component's Context tag in Canvas) suitable to pass to a personalize component Useful when implementing custom test settings for Canvas components.
</td></tr> <tr><td>
parseVariableExpression(serialized, onToken)
</td><td>
Parses an expression that may contain Uniform variables and invokes a callback for each text or variable token found
</td></tr> <tr><td>
</td><td>
Subscribes to a composition event
</td></tr> <tr><td>
walkComponentTree(component, visitor, initialContext)
</td><td>
Walks a composition's component tree, visiting each component instance depth-first, in order.
</td></tr> <tr><td>
walkNodeTree(node, visitor, options)
</td><td>
Walks a composition's content tree, visiting each component in a slot or block parameter/field depth-first, in order.
</td></tr> </tbody></table>
Interfaces
<table><thead><tr><th>
Interface
</th><th>
Description
</th></tr></thead> <tbody><tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> </tbody></table>
Variables
<table><thead><tr><th>
Variable
</th><th>
Description
</th></tr></thead> <tbody><tr><td>
</td><td>
This is the type value for the asset parameter or field
</td></tr> <tr><td>
</td><td>
The _source for any assets which have manually set fields
</td></tr> <tr><td>
</td><td>
The _source for any assets coming from the Uniform Asset Library
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Parameter type for a block parameter
</td></tr> <tr><td>
</td><td>
Constant for a draft composition state. Subject to change.
</td></tr> <tr><td>
</td><td>
Constant for editor composition state.
</td></tr> <tr><td>
</td><td>
Public ID of the Uniform Context enrichment tag parameter on Canvas components
</td></tr> <tr><td>
</td><td>
Public ID of the intent tag parameter on the Canvas personalization component type
</td></tr> <tr><td>
</td><td>
Public ID of the locale parameter on Canvas components
</td></tr> <tr><td>
</td><td>
Name of the slot on CANVAS_TEST_TYPE
</td></tr> <tr><td>
</td><td>
Public ID of Canvas localization component type
</td></tr> <tr><td>
</td><td>
Public ID of the Uniform Context personalization parameter on Canvas components
</td></tr> <tr><td>
</td><td>
Name of the slot on CANVAS_PERSONALIZE_TYPE
</td></tr> <tr><td>
</td><td>
Public ID of Canvas personalization component type
</td></tr> <tr><td>
</td><td>
Constant for a published composition state. Subject to change.
</td></tr> <tr><td>
</td><td>
Name of the slot on CANVAS_SLOT_SECTION_TYPE
</td></tr> <tr><td>
</td><td>
Public ID of Canvas slot section component type
</td></tr> <tr><td>
</td><td>
Name of the slot on CANVAS_TEST_TYPE
</td></tr> <tr><td>
</td><td>
Public ID of Canvas A/B test component type
</td></tr> <tr><td>
</td><td>
Public ID of the Uniform Context test variant parameter on Canvas components
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Composes several enhancers into a synchronous chain. Can be used to modify the output of an enhancer. NOTE: only the first enhancer in the chain may use batching (completeAll()).
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Creates an enhancer based on an API route. This is mainly used to create an enhancer for Contextual Editing, which can be passed to the contextualEditingEnhancer prop of <UniformComposition />.
</td></tr> <tr><td>
</td><td>
A value that indicates that Edgehancers caching is disabled
</td></tr> <tr><td>
</td><td>
Default value for Edgehancers Cache TTL (in seconds)
</td></tr> <tr><td>
</td><td>
Maximal value for Edgehancers Cache TTL (in seconds)
</td></tr> <tr><td>
</td><td>
Minimal value for Edgehancers Cache TTL (in seconds)
</td></tr> <tr><td>
</td><td>
Contextual editing empty composition, used as a placeholder while waiting for the composition to be send by the editor.
</td></tr> <tr><td>
generateComponentPlaceholderId
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Returns the attributes needed to annotate a Uniform parameter for inline editing. Supports only text parameters at the moment.
</td></tr> <tr><td>
IN_CONTEXT_EDITOR_COMPONENT_END_ROLE
</td><td>
The value of "data-role" in the component end <script> tag
</td></tr> <tr><td>
IN_CONTEXT_EDITOR_COMPONENT_START_ROLE
</td><td>
The value of "data-role" in the component start <script> tag
</td></tr> <tr><td>
IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM
</td><td>
The name of the query string used to get the config from the preview url
</td></tr> <tr><td>
IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID
</td><td>
The ID of the Contextual Editing script that gets embedded in frontend apps
</td></tr> <tr><td>
IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM
</td><td>
The name of the query string used to detect if we are in contextual editing mode
</td></tr> <tr><td>
IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM
</td><td>
The name of the query string used to indicate that we want to use the playground for preview
</td></tr> <tr><td>
IN_CONTEXT_EDITOR_QUERY_STRING_PARAM
</td><td>
The name of the query string used to detect if we are in contextual editing mode
</td></tr> <tr><td>
IS_RENDERED_BY_UNIFORM_ATTRIBUTE
</td><td>
The name of the attribute added to the elements rendered by Uniform. Use to allow interacting with them by default in the preview panel
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Checks if page is opened from inside Uniform Canvas Editor. So if you open preview in incognito or via copy/paste link, it will return false.
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
isReportRenderedCompositionsMessage
</td><td>
</td></tr> <tr><td>
isRequestComponentSuggestionMessage
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Determines if a given Canvas component type is a system-defined type
</td></tr> <tr><td>
isTriggerCompositionActionMessage
</td><td>
</td></tr> <tr><td>
isUpdateComponentParameterMessage
</td><td>
</td></tr> <tr><td>
isUpdateComponentReferencesMessage
</td><td>
</td></tr> <tr><td>
isUpdateCompositionInternalMessage
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
isUpdateContextualEditingStateInternalMessage
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
isUpdatePreviewSettingsMessage
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
The ID we give to placeholder components
</td></tr> <tr><td>
</td><td>
The name of the query string used to set a secret to protect for the preview mode. This is not configurable at the moment.
</td></tr> </tbody></table>
Type Aliases
<table><thead><tr><th>
Type Alias
</th><th>
Description
</th></tr></thead> <tbody><tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
An enhancer that queues up promises for each component that needs enhancing, and once all enhancements have been queued handles them all in a batch. Note: this type is adaptable to both ComponentParameterEnhancer and ComponentEnhancer types.
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Ancestor location that is in a block on a parameter or field
</td></tr> <tr><td>
</td><td>
Value type of a block parameter or block field
</td></tr> <tr><td>
</td><td>
Defines single structure to keep all canvas models (used in CLI commands and Starter content generations)
</td></tr> <tr><td>
</td><td>
Shape of the DELETE request body for /api/v1/category
</td></tr> <tr><td>
</td><td>
Query parameter options for GET /api/v1/category
</td></tr> <tr><td>
</td><td>
Shape of the GET response from /api/v1/category
</td></tr> <tr><td>
</td><td>
Shape of the PUT request body for /api/v1/category
</td></tr> <tr><td>
</td><td>
Defines a component type that can live on a Composition
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Pusher-js is large (80k) and not tree shakable so it is always bundled if directly referenced, when it's only needed during preview mode. To avoid bundling it for all, we use an old-school write-a-script-tag hack to load it in a poor man's approximation of a dynamic import ;)
</td></tr> <tr><td>
</td><td>
Defines a component type that can live on a Composition
</td></tr> <tr><td>
ComponentDefinitionDeleteParameters
</td><td>
Shape of the DELETE request body for /api/v1/canvas-definitions
</td></tr> <tr><td>
ComponentDefinitionGetParameters
</td><td>
Query parameter options for GET /api/v1/canvas-definitions
</td></tr> <tr><td>
ComponentDefinitionGetResponse
</td><td>
Shape of the GET response from /api/v1/canvas-definitions
</td></tr> <tr><td>
</td><td>
The definition of a component parameter
</td></tr> <tr><td>
</td><td>
Permission set for a component defintion
</td></tr> <tr><td>
ComponentDefinitionPutParameters
</td><td>
Shape of the PUT request body for /api/v1/canvas-definitions
</td></tr> <tr><td>
</td><td>
The definition of a named component slot that can contain other components
</td></tr> <tr><td>
ComponentDefinitionSlugSettings
</td><td>
The definition of a composition's slug settings
</td></tr> <tr><td>
</td><td>
The definition of a component visual variant
</td></tr> <tr><td>
</td><td>
Defines logic to add arbitrary async data to a component's data property. Used to enhance layout data with information from other platforms, such as private APIs, where the value is not tied to a parameter and is intrinsic to the component itself.
</td></tr> <tr><td>
</td><td>
A function which is called for each matching component in a composition, which can manipulate the value of a specific key in the component's data property. Used to enhance layout data with information from other platforms, such as private APIs, where the value is not tied to a parameter and is intrinsic to the component itself.
Note: the configuration of enhancers namespaces component enhancers into a named property on the data object to avoid collisions, thus an enhancer need not worry about merging values with other enhancers, nor which key it has been registered under.
Return values: TValue - sets the configured key in the component's data value to this value undefined - do not set the component's data key
</td></tr> <tr><td>
</td><td>
Options passed to a ComponentEnhancer function
</td></tr> <tr><td>
</td><td>
Defines the shape of a component instance served by the composition API.
</td></tr> <tr><td>
ComponentInstanceContextualEditing
</td><td>
The type of the component instance in contextual editing mode.
</td></tr> <tr><td>
</td><td>
A historical version of a composition
</td></tr> <tr><td>
ComponentInstanceHistoryGetParameters
</td><td>
The GET response from /api/v1/canvas-history (history for one composition)
</td></tr> <tr><td>
ComponentInstanceHistoryGetResponse
</td><td>
The GET response from /api/v1/canvas-history
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Ancestor location that is in a slot on a component
</td></tr> <tr><td>
</td><td>
Defines how a component on a pattern may have its values overridden
</td></tr> <tr><td>
</td><td>
Defines the shape of a component override
</td></tr> <tr><td>
</td><td>
Defines a set of component overrides by component ID
</td></tr> <tr><td>
</td><td>
Defines an editable parameter on a component.
</td></tr> <tr><td>
</td><td>
Parameter which stores blocks of entry types
</td></tr> <tr><td>
ComponentParameterContextualEditing
</td><td>
The type of the parameters in contextual editing mode.
</td></tr> <tr><td>
</td><td>
Defines logic to replace the value of a component parameter with arbitrary async data. Used to enhance layout data with information from other platforms, such as CMS, commerce, indexing, etc, where that data is directly expandable from a parameter value.
</td></tr> <tr><td>
ComponentParameterEnhancerFunction
</td><td>
A function which is called for each component parameter in a component tree, which can manipulate the value of the parameter. Used to enhance layout data with information from other platforms, such as CMS, commerce, indexing, etc.
Return values: TValue - replaces the original parameter value with this value undefined - do not change the original parameter value null - sets the parameter value to null, replacing any existing value (i.e. if its value could not be resolved in an external system)
</td></tr> <tr><td>
ComponentParameterEnhancerOptions
</td><td>
Options passed to a ComponentParameterEnhancer function
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Shape of the DELETE request body for /api/v1/canvas
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
CompositionGetByComponentIdParameters
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
CompositionGetByNodeIdParameters
</td><td>
</td></tr> <tr><td>
CompositionGetByNodePathParameters
</td><td>
Defines exact parameters for specific requests getting a single composition
</td></tr> <tr><td>
CompositionGetBySlugParameters
</td><td>
</td></tr> <tr><td>
</td><td>
The GET response from /api/v1/canvas when component or slug are not specified
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Query parameter options for GET /api/v1/canvas
</td></tr> <tr><td>
</td><td>
The GET response from /api/v1/canvas when component or slug params are specified
</td></tr> <tr><td>
</td><td>
All valid response types
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
The PUT request body for /api/v1/canvas
</td></tr> <tr><td>
CompositionResolvedGetResponse
</td><td>
Response as it comes from uniform.global/api/v1/composition
</td></tr> <tr><td>
CompositionResolvedListResponse
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
ContextualEditingComponentReference
</td><td>
</td></tr> <tr><td>
</td><td>
Diagnostic data about the load performance of attached composition datas
</td></tr> <tr><td>
</td><td>
An error while binding a dynamic token from a data resource to a component parameter (i.e. a missing property in the data resource)
</td></tr> <tr><td>
DataElementConnectionDefinition
</td><td>
Defines a connection to a dynamic token on a data resource.
</td></tr> <tr><td>
</td><td>
Error in data resolution configuration (internal error)
</td></tr> <tr><td>
</td><td>
Types of issue that can occur when fetching composition data
</td></tr> <tr><td>
</td><td>
Switches for data resolution
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters
</td></tr> <tr><td>
</td><td>
Data definitions attached to this component. The property name is the key of the data in the data document. Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
</td></tr> <tr><td>
</td><td>
An error that occurred fetching a data defined on the composition or a pattern within
</td></tr> <tr><td>
</td><td>
Variable values for a data resource.
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Shape of the DELETE request body for /api/v1/data-source
</td></tr> <tr><td>
</td><td>
Query parameter options for GET /api/v1/data-source
</td></tr> <tr><td>
</td><td>
The GET response from /api/v1/data-sources
</td></tr> <tr><td>
</td><td>
The PUT request body for /api/v1/data-source
</td></tr> <tr><td>
</td><td>
Query parameter options for GET /api/v1/data-sources
</td></tr> <tr><td>
</td><td>
The GET response from /api/v1/data-sources
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Shape of the DELETE request body for /api/v1/data-types
</td></tr> <tr><td>
</td><td>
Query parameter options for GET /api/v1/data-types
</td></tr> <tr><td>
</td><td>
The GET response from /api/v1/data-types
</td></tr> <tr><td>
</td><td>
The PUT request body for /api/v1/data-types
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
An issue that occurred while binding dynamic inputs to composition data resources, specifically when an expected dynamic input did not have a value.
</td></tr> <tr><td>
</td><td>
Diagnostics about edge request processing
</td></tr> <tr><td>
EdgehancersWholeResponseCacheDiagnostics
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
The GET response from /api/v1/entries
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
The GET response from /api/v1/entries-history (history for one entry)
</td></tr> <tr><td>
</td><td>
The GET response from /api/v1/entries-history
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
A locale definition
</td></tr> <tr><td>
</td><td>
Shape of the DELETE request body for /api/v1/locales
</td></tr> <tr><td>
</td><td>
The PUT request body for /api/v1/locales
</td></tr> <tr><td>
</td><td>
Query parameter options for GET /api/v1/locales
</td></tr> <tr><td>
</td><td>
The GET response from /api/v1/locales
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Defines the shape of a component override
</td></tr> <tr><td>
</td><td>
An error that occured resolving a pattern that is referenced on the composition
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
ProjectMapLinkComponentParameterValue
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Shape of the DELETE request body for /api/v1/prompts
</td></tr> <tr><td>
</td><td>
Query parameter options for GET /api/v1/prompts
</td></tr> <tr><td>
</td><td>
The GET response from /api/v1/prompts
</td></tr> <tr><td>
</td><td>
The PUT request body for /api/v1/prompts
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
A release definition
</td></tr> <tr><td>
</td><td>
An entity that has been added to a release
</td></tr> <tr><td>
</td><td>
Body options for DELETE /api/v1/release-contents
</td></tr> <tr><td>
</td><td>
Query parameter options for GET /api/v1/release-contents
</td></tr> <tr><td>
</td><td>
The GET response from /api/v1/release-contents
</td></tr> <tr><td>
</td><td>
Shape of the DELETE request body for /api/v1/releases
</td></tr> <tr><td>
</td><td>
The PATCH request body for /api/v1/releases
</td></tr> <tr><td>
</td><td>
The PUT request body for /api/v1/releases
</td></tr> <tr><td>
</td><td>
Query parameter options for GET /api/v1/releases
</td></tr> <tr><td>
</td><td>
The GET response from /api/v1/releases
</td></tr> <tr><td>
</td><td>
The states a release can be in. Ready, merging, or archived releases cannot be altered.
</td></tr> <tr><td>
ReportRenderedCompositionsMessage
</td><td>
</td></tr> <tr><td>
RequestComponentSuggestionMessage
</td><td>
</td></tr> <tr><td>
</td><td>
A route API response with edgehancer composition result
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Defines the shape of the root component in a composition
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
Ancestor location that is the root of a composition or entry
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
The GET response from /api/v1/route
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
RouteGetResponseEdgehancedComposition
</td><td>
GET response from uniform.global/api/v1/route when result is a composition
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
TriggerCompositionActionMessage
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
UpdateComponentParameterMessage
</td><td>
</td></tr> <tr><td>
UpdateComponentReferencesMessage
</td><td>
</td></tr> <tr><td>
UpdateCompositionInternalMessage
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
UpdateContextualEditingStateInternalMessage
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> <tr><td>
</td><td>
</td></tr> </tbody></table>