@twin.org/node 0.9.1-next.1 → 0.9.1-next.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/locales/en.json +316 -60
- package/docs/changelog.md +142 -0
- package/docs/open-api/spec.json +486 -5
- package/docs/usage.md +265 -5
- package/package.json +3 -3
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,147 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.9.1-next.11](https://github.com/iotaledger/twin-node/compare/node-v0.9.1-next.10...node-v0.9.1-next.11) (2026-07-24)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* migration options ([#293](https://github.com/iotaledger/twin-node/issues/293)) ([91acc88](https://github.com/iotaledger/twin-node/commit/91acc881f665be0177b2e895e2810dd4d6145105))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/node-core bumped from 0.9.1-next.10 to 0.9.1-next.11
|
|
16
|
+
|
|
17
|
+
## [0.9.1-next.10](https://github.com/iotaledger/twin-node/compare/node-v0.9.1-next.9...node-v0.9.1-next.10) (2026-07-21)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Features
|
|
21
|
+
|
|
22
|
+
* update dependencies ([64c8ea8](https://github.com/iotaledger/twin-node/commit/64c8ea8c8b5e918f7ad419c4e3b8d08faf5e3fdd))
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
### Dependencies
|
|
26
|
+
|
|
27
|
+
* The following workspace dependencies were updated
|
|
28
|
+
* dependencies
|
|
29
|
+
* @twin.org/node-core bumped from 0.9.1-next.9 to 0.9.1-next.10
|
|
30
|
+
|
|
31
|
+
## [0.9.1-next.9](https://github.com/iotaledger/twin-node/compare/node-v0.9.1-next.8...node-v0.9.1-next.9) (2026-07-21)
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
### Features
|
|
35
|
+
|
|
36
|
+
* enhanced cli commands ([#288](https://github.com/iotaledger/twin-node/issues/288)) ([479fb34](https://github.com/iotaledger/twin-node/commit/479fb3448c493a134aee35b69ae39458e493a4ad))
|
|
37
|
+
* expose gasBudget and gasReservationDuration as configurable env vars ([#286](https://github.com/iotaledger/twin-node/issues/286)) ([d678b27](https://github.com/iotaledger/twin-node/commit/d678b27d629930a6ce85eeab9caf89d1187c3461))
|
|
38
|
+
* file logging config ([#287](https://github.com/iotaledger/twin-node/issues/287)) ([a567b25](https://github.com/iotaledger/twin-node/commit/a567b253cbb8b9af872bb0e494c013212f4f55a2))
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
### Dependencies
|
|
42
|
+
|
|
43
|
+
* The following workspace dependencies were updated
|
|
44
|
+
* dependencies
|
|
45
|
+
* @twin.org/node-core bumped from 0.9.1-next.8 to 0.9.1-next.9
|
|
46
|
+
|
|
47
|
+
## [0.9.1-next.8](https://github.com/iotaledger/twin-node/compare/node-v0.9.1-next.7...node-v0.9.1-next.8) (2026-07-10)
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
### Bug Fixes
|
|
51
|
+
|
|
52
|
+
* update dependencies ([#283](https://github.com/iotaledger/twin-node/issues/283)) ([053c53d](https://github.com/iotaledger/twin-node/commit/053c53d45ec233e6936e56f8de8d5a5346ad2242))
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
### Dependencies
|
|
56
|
+
|
|
57
|
+
* The following workspace dependencies were updated
|
|
58
|
+
* dependencies
|
|
59
|
+
* @twin.org/node-core bumped from 0.9.1-next.7 to 0.9.1-next.8
|
|
60
|
+
|
|
61
|
+
## [0.9.1-next.7](https://github.com/iotaledger/twin-node/compare/node-v0.9.1-next.6...node-v0.9.1-next.7) (2026-07-08)
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
### Miscellaneous Chores
|
|
65
|
+
|
|
66
|
+
* **node:** Synchronize repo versions
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
### Dependencies
|
|
70
|
+
|
|
71
|
+
* The following workspace dependencies were updated
|
|
72
|
+
* dependencies
|
|
73
|
+
* @twin.org/node-core bumped from 0.9.1-next.6 to 0.9.1-next.7
|
|
74
|
+
|
|
75
|
+
## [0.9.1-next.6](https://github.com/iotaledger/twin-node/compare/node-v0.9.1-next.5...node-v0.9.1-next.6) (2026-07-03)
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
### Miscellaneous Chores
|
|
79
|
+
|
|
80
|
+
* **node:** Synchronize repo versions
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
### Dependencies
|
|
84
|
+
|
|
85
|
+
* The following workspace dependencies were updated
|
|
86
|
+
* dependencies
|
|
87
|
+
* @twin.org/node-core bumped from 0.9.1-next.5 to 0.9.1-next.6
|
|
88
|
+
|
|
89
|
+
## [0.9.1-next.5](https://github.com/iotaledger/twin-node/compare/node-v0.9.1-next.4...node-v0.9.1-next.5) (2026-07-02)
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
### Features
|
|
93
|
+
|
|
94
|
+
* dataspace plane path ([#272](https://github.com/iotaledger/twin-node/issues/272)) ([5998eeb](https://github.com/iotaledger/twin-node/commit/5998eeb6fa1392ae753eb6bafeccefa1fb690573))
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
### Dependencies
|
|
98
|
+
|
|
99
|
+
* The following workspace dependencies were updated
|
|
100
|
+
* dependencies
|
|
101
|
+
* @twin.org/node-core bumped from 0.9.1-next.4 to 0.9.1-next.5
|
|
102
|
+
|
|
103
|
+
## [0.9.1-next.4](https://github.com/iotaledger/twin-node/compare/node-v0.9.1-next.3...node-v0.9.1-next.4) (2026-07-01)
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
### Features
|
|
107
|
+
|
|
108
|
+
* additional cli commands ([#269](https://github.com/iotaledger/twin-node/issues/269)) ([c9e7c93](https://github.com/iotaledger/twin-node/commit/c9e7c939aedfceed9cbe501f2dc936e84289ed62))
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
### Dependencies
|
|
112
|
+
|
|
113
|
+
* The following workspace dependencies were updated
|
|
114
|
+
* dependencies
|
|
115
|
+
* @twin.org/node-core bumped from 0.9.1-next.3 to 0.9.1-next.4
|
|
116
|
+
|
|
117
|
+
## [0.9.1-next.3](https://github.com/iotaledger/twin-node/compare/node-v0.9.1-next.2...node-v0.9.1-next.3) (2026-06-30)
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
### Miscellaneous Chores
|
|
121
|
+
|
|
122
|
+
* **node:** Synchronize repo versions
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
### Dependencies
|
|
126
|
+
|
|
127
|
+
* The following workspace dependencies were updated
|
|
128
|
+
* dependencies
|
|
129
|
+
* @twin.org/node-core bumped from 0.9.1-next.2 to 0.9.1-next.3
|
|
130
|
+
|
|
131
|
+
## [0.9.1-next.2](https://github.com/iotaledger/twin-node/compare/node-v0.9.1-next.1...node-v0.9.1-next.2) (2026-06-29)
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
### Features
|
|
135
|
+
|
|
136
|
+
* extend to 7-group weighted mix, fix REST paths + JSON-LD contexts ([#257](https://github.com/iotaledger/twin-node/issues/257)) ([d9f8d55](https://github.com/iotaledger/twin-node/commit/d9f8d55d389a82947b7a0297f44f76f7f6b3ba21))
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
### Dependencies
|
|
140
|
+
|
|
141
|
+
* The following workspace dependencies were updated
|
|
142
|
+
* dependencies
|
|
143
|
+
* @twin.org/node-core bumped from 0.9.1-next.1 to 0.9.1-next.2
|
|
144
|
+
|
|
3
145
|
## [0.9.1-next.1](https://github.com/iotaledger/twin-node/compare/node-v0.9.1-next.0...node-v0.9.1-next.1) (2026-06-26)
|
|
4
146
|
|
|
5
147
|
|
package/docs/open-api/spec.json
CHANGED
|
@@ -1952,6 +1952,311 @@
|
|
|
1952
1952
|
}
|
|
1953
1953
|
}
|
|
1954
1954
|
},
|
|
1955
|
+
"/authentication/audit/{id}": {
|
|
1956
|
+
"get": {
|
|
1957
|
+
"operationId": "authenticationAuditGet",
|
|
1958
|
+
"summary": "Get an authentication audit entry",
|
|
1959
|
+
"tags": [
|
|
1960
|
+
"Authentication Audit"
|
|
1961
|
+
],
|
|
1962
|
+
"parameters": [
|
|
1963
|
+
{
|
|
1964
|
+
"name": "id",
|
|
1965
|
+
"description": "The audit entry id.",
|
|
1966
|
+
"in": "path",
|
|
1967
|
+
"required": true,
|
|
1968
|
+
"schema": {
|
|
1969
|
+
"type": "string"
|
|
1970
|
+
},
|
|
1971
|
+
"style": "simple",
|
|
1972
|
+
"example": "018f0b53d5d5704fa3a06d6ed2478575"
|
|
1973
|
+
}
|
|
1974
|
+
],
|
|
1975
|
+
"security": [
|
|
1976
|
+
{
|
|
1977
|
+
"jwtBearerAuthScheme": []
|
|
1978
|
+
}
|
|
1979
|
+
],
|
|
1980
|
+
"responses": {
|
|
1981
|
+
"200": {
|
|
1982
|
+
"description": "Response from getting an authentication audit entry.",
|
|
1983
|
+
"content": {
|
|
1984
|
+
"application/json": {
|
|
1985
|
+
"schema": {
|
|
1986
|
+
"$ref": "#/components/schemas/AuthenticationAuditEntry"
|
|
1987
|
+
},
|
|
1988
|
+
"examples": {
|
|
1989
|
+
"authenticationAuditGetResponseExample": {
|
|
1990
|
+
"summary": "The response for getting an authentication audit entry.",
|
|
1991
|
+
"value": {
|
|
1992
|
+
"id": "018f0b53d5d5704fa3a06d6ed2478575",
|
|
1993
|
+
"actorId": "user@example.com",
|
|
1994
|
+
"dateCreated": "2026-01-12T09:05:23.123Z",
|
|
1995
|
+
"event": "login-success",
|
|
1996
|
+
"data": {
|
|
1997
|
+
"organizationIdentity": "did:example:org1"
|
|
1998
|
+
}
|
|
1999
|
+
}
|
|
2000
|
+
}
|
|
2001
|
+
}
|
|
2002
|
+
}
|
|
2003
|
+
}
|
|
2004
|
+
},
|
|
2005
|
+
"400": {
|
|
2006
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
2007
|
+
"content": {
|
|
2008
|
+
"application/json": {
|
|
2009
|
+
"schema": {
|
|
2010
|
+
"$ref": "#/components/schemas/Error"
|
|
2011
|
+
},
|
|
2012
|
+
"examples": {
|
|
2013
|
+
"exampleResponse": {
|
|
2014
|
+
"value": {
|
|
2015
|
+
"name": "GeneralError",
|
|
2016
|
+
"message": "errorMessage",
|
|
2017
|
+
"properties": {
|
|
2018
|
+
"foo": "bar"
|
|
2019
|
+
}
|
|
2020
|
+
}
|
|
2021
|
+
}
|
|
2022
|
+
}
|
|
2023
|
+
}
|
|
2024
|
+
}
|
|
2025
|
+
},
|
|
2026
|
+
"401": {
|
|
2027
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
2028
|
+
"content": {
|
|
2029
|
+
"application/json": {
|
|
2030
|
+
"schema": {
|
|
2031
|
+
"$ref": "#/components/schemas/Error"
|
|
2032
|
+
},
|
|
2033
|
+
"examples": {
|
|
2034
|
+
"exampleResponse": {
|
|
2035
|
+
"value": {
|
|
2036
|
+
"name": "UnauthorizedError",
|
|
2037
|
+
"message": "errorMessage"
|
|
2038
|
+
}
|
|
2039
|
+
}
|
|
2040
|
+
}
|
|
2041
|
+
}
|
|
2042
|
+
}
|
|
2043
|
+
},
|
|
2044
|
+
"500": {
|
|
2045
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
2046
|
+
"content": {
|
|
2047
|
+
"application/json": {
|
|
2048
|
+
"schema": {
|
|
2049
|
+
"$ref": "#/components/schemas/Error"
|
|
2050
|
+
},
|
|
2051
|
+
"examples": {
|
|
2052
|
+
"exampleResponse": {
|
|
2053
|
+
"value": {
|
|
2054
|
+
"name": "InternalServerError",
|
|
2055
|
+
"message": "errorMessage"
|
|
2056
|
+
}
|
|
2057
|
+
}
|
|
2058
|
+
}
|
|
2059
|
+
}
|
|
2060
|
+
}
|
|
2061
|
+
}
|
|
2062
|
+
}
|
|
2063
|
+
},
|
|
2064
|
+
"put": {
|
|
2065
|
+
"operationId": "authenticationAuditUpdate",
|
|
2066
|
+
"summary": "Update an authentication audit entry",
|
|
2067
|
+
"tags": [
|
|
2068
|
+
"Authentication Audit"
|
|
2069
|
+
],
|
|
2070
|
+
"parameters": [
|
|
2071
|
+
{
|
|
2072
|
+
"name": "id",
|
|
2073
|
+
"description": "The audit entry id.",
|
|
2074
|
+
"in": "path",
|
|
2075
|
+
"required": true,
|
|
2076
|
+
"schema": {
|
|
2077
|
+
"type": "string"
|
|
2078
|
+
},
|
|
2079
|
+
"style": "simple",
|
|
2080
|
+
"example": "018f0b53d5d5704fa3a06d6ed2478575"
|
|
2081
|
+
}
|
|
2082
|
+
],
|
|
2083
|
+
"security": [
|
|
2084
|
+
{
|
|
2085
|
+
"jwtBearerAuthScheme": []
|
|
2086
|
+
}
|
|
2087
|
+
],
|
|
2088
|
+
"requestBody": {
|
|
2089
|
+
"description": "Update an authentication audit entry.",
|
|
2090
|
+
"required": true,
|
|
2091
|
+
"content": {
|
|
2092
|
+
"application/json": {
|
|
2093
|
+
"schema": {
|
|
2094
|
+
"$ref": "#/components/schemas/AuditUpdateRequest"
|
|
2095
|
+
},
|
|
2096
|
+
"examples": {
|
|
2097
|
+
"authenticationAuditUpdateRequestExample": {
|
|
2098
|
+
"summary": "The request to update an authentication audit entry.",
|
|
2099
|
+
"value": {
|
|
2100
|
+
"data": {
|
|
2101
|
+
"organizationIdentity": "did:example:org1"
|
|
2102
|
+
}
|
|
2103
|
+
}
|
|
2104
|
+
}
|
|
2105
|
+
}
|
|
2106
|
+
}
|
|
2107
|
+
}
|
|
2108
|
+
},
|
|
2109
|
+
"responses": {
|
|
2110
|
+
"204": {
|
|
2111
|
+
"description": "The rest request ended in success with no data."
|
|
2112
|
+
},
|
|
2113
|
+
"400": {
|
|
2114
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
2115
|
+
"content": {
|
|
2116
|
+
"application/json": {
|
|
2117
|
+
"schema": {
|
|
2118
|
+
"$ref": "#/components/schemas/Error"
|
|
2119
|
+
},
|
|
2120
|
+
"examples": {
|
|
2121
|
+
"exampleResponse": {
|
|
2122
|
+
"value": {
|
|
2123
|
+
"name": "GeneralError",
|
|
2124
|
+
"message": "errorMessage",
|
|
2125
|
+
"properties": {
|
|
2126
|
+
"foo": "bar"
|
|
2127
|
+
}
|
|
2128
|
+
}
|
|
2129
|
+
}
|
|
2130
|
+
}
|
|
2131
|
+
}
|
|
2132
|
+
}
|
|
2133
|
+
},
|
|
2134
|
+
"401": {
|
|
2135
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
2136
|
+
"content": {
|
|
2137
|
+
"application/json": {
|
|
2138
|
+
"schema": {
|
|
2139
|
+
"$ref": "#/components/schemas/Error"
|
|
2140
|
+
},
|
|
2141
|
+
"examples": {
|
|
2142
|
+
"exampleResponse": {
|
|
2143
|
+
"value": {
|
|
2144
|
+
"name": "UnauthorizedError",
|
|
2145
|
+
"message": "errorMessage"
|
|
2146
|
+
}
|
|
2147
|
+
}
|
|
2148
|
+
}
|
|
2149
|
+
}
|
|
2150
|
+
}
|
|
2151
|
+
},
|
|
2152
|
+
"500": {
|
|
2153
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
2154
|
+
"content": {
|
|
2155
|
+
"application/json": {
|
|
2156
|
+
"schema": {
|
|
2157
|
+
"$ref": "#/components/schemas/Error"
|
|
2158
|
+
},
|
|
2159
|
+
"examples": {
|
|
2160
|
+
"exampleResponse": {
|
|
2161
|
+
"value": {
|
|
2162
|
+
"name": "InternalServerError",
|
|
2163
|
+
"message": "errorMessage"
|
|
2164
|
+
}
|
|
2165
|
+
}
|
|
2166
|
+
}
|
|
2167
|
+
}
|
|
2168
|
+
}
|
|
2169
|
+
}
|
|
2170
|
+
}
|
|
2171
|
+
},
|
|
2172
|
+
"delete": {
|
|
2173
|
+
"operationId": "authenticationAuditRemove",
|
|
2174
|
+
"summary": "Remove an authentication audit entry",
|
|
2175
|
+
"tags": [
|
|
2176
|
+
"Authentication Audit"
|
|
2177
|
+
],
|
|
2178
|
+
"parameters": [
|
|
2179
|
+
{
|
|
2180
|
+
"name": "id",
|
|
2181
|
+
"description": "The audit entry id.",
|
|
2182
|
+
"in": "path",
|
|
2183
|
+
"required": true,
|
|
2184
|
+
"schema": {
|
|
2185
|
+
"type": "string"
|
|
2186
|
+
},
|
|
2187
|
+
"style": "simple",
|
|
2188
|
+
"example": "018f0b53d5d5704fa3a06d6ed2478575"
|
|
2189
|
+
}
|
|
2190
|
+
],
|
|
2191
|
+
"security": [
|
|
2192
|
+
{
|
|
2193
|
+
"jwtBearerAuthScheme": []
|
|
2194
|
+
}
|
|
2195
|
+
],
|
|
2196
|
+
"responses": {
|
|
2197
|
+
"204": {
|
|
2198
|
+
"description": "The rest request ended in success with no data."
|
|
2199
|
+
},
|
|
2200
|
+
"400": {
|
|
2201
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
2202
|
+
"content": {
|
|
2203
|
+
"application/json": {
|
|
2204
|
+
"schema": {
|
|
2205
|
+
"$ref": "#/components/schemas/Error"
|
|
2206
|
+
},
|
|
2207
|
+
"examples": {
|
|
2208
|
+
"exampleResponse": {
|
|
2209
|
+
"value": {
|
|
2210
|
+
"name": "GeneralError",
|
|
2211
|
+
"message": "errorMessage",
|
|
2212
|
+
"properties": {
|
|
2213
|
+
"foo": "bar"
|
|
2214
|
+
}
|
|
2215
|
+
}
|
|
2216
|
+
}
|
|
2217
|
+
}
|
|
2218
|
+
}
|
|
2219
|
+
}
|
|
2220
|
+
},
|
|
2221
|
+
"401": {
|
|
2222
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
2223
|
+
"content": {
|
|
2224
|
+
"application/json": {
|
|
2225
|
+
"schema": {
|
|
2226
|
+
"$ref": "#/components/schemas/Error"
|
|
2227
|
+
},
|
|
2228
|
+
"examples": {
|
|
2229
|
+
"exampleResponse": {
|
|
2230
|
+
"value": {
|
|
2231
|
+
"name": "UnauthorizedError",
|
|
2232
|
+
"message": "errorMessage"
|
|
2233
|
+
}
|
|
2234
|
+
}
|
|
2235
|
+
}
|
|
2236
|
+
}
|
|
2237
|
+
}
|
|
2238
|
+
},
|
|
2239
|
+
"500": {
|
|
2240
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
2241
|
+
"content": {
|
|
2242
|
+
"application/json": {
|
|
2243
|
+
"schema": {
|
|
2244
|
+
"$ref": "#/components/schemas/Error"
|
|
2245
|
+
},
|
|
2246
|
+
"examples": {
|
|
2247
|
+
"exampleResponse": {
|
|
2248
|
+
"value": {
|
|
2249
|
+
"name": "InternalServerError",
|
|
2250
|
+
"message": "errorMessage"
|
|
2251
|
+
}
|
|
2252
|
+
}
|
|
2253
|
+
}
|
|
2254
|
+
}
|
|
2255
|
+
}
|
|
2256
|
+
}
|
|
2257
|
+
}
|
|
2258
|
+
}
|
|
2259
|
+
},
|
|
1955
2260
|
"/identity/{identity}": {
|
|
1956
2261
|
"get": {
|
|
1957
2262
|
"operationId": "identityResolve",
|
|
@@ -6833,6 +7138,122 @@
|
|
|
6833
7138
|
}
|
|
6834
7139
|
}
|
|
6835
7140
|
},
|
|
7141
|
+
"/telemetry/metric/{id}/value/{valueId}": {
|
|
7142
|
+
"get": {
|
|
7143
|
+
"operationId": "telemetryGetMetricValue",
|
|
7144
|
+
"summary": "Get a specific telemetry metric value",
|
|
7145
|
+
"tags": [
|
|
7146
|
+
"Telemetry"
|
|
7147
|
+
],
|
|
7148
|
+
"parameters": [
|
|
7149
|
+
{
|
|
7150
|
+
"name": "id",
|
|
7151
|
+
"description": "The id of the metric.",
|
|
7152
|
+
"in": "path",
|
|
7153
|
+
"required": true,
|
|
7154
|
+
"schema": {
|
|
7155
|
+
"type": "string"
|
|
7156
|
+
},
|
|
7157
|
+
"style": "simple",
|
|
7158
|
+
"example": "my-counter"
|
|
7159
|
+
},
|
|
7160
|
+
{
|
|
7161
|
+
"name": "valueId",
|
|
7162
|
+
"description": "The id of the metric value.",
|
|
7163
|
+
"in": "path",
|
|
7164
|
+
"required": true,
|
|
7165
|
+
"schema": {
|
|
7166
|
+
"type": "string"
|
|
7167
|
+
},
|
|
7168
|
+
"style": "simple",
|
|
7169
|
+
"example": "aabbccdd11223445566"
|
|
7170
|
+
}
|
|
7171
|
+
],
|
|
7172
|
+
"security": [
|
|
7173
|
+
{
|
|
7174
|
+
"jwtBearerAuthScheme": []
|
|
7175
|
+
}
|
|
7176
|
+
],
|
|
7177
|
+
"responses": {
|
|
7178
|
+
"200": {
|
|
7179
|
+
"description": "Get a telemetry metric value response.",
|
|
7180
|
+
"content": {
|
|
7181
|
+
"application/json": {
|
|
7182
|
+
"schema": {
|
|
7183
|
+
"$ref": "#/components/schemas/TelemetryMetricValue"
|
|
7184
|
+
},
|
|
7185
|
+
"examples": {
|
|
7186
|
+
"telemetryGetMetricValueResponseExample": {
|
|
7187
|
+
"value": {
|
|
7188
|
+
"id": "aabbccdd11223445566",
|
|
7189
|
+
"ts": 1715252922273,
|
|
7190
|
+
"value": 10
|
|
7191
|
+
}
|
|
7192
|
+
}
|
|
7193
|
+
}
|
|
7194
|
+
}
|
|
7195
|
+
}
|
|
7196
|
+
},
|
|
7197
|
+
"400": {
|
|
7198
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
7199
|
+
"content": {
|
|
7200
|
+
"application/json": {
|
|
7201
|
+
"schema": {
|
|
7202
|
+
"$ref": "#/components/schemas/Error"
|
|
7203
|
+
},
|
|
7204
|
+
"examples": {
|
|
7205
|
+
"exampleResponse": {
|
|
7206
|
+
"value": {
|
|
7207
|
+
"name": "GeneralError",
|
|
7208
|
+
"message": "errorMessage",
|
|
7209
|
+
"properties": {
|
|
7210
|
+
"foo": "bar"
|
|
7211
|
+
}
|
|
7212
|
+
}
|
|
7213
|
+
}
|
|
7214
|
+
}
|
|
7215
|
+
}
|
|
7216
|
+
}
|
|
7217
|
+
},
|
|
7218
|
+
"401": {
|
|
7219
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
7220
|
+
"content": {
|
|
7221
|
+
"application/json": {
|
|
7222
|
+
"schema": {
|
|
7223
|
+
"$ref": "#/components/schemas/Error"
|
|
7224
|
+
},
|
|
7225
|
+
"examples": {
|
|
7226
|
+
"exampleResponse": {
|
|
7227
|
+
"value": {
|
|
7228
|
+
"name": "UnauthorizedError",
|
|
7229
|
+
"message": "errorMessage"
|
|
7230
|
+
}
|
|
7231
|
+
}
|
|
7232
|
+
}
|
|
7233
|
+
}
|
|
7234
|
+
}
|
|
7235
|
+
},
|
|
7236
|
+
"500": {
|
|
7237
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
7238
|
+
"content": {
|
|
7239
|
+
"application/json": {
|
|
7240
|
+
"schema": {
|
|
7241
|
+
"$ref": "#/components/schemas/Error"
|
|
7242
|
+
},
|
|
7243
|
+
"examples": {
|
|
7244
|
+
"exampleResponse": {
|
|
7245
|
+
"value": {
|
|
7246
|
+
"name": "InternalServerError",
|
|
7247
|
+
"message": "errorMessage"
|
|
7248
|
+
}
|
|
7249
|
+
}
|
|
7250
|
+
}
|
|
7251
|
+
}
|
|
7252
|
+
}
|
|
7253
|
+
}
|
|
7254
|
+
}
|
|
7255
|
+
}
|
|
7256
|
+
},
|
|
6836
7257
|
"/automation/trigger/{trigger}": {
|
|
6837
7258
|
"post": {
|
|
6838
7259
|
"operationId": "AutomationTrigger",
|
|
@@ -13391,7 +13812,7 @@
|
|
|
13391
13812
|
"parameters": [
|
|
13392
13813
|
{
|
|
13393
13814
|
"name": "conditions",
|
|
13394
|
-
"description": "The conditions to filter the streams, JSON stringified
|
|
13815
|
+
"description": "The conditions to filter the streams, JSON stringified `EntityCondition<IAuditableItemStream>`.",
|
|
13395
13816
|
"in": "query",
|
|
13396
13817
|
"required": false,
|
|
13397
13818
|
"schema": {
|
|
@@ -14419,7 +14840,7 @@
|
|
|
14419
14840
|
},
|
|
14420
14841
|
{
|
|
14421
14842
|
"name": "conditions",
|
|
14422
|
-
"description": "The conditions to filter the stream, JSON stringified
|
|
14843
|
+
"description": "The conditions to filter the stream, JSON stringified `EntityCondition<IAuditableItemStreamEntry>`.",
|
|
14423
14844
|
"in": "query",
|
|
14424
14845
|
"required": false,
|
|
14425
14846
|
"schema": {
|
|
@@ -15268,7 +15689,7 @@
|
|
|
15268
15689
|
"parameters": [
|
|
15269
15690
|
{
|
|
15270
15691
|
"name": "conditions",
|
|
15271
|
-
"description": "The conditions to filter the stream, JSON stringified
|
|
15692
|
+
"description": "The conditions to filter the stream, JSON stringified `EntityCondition<IAuditableItemStreamEntry>`.",
|
|
15272
15693
|
"in": "query",
|
|
15273
15694
|
"required": false,
|
|
15274
15695
|
"schema": {
|
|
@@ -15529,7 +15950,7 @@
|
|
|
15529
15950
|
},
|
|
15530
15951
|
{
|
|
15531
15952
|
"name": "conditions",
|
|
15532
|
-
"description": "The conditions to filter the stream, JSON stringified
|
|
15953
|
+
"description": "The conditions to filter the stream, JSON stringified `EntityCondition<IAuditableItemStreamEntry>`.",
|
|
15533
15954
|
"in": "query",
|
|
15534
15955
|
"required": false,
|
|
15535
15956
|
"schema": {
|
|
@@ -15712,7 +16133,7 @@
|
|
|
15712
16133
|
"parameters": [
|
|
15713
16134
|
{
|
|
15714
16135
|
"name": "conditions",
|
|
15715
|
-
"description": "The conditions to filter the stream, JSON stringified
|
|
16136
|
+
"description": "The conditions to filter the stream, JSON stringified `EntityCondition<IAuditableItemStreamEntry>`.",
|
|
15716
16137
|
"in": "query",
|
|
15717
16138
|
"required": false,
|
|
15718
16139
|
"schema": {
|
|
@@ -18233,6 +18654,15 @@
|
|
|
18233
18654
|
"Policy Administration Point"
|
|
18234
18655
|
],
|
|
18235
18656
|
"parameters": [
|
|
18657
|
+
{
|
|
18658
|
+
"name": "type",
|
|
18659
|
+
"description": "The type of policy to filter by.",
|
|
18660
|
+
"in": "query",
|
|
18661
|
+
"required": false,
|
|
18662
|
+
"schema": {
|
|
18663
|
+
"type": "string"
|
|
18664
|
+
}
|
|
18665
|
+
},
|
|
18236
18666
|
{
|
|
18237
18667
|
"name": "assigner",
|
|
18238
18668
|
"description": "The assigner to filter by.",
|
|
@@ -20998,6 +21428,57 @@
|
|
|
20998
21428
|
],
|
|
20999
21429
|
"description": "The response body."
|
|
21000
21430
|
},
|
|
21431
|
+
"AuditUpdateRequest": {
|
|
21432
|
+
"description": "The body of the request.",
|
|
21433
|
+
"type": "object",
|
|
21434
|
+
"properties": {
|
|
21435
|
+
"event": {
|
|
21436
|
+
"anyOf": [
|
|
21437
|
+
{
|
|
21438
|
+
"$ref": "#/components/schemas/AuthAuditEvent"
|
|
21439
|
+
},
|
|
21440
|
+
{
|
|
21441
|
+
"type": "string"
|
|
21442
|
+
}
|
|
21443
|
+
],
|
|
21444
|
+
"description": "The audit event that occurred."
|
|
21445
|
+
},
|
|
21446
|
+
"actorId": {
|
|
21447
|
+
"type": "string",
|
|
21448
|
+
"description": "The actor identifier, could be e-mail, username, or other unique identifier."
|
|
21449
|
+
},
|
|
21450
|
+
"nodeId": {
|
|
21451
|
+
"type": "string",
|
|
21452
|
+
"description": "The node identifier associated with the audit entry, if applicable."
|
|
21453
|
+
},
|
|
21454
|
+
"organizationId": {
|
|
21455
|
+
"type": "string",
|
|
21456
|
+
"description": "The organization identifier associated with the audit entry, if applicable."
|
|
21457
|
+
},
|
|
21458
|
+
"tenantId": {
|
|
21459
|
+
"type": "string",
|
|
21460
|
+
"description": "The tenant identifier associated with the audit entry, if applicable."
|
|
21461
|
+
},
|
|
21462
|
+
"ipAddressHashes": {
|
|
21463
|
+
"type": "array",
|
|
21464
|
+
"items": {
|
|
21465
|
+
"type": "string"
|
|
21466
|
+
},
|
|
21467
|
+
"description": "The hashed IP addresses of the client."
|
|
21468
|
+
},
|
|
21469
|
+
"userAgent": {
|
|
21470
|
+
"type": "string",
|
|
21471
|
+
"description": "The user agent string of the client."
|
|
21472
|
+
},
|
|
21473
|
+
"correlationId": {
|
|
21474
|
+
"type": "string",
|
|
21475
|
+
"description": "The correlation ID for request tracing."
|
|
21476
|
+
},
|
|
21477
|
+
"data": {
|
|
21478
|
+
"description": "Additional data related to the audit entry, such as IP address, user agent, etc."
|
|
21479
|
+
}
|
|
21480
|
+
}
|
|
21481
|
+
},
|
|
21001
21482
|
"AuditableItemGraphCreateRequest": {
|
|
21002
21483
|
"description": "The data to be used in the vertex.",
|
|
21003
21484
|
"type": "object",
|