@@ -1778,6 +1778,192 @@ components:
17781778 oneOf:
17791779 - $ref: '#/components/schemas/AWSIntegrationUpdate'
17801780 - $ref: '#/components/schemas/HTTPIntegrationUpdate'
1781+ ActionQuery:
1782+ description: An action query. This query type is used to trigger an action,
1783+ such as sending a HTTP request.
1784+ properties:
1785+ events:
1786+ description: Events to listen for downstream of the action query.
1787+ items:
1788+ $ref: '#/components/schemas/AppBuilderEvent'
1789+ type: array
1790+ id:
1791+ description: The ID of the action query.
1792+ example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
1793+ format: uuid
1794+ type: string
1795+ name:
1796+ description: A unique identifier for this action query. This name is also
1797+ used to access the query's result throughout the app.
1798+ example: fetchPendingOrders
1799+ type: string
1800+ properties:
1801+ $ref: '#/components/schemas/ActionQueryProperties'
1802+ type:
1803+ $ref: '#/components/schemas/ActionQueryType'
1804+ required:
1805+ - id
1806+ - name
1807+ - type
1808+ - properties
1809+ type: object
1810+ ActionQueryCondition:
1811+ description: Whether to run this query. If specified, the query will only run
1812+ if this condition evaluates to `true` in JavaScript and all other conditions
1813+ are also met.
1814+ oneOf:
1815+ - type: boolean
1816+ - example: ${true}
1817+ type: string
1818+ ActionQueryDebounceInMs:
1819+ description: The minimum time in milliseconds that must pass before the query
1820+ can be triggered again. This is useful for preventing accidental double-clicks
1821+ from triggering the query multiple times.
1822+ oneOf:
1823+ - example: 310.5
1824+ format: double
1825+ type: number
1826+ - description: If this is a string, it must be a valid JavaScript expression
1827+ that evaluates to a number.
1828+ example: ${1000}
1829+ type: string
1830+ ActionQueryMockedOutputs:
1831+ description: The mocked outputs of the action query. This is useful for testing
1832+ the app without actually running the action.
1833+ oneOf:
1834+ - type: string
1835+ - $ref: '#/components/schemas/ActionQueryMockedOutputsObject'
1836+ ActionQueryMockedOutputsEnabled:
1837+ description: Whether to enable the mocked outputs for testing.
1838+ oneOf:
1839+ - type: boolean
1840+ - description: If this is a string, it must be a valid JavaScript expression
1841+ that evaluates to a boolean.
1842+ example: ${true}
1843+ type: string
1844+ ActionQueryMockedOutputsObject:
1845+ description: The mocked outputs of the action query.
1846+ properties:
1847+ enabled:
1848+ $ref: '#/components/schemas/ActionQueryMockedOutputsEnabled'
1849+ outputs:
1850+ description: The mocked outputs of the action query, serialized as JSON.
1851+ example: '{"status": "success"}'
1852+ type: string
1853+ required:
1854+ - enabled
1855+ type: object
1856+ ActionQueryOnlyTriggerManually:
1857+ description: Determines when this query is executed. If set to `false`, the
1858+ query will run when the app loads and whenever any query arguments change.
1859+ If set to `true`, the query will only run when manually triggered from elsewhere
1860+ in the app.
1861+ oneOf:
1862+ - type: boolean
1863+ - description: If this is a string, it must be a valid JavaScript expression
1864+ that evaluates to a boolean.
1865+ example: ${true}
1866+ type: string
1867+ ActionQueryPollingIntervalInMs:
1868+ description: If specified, the app will poll the query at the specified interval
1869+ in milliseconds. The minimum polling interval is 15 seconds. The query will
1870+ only poll when the app's browser tab is active.
1871+ oneOf:
1872+ - example: 30000.0
1873+ format: double
1874+ minimum: 15000.0
1875+ type: number
1876+ - description: If this is a string, it must be a valid JavaScript expression
1877+ that evaluates to a number.
1878+ example: ${15000}
1879+ type: string
1880+ ActionQueryProperties:
1881+ description: The properties of the action query.
1882+ properties:
1883+ condition:
1884+ $ref: '#/components/schemas/ActionQueryCondition'
1885+ debounceInMs:
1886+ $ref: '#/components/schemas/ActionQueryDebounceInMs'
1887+ mockedOutputs:
1888+ $ref: '#/components/schemas/ActionQueryMockedOutputs'
1889+ onlyTriggerManually:
1890+ $ref: '#/components/schemas/ActionQueryOnlyTriggerManually'
1891+ outputs:
1892+ description: The post-query transformation function, which is a JavaScript
1893+ function that changes the query's `.outputs` property after the query's
1894+ execution.
1895+ example: ${((outputs) => {return outputs.body.data})(self.rawOutputs)}
1896+ type: string
1897+ pollingIntervalInMs:
1898+ $ref: '#/components/schemas/ActionQueryPollingIntervalInMs'
1899+ requiresConfirmation:
1900+ $ref: '#/components/schemas/ActionQueryRequiresConfirmation'
1901+ showToastOnError:
1902+ $ref: '#/components/schemas/ActionQueryShowToastOnError'
1903+ spec:
1904+ $ref: '#/components/schemas/ActionQuerySpec'
1905+ required:
1906+ - spec
1907+ type: object
1908+ ActionQueryRequiresConfirmation:
1909+ description: Whether to prompt the user to confirm this query before it runs.
1910+ oneOf:
1911+ - type: boolean
1912+ - description: If this is a string, it must be a valid JavaScript expression
1913+ that evaluates to a boolean.
1914+ example: ${true}
1915+ type: string
1916+ ActionQueryShowToastOnError:
1917+ description: Whether to display a toast to the user when the query returns an
1918+ error.
1919+ oneOf:
1920+ - type: boolean
1921+ - description: If this is a string, it must be a valid JavaScript expression
1922+ that evaluates to a boolean.
1923+ example: ${true}
1924+ type: string
1925+ ActionQuerySpec:
1926+ description: The definition of the action query.
1927+ oneOf:
1928+ - type: string
1929+ - $ref: '#/components/schemas/ActionQuerySpecObject'
1930+ ActionQuerySpecInputs:
1931+ description: The inputs to the action query. These are the values that are passed
1932+ to the action when it is triggered.
1933+ oneOf:
1934+ - type: string
1935+ - $ref: '#/components/schemas/ActionQuerySpecInputsOneOf'
1936+ ActionQuerySpecInputsOneOf:
1937+ additionalProperties: {}
1938+ description: The definition of `ActionQuerySpecInputsOneOf` object.
1939+ type: object
1940+ ActionQuerySpecObject:
1941+ description: The action query spec object.
1942+ properties:
1943+ connectionId:
1944+ description: The ID of the custom connection to use for this action query.
1945+ example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
1946+ format: uuid
1947+ type: string
1948+ fqn:
1949+ description: The fully qualified name of the action type.
1950+ example: com.datadoghq.http.request
1951+ type: string
1952+ inputs:
1953+ $ref: '#/components/schemas/ActionQuerySpecInputs'
1954+ required:
1955+ - fqn
1956+ - connectionId
1957+ type: object
1958+ ActionQueryType:
1959+ default: action
1960+ description: The action query type.
1961+ enum:
1962+ - action
1963+ example: action
1964+ type: string
1965+ x-enum-varnames:
1966+ - ACTION
17811967 ActiveBillingDimensionsAttributes:
17821968 description: List of active billing dimensions.
17831969 properties:
@@ -9528,6 +9714,48 @@ components:
95289714 type: number
95299715 type: array
95309716 type: object
9717+ DataTransform:
9718+ description: A data transformer, which is custom JavaScript code that executes
9719+ and transforms data when its inputs change.
9720+ properties:
9721+ id:
9722+ description: The ID of the data transformer.
9723+ example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
9724+ format: uuid
9725+ type: string
9726+ name:
9727+ description: A unique identifier for this data transformer. This name is
9728+ also used to access the transformer's result throughout the app.
9729+ example: combineTwoOrders
9730+ type: string
9731+ properties:
9732+ $ref: '#/components/schemas/DataTransformProperties'
9733+ type:
9734+ $ref: '#/components/schemas/DataTransformType'
9735+ required:
9736+ - id
9737+ - name
9738+ - type
9739+ - properties
9740+ type: object
9741+ DataTransformProperties:
9742+ description: The properties of the data transformer.
9743+ properties:
9744+ outputs:
9745+ description: A JavaScript function that returns the transformed data.
9746+ example: "${(() => {return {\n allItems: [...fetchOrder1.outputs.items,
9747+ ...fetchOrder2.outputs.items],\n}})()}"
9748+ type: string
9749+ type: object
9750+ DataTransformType:
9751+ default: dataTransform
9752+ description: The data transform type.
9753+ enum:
9754+ - dataTransform
9755+ example: dataTransform
9756+ type: string
9757+ x-enum-varnames:
9758+ - DATATRANSFORM
95319759 Date:
95329760 description: Date as Unix timestamp in milliseconds.
95339761 example: 1722439510282
@@ -21625,34 +21853,12 @@ components:
2162521853 $ref: '#/components/schemas/Deployment'
2162621854 type: object
2162721855 Query:
21628- description: A query used by an app. This can take the form of an external action,
21629- a data transformation, or a state variable change.
21630- properties:
21631- events:
21632- description: Events to listen for downstream of the query.
21633- items:
21634- $ref: '#/components/schemas/AppBuilderEvent'
21635- type: array
21636- id:
21637- description: The ID of the query.
21638- example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
21639- format: uuid
21640- type: string
21641- name:
21642- description: The name of the query. The name must be unique within the app
21643- and is visible in the app editor.
21644- example: ''
21645- type: string
21646- properties:
21647- description: The properties of the query. The properties vary depending
21648- on the query type.
21649- type:
21650- $ref: '#/components/schemas/QueryType'
21651- required:
21652- - id
21653- - name
21654- - type
21655- type: object
21856+ description: A data query used by an app. This can take the form of an external
21857+ action, a data transformation, or a state variable.
21858+ oneOf:
21859+ - $ref: '#/components/schemas/ActionQuery'
21860+ - $ref: '#/components/schemas/DataTransform'
21861+ - $ref: '#/components/schemas/StateVariable'
2165621862 QueryFormula:
2165721863 description: A formula for calculation based on one or more queries.
2165821864 properties:
@@ -21676,18 +21882,6 @@ components:
2167621882 x-enum-varnames:
2167721883 - ASC
2167821884 - DESC
21679- QueryType:
21680- description: The query type.
21681- enum:
21682- - action
21683- - stateVariable
21684- - dataTransform
21685- example: action
21686- type: string
21687- x-enum-varnames:
21688- - ACTION
21689- - STATEVARIABLE
21690- - DATATRANSFORM
2169121885 RUMAggregateBucketValue:
2169221886 description: A bucket value, can be either a timeseries or a single value.
2169321887 oneOf:
@@ -29585,6 +29779,46 @@ components:
2958529779 - PASS
2958629780 - FAIL
2958729781 - SKIP
29782+ StateVariable:
29783+ description: A variable, which can be set and read by other components in the
29784+ app.
29785+ properties:
29786+ id:
29787+ description: The ID of the state variable.
29788+ example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
29789+ format: uuid
29790+ type: string
29791+ name:
29792+ description: A unique identifier for this state variable. This name is also
29793+ used to access the variable's value throughout the app.
29794+ example: ordersToSubmit
29795+ type: string
29796+ properties:
29797+ $ref: '#/components/schemas/StateVariableProperties'
29798+ type:
29799+ $ref: '#/components/schemas/StateVariableType'
29800+ required:
29801+ - id
29802+ - name
29803+ - type
29804+ - properties
29805+ type: object
29806+ StateVariableProperties:
29807+ description: The properties of the state variable.
29808+ properties:
29809+ defaultValue:
29810+ description: The default value of the state variable.
29811+ example: ${['order_3145', 'order_4920']}
29812+ type: object
29813+ StateVariableType:
29814+ default: stateVariable
29815+ description: The state variable type.
29816+ enum:
29817+ - stateVariable
29818+ example: stateVariable
29819+ type: string
29820+ x-enum-varnames:
29821+ - STATEVARIABLE
2958829822 Step:
2958929823 description: A Step is a sub-component of a workflow. Each Step performs an
2959029824 action.
@@ -33600,6 +33834,12 @@ paths:
3360033834 schema:
3360133835 $ref: '#/components/schemas/JSONAPIErrorResponse'
3360233836 description: Not Found
33837+ '410':
33838+ content:
33839+ application/json:
33840+ schema:
33841+ $ref: '#/components/schemas/JSONAPIErrorResponse'
33842+ description: Gone
3360333843 '429':
3360433844 $ref: '#/components/responses/TooManyRequestsResponse'
3360533845 summary: Get App
0 commit comments