Skip to content

Commit bee3898

Browse files
ysyneuysyneu
authored
Merge pull request #125 from flashcatcloud/api-review/auto-20260630-085619
docs(api): document RUM application links
2 parents fc7db36 + bee901e commit bee3898

4 files changed

Lines changed: 732 additions & 32 deletions

File tree

‎api-reference/openapi.en.json‎

Lines changed: 183 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15697,7 +15697,24 @@
1569715697
"created_by": 4441703362131,
1569815698
"updated_by": 3790925372131,
1569915699
"created_at": 1746673831462,
15700-
"updated_at": 1773398630657
15700+
"updated_at": 1773398630657,
15701+
"links": {
15702+
"enabled": true,
15703+
"systems": [
15704+
{
15705+
"id": "s3-crash-logs",
15706+
"name": "S3 Crash Logs",
15707+
"icon_text": "S3",
15708+
"icon_color": "#0F766E",
15709+
"url": "https://s3.example.com/logs?app=${application_id}&trace=${trace_id}",
15710+
"event_types": [
15711+
"crash",
15712+
"error"
15713+
],
15714+
"enabled": true
15715+
}
15716+
]
15717+
}
1570115718
},
1570215719
{
1570315720
"account_id": 2451002751131,
@@ -15726,7 +15743,11 @@
1572615743
"created_by": 2476444212131,
1572715744
"updated_by": 3122470302131,
1572815745
"created_at": 1742958482000,
15729-
"updated_at": 1772096392711
15746+
"updated_at": 1772096392711,
15747+
"links": {
15748+
"enabled": false,
15749+
"systems": []
15750+
}
1573015751
}
1573115752
]
1573215753
}
@@ -15828,7 +15849,24 @@
1582815849
"created_by": 4441703362131,
1582915850
"updated_by": 3790925372131,
1583015851
"created_at": 1746673831462,
15831-
"updated_at": 1773398630657
15852+
"updated_at": 1773398630657,
15853+
"links": {
15854+
"enabled": true,
15855+
"systems": [
15856+
{
15857+
"id": "s3-crash-logs",
15858+
"name": "S3 Crash Logs",
15859+
"icon_text": "S3",
15860+
"icon_color": "#0F766E",
15861+
"url": "https://s3.example.com/logs?app=${application_id}&trace=${trace_id}",
15862+
"event_types": [
15863+
"crash",
15864+
"error"
15865+
],
15866+
"enabled": true
15867+
}
15868+
]
15869+
}
1583215870
}
1583315871
}
1583415872
}
@@ -15928,7 +15966,11 @@
1592815966
"created_by": 2476444212131,
1592915967
"updated_by": 3122470302131,
1593015968
"created_at": 1742958482000,
15931-
"updated_at": 1772096392711
15969+
"updated_at": 1772096392711,
15970+
"links": {
15971+
"enabled": false,
15972+
"systems": []
15973+
}
1593215974
},
1593315975
{
1593415976
"account_id": 2451002751131,
@@ -15956,7 +15998,24 @@
1595615998
"created_by": 4441703362131,
1595715999
"updated_by": 3790925372131,
1595816000
"created_at": 1746673831462,
15959-
"updated_at": 1773398630657
16001+
"updated_at": 1773398630657,
16002+
"links": {
16003+
"enabled": true,
16004+
"systems": [
16005+
{
16006+
"id": "s3-crash-logs",
16007+
"name": "S3 Crash Logs",
16008+
"icon_text": "S3",
16009+
"icon_color": "#0F766E",
16010+
"url": "https://s3.example.com/logs?app=${application_id}&trace=${trace_id}",
16011+
"event_types": [
16012+
"crash",
16013+
"error"
16014+
],
16015+
"enabled": true
16016+
}
16017+
]
16018+
}
1596016019
}
1596116020
]
1596216021
}
@@ -16004,7 +16063,7 @@
1600416063
"RUM/Applications"
1600516064
],
1600616065
"x-mint": {
16007-
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Applications Manage** (`rum`) |\n\n## Usage\n\n- `type` must be one of: `browser`, `ios`, `android`, `react-native`, `flutter`, `kotlin-multiplatform`, `roku`, `unity`.\n- `client_token` is auto-generated and used to initialize the RUM SDK.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.",
16066+
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Applications Manage** (`rum`) |\n\n## Usage\n\n- `type` must be one of: `browser`, `ios`, `android`, `react-native`, `flutter`, `kotlin-multiplatform`, `roku`, `unity`.\n- `client_token` is auto-generated and used to initialize the RUM SDK.\n- `links.systems[].url` must start with `http` or `https`; `${var}` tokens are resolved from RUM event context.\n- `links.systems[].event_types` accepts: `crash`, `error`, `view`, `action`, `resource`, `session`, `all`.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.",
1600816067
"href": "/en/api-reference/rum/applications/rum-application-write-create",
1600916068
"metadata": {
1601016069
"sidebarTitle": "Create application"
@@ -16065,7 +16124,24 @@
1606516124
"application_name": "My Web App",
1606616125
"type": "browser",
1606716126
"team_id": 2477033058131,
16068-
"is_private": false
16127+
"is_private": false,
16128+
"links": {
16129+
"enabled": true,
16130+
"systems": [
16131+
{
16132+
"id": "s3-crash-logs",
16133+
"name": "S3 Crash Logs",
16134+
"icon_text": "S3",
16135+
"icon_color": "#0F766E",
16136+
"url": "https://s3.example.com/logs?app=${application_id}&trace=${trace_id}",
16137+
"event_types": [
16138+
"crash",
16139+
"error"
16140+
],
16141+
"enabled": true
16142+
}
16143+
]
16144+
}
1606916145
}
1607016146
}
1607116147
}
@@ -16081,7 +16157,7 @@
1608116157
"RUM/Applications"
1608216158
],
1608316159
"x-mint": {
16084-
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Applications Manage** (`rum`) |\n\n## Usage\n\n- Every call is recorded in the account audit log. Don't put secrets in request fields.",
16160+
"content": "## Restrictions\n\n| Aspect | Value |\n| ------ | ----- |\n| Rate limits | **1,000 requests/minute**; **50 requests/second** per account |\n| Permissions | **Applications Manage** (`rum`) |\n\n## Usage\n\n- `links.systems[].url` must start with `http` or `https`; `${var}` tokens are resolved from RUM event context.\n- `links.systems[].event_types` accepts: `crash`, `error`, `view`, `action`, `resource`, `session`, `all`.\n- Every call is recorded in the account audit log. Don't put secrets in request fields.",
1608516161
"href": "/en/api-reference/rum/applications/rum-application-write-update",
1608616162
"metadata": {
1608716163
"sidebarTitle": "Update application"
@@ -16142,6 +16218,23 @@
1614216218
"channel_ids": [
1614316219
2490121812131
1614416220
]
16221+
},
16222+
"links": {
16223+
"enabled": true,
16224+
"systems": [
16225+
{
16226+
"id": "s3-crash-logs",
16227+
"name": "S3 Crash Logs",
16228+
"icon_text": "S3",
16229+
"icon_color": "#0F766E",
16230+
"url": "https://s3.example.com/logs?app=${application_id}&trace=${trace_id}",
16231+
"event_types": [
16232+
"crash",
16233+
"error"
16234+
],
16235+
"enabled": true
16236+
}
16237+
]
1614516238
}
1614616239
}
1614716240
}
@@ -38645,6 +38738,79 @@
3864538738
}
3864638739
}
3864738740
},
38741+
"RumApplicationLink": {
38742+
"type": "object",
38743+
"description": "External system link rendered on matching RUM event detail pages.",
38744+
"required": [
38745+
"name",
38746+
"url",
38747+
"event_types"
38748+
],
38749+
"properties": {
38750+
"id": {
38751+
"type": "string",
38752+
"description": "Stable client-side identifier for this external system."
38753+
},
38754+
"name": {
38755+
"type": "string",
38756+
"description": "Display name of the external system."
38757+
},
38758+
"icon_text": {
38759+
"type": "string",
38760+
"description": "Short text shown in the link icon."
38761+
},
38762+
"icon_color": {
38763+
"type": "string",
38764+
"description": "Display color for the link icon."
38765+
},
38766+
"url": {
38767+
"type": "string",
38768+
"format": "uri",
38769+
"description": "HTTP or HTTPS URL template. `${var}` tokens are resolved from the RUM event context."
38770+
},
38771+
"event_types": {
38772+
"type": "array",
38773+
"minItems": 1,
38774+
"items": {
38775+
"type": "string",
38776+
"enum": [
38777+
"crash",
38778+
"error",
38779+
"view",
38780+
"action",
38781+
"resource",
38782+
"session",
38783+
"all"
38784+
]
38785+
},
38786+
"description": "RUM event types where this external system link is shown."
38787+
},
38788+
"enabled": {
38789+
"type": "boolean",
38790+
"description": "Whether this external system link is enabled."
38791+
}
38792+
}
38793+
},
38794+
"RumApplicationLinks": {
38795+
"type": "object",
38796+
"description": "External link integration settings for the application.",
38797+
"properties": {
38798+
"enabled": {
38799+
"type": "boolean",
38800+
"description": "Whether external link integration is enabled."
38801+
},
38802+
"systems": {
38803+
"type": [
38804+
"array",
38805+
"null"
38806+
],
38807+
"items": {
38808+
"$ref": "#/components/schemas/RumApplicationLink"
38809+
},
38810+
"description": "External systems whose URL templates can be opened from matching RUM events."
38811+
}
38812+
}
38813+
},
3864838814
"RumApplicationTracing": {
3864938815
"type": "object",
3865038816
"description": "APM tracing integration settings.",
@@ -38725,6 +38891,9 @@
3872538891
"tracing": {
3872638892
"$ref": "#/components/schemas/RumApplicationTracing"
3872738893
},
38894+
"links": {
38895+
"$ref": "#/components/schemas/RumApplicationLinks"
38896+
},
3872838897
"status": {
3872938898
"type": "string",
3873038899
"enum": [
@@ -38864,6 +39033,9 @@
3886439033
},
3886539034
"tracing": {
3886639035
"$ref": "#/components/schemas/RumApplicationTracing"
39036+
},
39037+
"links": {
39038+
"$ref": "#/components/schemas/RumApplicationLinks"
3886739039
}
3886839040
}
3886939041
},
@@ -38949,6 +39121,9 @@
3894939121
},
3895039122
"tracing": {
3895139123
"$ref": "#/components/schemas/RumApplicationTracing"
39124+
},
39125+
"links": {
39126+
"$ref": "#/components/schemas/RumApplicationLinks"
3895239127
}
3895339128
}
3895439129
},

0 commit comments

Comments
 (0)