Skip to content

Commit 35a34f3

Browse files
committed
Strip markdown from desc.
1 parent 860ab16 commit 35a34f3

File tree

142 files changed

+306
-268
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

142 files changed

+306
-268
lines changed

.rubocop_todo.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# This configuration was generated by
22
# `rubocop --auto-gen-config`
3-
# on 2025-09-06 23:06:24 UTC using RuboCop version 1.80.2.
3+
# on 2025-09-06 23:33:08 UTC using RuboCop version 1.80.2.
44
# The point is for the user to remove these configuration records
55
# one by one as the offenses are removed from the code base.
66
# Note that changes in the inspected code, or installation of new
@@ -9,7 +9,7 @@
99
# Offense count: 3
1010
# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
1111
Metrics/AbcSize:
12-
Max: 49
12+
Max: 50
1313

1414
# Offense count: 1
1515
# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
@@ -20,7 +20,7 @@ Metrics/BlockLength:
2020
# Offense count: 1
2121
# Configuration parameters: CountComments, CountAsOne.
2222
Metrics/ClassLength:
23-
Max: 115
23+
Max: 127
2424

2525
# Offense count: 2
2626
# Configuration parameters: AllowedMethods, AllowedPatterns.

methods/admin/admin.analytics.getFile.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@
77
"date": {
88
"required": false,
99
"example": "2020-09-01",
10-
"desc": "Date to retrieve the analytics data for, expressed as `YYYY-MM-DD` in UTC. Required unless `metadata_only` is set to true.",
10+
"desc": "Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC. Required unless metadata_only is set to true.",
1111
"type": "date"
1212
},
1313
"metadata_only": {
1414
"required": false,
1515
"example": "true",
16-
"desc": "Retrieve metadata for the `type` of analytics indicated. Can be used only with `type` set to `public_channel` analytics. See [detail below](#metadata_only). Omit the `date` parameter when using this argument.",
16+
"desc": "Retrieve metadata for the type of analytics indicated. Can be used only with type set to public_channel analytics. See detail below. Omit the date parameter when using this argument.",
1717
"type": "boolean"
1818
},
1919
"type": {
2020
"required": true,
2121
"example": "member",
22-
"desc": "The type of analytics to retrieve. The options are currently limited to `member` (for Enterprise org member analytics) and `public_channel` (for public channel analytics).",
22+
"desc": "The type of analytics to retrieve. The options are currently limited to member (for Enterprise org member analytics) and public_channel (for public channel analytics).",
2323
"type": "string"
2424
}
2525
},

methods/admin/admin.apps.activities.list.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,19 @@
1212
"component_id": {
1313
"required": false,
1414
"example": "Wf013SMGL4V9",
15-
"desc": "The component ID of log events to be returned. Will be `FnXXXXXX` for functions, and `WfXXXXXX` for workflows.",
15+
"desc": "The component ID of log events to be returned. Will be FnXXXXXX for functions, and WfXXXXXX for workflows.",
1616
"type": "string"
1717
},
1818
"component_type": {
1919
"required": false,
2020
"example": "workflows",
21-
"desc": "The component type of log events to be returned. Acceptable values are `events_api`, `workflows`, `functions` and `tables`.",
21+
"desc": "The component type of log events to be returned. Acceptable values are events_api, workflows, functions and tables.",
2222
"type": "string"
2323
},
2424
"cursor": {
2525
"required": false,
2626
"example": "bG9nX2lkOjc5NjQ1NA==",
27-
"desc": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. See [pagination](/apis/web-api/pagination) for more detail.",
27+
"desc": "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. See pagination for more detail.",
2828
"type": "string"
2929
},
3030
"limit": {
@@ -54,7 +54,7 @@
5454
"min_log_level": {
5555
"required": false,
5656
"example": "info",
57-
"desc": "The minimum log level of the log events to be returned. Defaults to `info`. Acceptable values (in order of relative importance from smallest to largest) are `trace`, `debug`, `info`, `warn`, `error` and `fatal`.",
57+
"desc": "The minimum log level of the log events to be returned. Defaults to info. Acceptable values (in order of relative importance from smallest to largest) are trace, debug, info, warn, error and fatal.",
5858
"type": "string"
5959
},
6060
"sort_direction": {
@@ -66,7 +66,7 @@
6666
"source": {
6767
"required": false,
6868
"example": "slack",
69-
"desc": "The source of log events to be returned. Acceptable values are `slack` and `developer`.",
69+
"desc": "The source of log events to be returned. Acceptable values are slack and developer.",
7070
"type": "string"
7171
},
7272
"team_id": {

methods/admin/admin.apps.approved.list.json

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,13 @@
1313
"cursor": {
1414
"required": false,
1515
"example": "5c3e53d5",
16-
"desc": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.",
16+
"desc": "Set cursor to next_cursor returned by the previous call to list items in the next page.",
1717
"type": "string"
1818
},
1919
"enterprise_id": {
2020
"required": false,
21-
"example": "E0AS553RN"
21+
"example": "E0AS553RN",
22+
"desc": ""
2223
},
2324
"limit": {
2425
"required": false,
@@ -28,7 +29,8 @@
2829
},
2930
"team_id": {
3031
"required": false,
31-
"example": "T0HFE6EBT"
32+
"example": "T0HFE6EBT",
33+
"desc": ""
3234
}
3335
},
3436
"response": {

methods/admin/admin.apps.config.set.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
},
1212
"domain_restrictions": {
1313
"required": false,
14-
"desc": "Domain restrictions for the app. Should be an object with two properties: `urls` and `emails`. Each is an array of strings, and each sets the allowed URLs and emails for connector authorization, respectively.",
14+
"desc": "Domain restrictions for the app. Should be an object with two properties: urls and emails. Each is an array of strings, and each sets the allowed URLs and emails for connector authorization, respectively.",
1515
"type": "object"
1616
},
1717
"rich_link_preview_type": {
@@ -21,7 +21,7 @@
2121
},
2222
"workflow_auth_strategy": {
2323
"required": false,
24-
"desc": "The workflow auth permission. Can be one of `builder_choice` or `end_user_only`.",
24+
"desc": "The workflow auth permission. Can be one of builder_choice or end_user_only.",
2525
"type": "enum"
2626
}
2727
},

methods/admin/admin.apps.requests.list.json

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,12 @@
1313
"cursor": {
1414
"required": false,
1515
"example": "5c3e53d5",
16-
"desc": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.",
16+
"desc": "Set cursor to next_cursor returned by the previous call to list items in the next page.",
1717
"type": "string"
1818
},
1919
"enterprise_id": {
20-
"required": false
20+
"required": false,
21+
"desc": ""
2122
},
2223
"limit": {
2324
"required": false,
@@ -26,7 +27,8 @@
2627
"type": "integer"
2728
},
2829
"team_id": {
29-
"required": false
30+
"required": false,
31+
"desc": ""
3032
}
3133
},
3234
"response": {

methods/admin/admin.apps.restricted.list.json

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,13 @@
1212
"cursor": {
1313
"required": false,
1414
"example": "5c3e53d5",
15-
"desc": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.",
15+
"desc": "Set cursor to next_cursor returned by the previous call to list items in the next page.",
1616
"type": "string"
1717
},
1818
"enterprise_id": {
1919
"required": false,
20-
"example": "E0AS553RN"
20+
"example": "E0AS553RN",
21+
"desc": ""
2122
},
2223
"limit": {
2324
"required": false,
@@ -27,7 +28,8 @@
2728
},
2829
"team_id": {
2930
"required": false,
30-
"example": "T0HFE6EBT"
31+
"example": "T0HFE6EBT",
32+
"desc": ""
3133
}
3234
},
3335
"response": {

methods/admin/admin.apps.uninstall.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@
1313
"enterprise_id": {
1414
"required": false,
1515
"example": "E12345",
16-
"desc": "The enterprise to completely uninstall the application from (across all workspaces). With an org-level token, this or `team_ids` is required.",
16+
"desc": "The enterprise to completely uninstall the application from (across all workspaces). With an org-level token, this or team_ids is required.",
1717
"type": "string"
1818
},
1919
"team_ids": {
2020
"required": false,
21-
"desc": "IDs of the teams to uninstall from (max 100). With an org-level token, this or `enterprise_id` is required.",
21+
"desc": "IDs of the teams to uninstall from (max 100). With an org-level token, this or enterprise_id is required.",
2222
"type": "string"
2323
}
2424
},

methods/admin/admin.auth.policy.assignEntities.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@
1212
},
1313
"entity_type": {
1414
"required": true,
15-
"desc": "The type of entity to assign to the policy. Currently, `USER` is supported."
15+
"desc": "The type of entity to assign to the policy. Currently, USER is supported."
1616
},
1717
"policy_name": {
1818
"required": true,
1919
"example": "email_password",
20-
"desc": "The name of the authentication policy to assign the entities to. Currently, `email_password` is the only policy that may be used with this method.",
20+
"desc": "The name of the authentication policy to assign the entities to. Currently, email_password is the only policy that may be used with this method.",
2121
"type": "string"
2222
}
2323
},

methods/admin/admin.auth.policy.getEntities.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77
"cursor": {
88
"required": false,
99
"example": "5c3e53d5",
10-
"desc": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.",
10+
"desc": "Set cursor to next_cursor returned by the previous call to list items in the next page.",
1111
"type": "string"
1212
},
1313
"entity_type": {
1414
"required": false,
15-
"desc": "The type of entity to assign to the policy. Currently, `USER` is supported."
15+
"desc": "The type of entity to assign to the policy. Currently, USER is supported."
1616
},
1717
"limit": {
1818
"required": false,
@@ -23,7 +23,7 @@
2323
"policy_name": {
2424
"required": true,
2525
"example": "email_password",
26-
"desc": "The name of the policy to fetch entities for. Currently, `email_password` is the only policy that may be used with this method.",
26+
"desc": "The name of the policy to fetch entities for. Currently, email_password is the only policy that may be used with this method.",
2727
"type": "string"
2828
}
2929
},

0 commit comments

Comments
 (0)