Skip to content

Commit 0695923

Browse files
gewenyu99gitbook-bot
gewenyu99
authored and
gitbook-bot
committed
GITBOOK-735: No subject
1 parent 1056325 commit 0695923

File tree

4 files changed

+74
-54
lines changed

4 files changed

+74
-54
lines changed

Diff for: ‎.gitbook/assets/openapi.json

+71-47
Original file line numberDiff line numberDiff line change
@@ -31,39 +31,66 @@
3131
"type": "object",
3232
"properties": {
3333
"host": {
34-
"type": "string"
34+
"type": "string",
35+
"description": "The host of the repository. For example, `github.com` or `gitlab.com`. If self-hosting, this will be the hostname of your instance.",
36+
"examples": [
37+
"github.com",
38+
"gitlab.com",
39+
"github-enterprise.my-org-tld.com",
40+
"gitlab-enterprise.my-org-tld.com"
41+
]
3542
},
3643
"owner": {
37-
"type": "string"
44+
"type": "string",
45+
"description": "The owner of the repository. For example, `my-github-org` or `my-gitlab-org/my/sub/group`.",
46+
"examples": [
47+
"my-github-org",
48+
"my-gitlab-org/my/sub/group"
49+
]
3850
},
3951
"name": {
40-
"type": "string"
52+
"type": "string",
53+
"description": "The name of the repository.",
54+
"examples": [
55+
"my-repo"
56+
]
4157
}
4258
},
4359
"required": [
4460
"host",
4561
"owner",
4662
"name"
47-
]
63+
],
64+
"description": "The repository to list quarantined tests for."
4865
},
4966
"orgUrlSlug": {
50-
"type": "string"
67+
"type": "string",
68+
"description": "The slug of your organization. Find this at https://app.trunk.io/trunk/settings under \"Organization Name\" > \"Slug\"",
69+
"examples": [
70+
"my-trunk-org-slug"
71+
]
5172
},
5273
"pageQuery": {
5374
"type": "object",
5475
"properties": {
5576
"pageSize": {
5677
"type": "integer",
5778
"minimum": 1,
58-
"maximum": 100
79+
"maximum": 100,
80+
"description": "The number of tests to return per page."
5981
},
6082
"pageToken": {
61-
"type": "string"
83+
"type": "string",
84+
"description": "The page token to use for pagination. This is returned from the previous call to this endpoint. For the first page, this should be empty.",
85+
"examples": [
86+
""
87+
]
6288
}
6389
},
6490
"required": [
6591
"pageSize"
66-
]
92+
],
93+
"description": "Pagination options for the list of quarantined tests."
6794
}
6895
},
6996
"required": [
@@ -89,50 +116,58 @@
89116
"type": "object",
90117
"properties": {
91118
"name": {
92-
"type": "string"
119+
"type": "string",
120+
"description": "The name of the test case."
93121
},
94122
"parent": {
95123
"type": [
96124
"string",
97125
"null"
98-
]
126+
],
127+
"description": "The parent of the test case."
99128
},
100129
"file": {
101130
"type": [
102131
"string",
103132
"null"
104-
]
133+
],
134+
"description": "The file of the test case."
105135
},
106136
"class_name": {
107137
"type": [
108138
"string",
109139
"null"
110-
]
140+
],
141+
"description": "The class name of the test case."
111142
},
112143
"status": {
113144
"type": "string",
114145
"enum": [
115146
"HEALTHY",
116147
"FLAKY",
117148
"BROKEN"
118-
]
149+
],
150+
"description": "The status of the test case."
119151
},
120152
"code_owners": {
121153
"type": "array",
122154
"items": {
123155
"type": "string"
124-
}
156+
},
157+
"description": "The latest codeowners of the test case."
125158
},
126159
"quarantine_setting": {
127160
"type": "string",
128161
"enum": [
129162
"ALWAYS_QUARANTINE",
130163
"AUTO_QUARANTINE"
131-
]
164+
],
165+
"description": "The quarantine setting of the test case."
132166
},
133-
"last_updated_at": {
167+
"status_last_updated_at": {
134168
"type": "string",
135-
"format": "date-time"
169+
"format": "date-time",
170+
"description": "The last time the status of the test case was updated."
136171
}
137172
},
138173
"required": [
@@ -143,33 +178,41 @@
143178
"status",
144179
"code_owners",
145180
"quarantine_setting",
146-
"last_updated_at"
147-
]
148-
}
181+
"status_last_updated_at"
182+
],
183+
"description": "A quarantined test case."
184+
},
185+
"description": "A page of quarantined test cases."
149186
},
150187
"page": {
151188
"type": "object",
152189
"properties": {
153190
"total_rows": {
154191
"type": "integer",
155-
"exclusiveMinimum": 0
192+
"exclusiveMinimum": 0,
193+
"description": "The total number of quarantined test cases in the paginated list."
156194
},
157195
"total_pages": {
158196
"type": "integer",
159-
"exclusiveMinimum": 0
197+
"exclusiveMinimum": 0,
198+
"description": "The total number of pages in the paginated list of quarantined test cases."
160199
},
161200
"next_page_token": {
162-
"type": "string"
201+
"type": "string",
202+
"description": "The next page token to use for pagination. See `pageToken` in the request for more information."
163203
},
164204
"prev_page_token": {
165-
"type": "string"
205+
"type": "string",
206+
"description": "The previous page token to use for pagination. See `pageToken` in the request for more information."
166207
},
167208
"last_page_token": {
168-
"type": "string"
209+
"type": "string",
210+
"description": "The last page token to use for pagination. See `pageToken` in the request for more information."
169211
},
170212
"page_index": {
171213
"type": "integer",
172-
"exclusiveMinimum": 0
214+
"exclusiveMinimum": 0,
215+
"description": "The index of the current page in the paginated list of quarantined test cases."
173216
}
174217
},
175218
"required": [
@@ -179,7 +222,8 @@
179222
"prev_page_token",
180223
"last_page_token",
181224
"page_index"
182-
]
225+
],
226+
"description": "Pagination information for the list of quarantined test cases."
183227
}
184228
},
185229
"required": [
@@ -199,16 +243,6 @@
199243
}
200244
}
201245
}
202-
},
203-
"500": {
204-
"description": "Internal server error",
205-
"content": {
206-
"application/plain-text": {
207-
"schema": {
208-
"type": "string"
209-
}
210-
}
211-
}
212246
}
213247
}
214248
}
@@ -340,16 +374,6 @@
340374
}
341375
}
342376
}
343-
},
344-
"500": {
345-
"description": "Internal server error",
346-
"content": {
347-
"application/plain-text": {
348-
"schema": {
349-
"type": "string"
350-
}
351-
}
352-
}
353377
}
354378
}
355379
}

Diff for: ‎.gitbook/includes/monitoring-webhooks (1).md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
title: Monitoring Webhooks
33
---
44

5-
You can monitor the events and the webhook's delivery logs in the **Overview** tab of an endpoint configuration view. 
5+
You can monitor the events and the webhook's delivery logs in the **Overview** tab of an endpoint configuration view.
66

7-
You can see an overview of how many webhook deliveries have been attempted, how many are successful, how many are in-flight, and how many fail in the **Attempt Delivery Status** modal.
7+
You can see an overview of how many webhook deliveries have been attempted, how many are successful, how many are in flight, and how many fail in the **Attempt Delivery Status** modal.
88

99
<figure><img src="../assets/example-webhook-delivery-status.png" alt=""><figcaption></figcaption></figure>
1010

Diff for: ‎apis/flaky-tests.md

-4
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ The Trunk Flaky Tests API provides access to check the status of Trunk services
44

55
All requests must be [authenticated](./#authentication) by providing the `x-api-token` header.
66

7-
{% openapi src="../.gitbook/assets/openapi.json" path="/status" method="get" %}
8-
[openapi.json](../.gitbook/assets/openapi.json)
9-
{% endopenapi %}
10-
117
{% openapi src="../.gitbook/assets/openapi.json" path="/flaky-tests/list-quarantined-tests" method="post" %}
128
[openapi.json](../.gitbook/assets/openapi.json)
139
{% endopenapi %}

Diff for: ‎apis/readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Trunk provides HTTP REST APIs for several of our products. The APIs use status c
1010

1111
## Available APIs
1212

13-
* Flaky Tests: for accessing information like quarantined tests in your repo.
13+
* [Flaky Tests](flaky-tests.md): for accessing information like quarantined tests in your repo.
1414
* [Merge API](merge.md) : for controlling the Trunk Merge Queue
1515
* [CI Analytics API](../ci-analytics/setup/api.md): for submitting events to be tracked by the CI Analytics engine.
1616

0 commit comments

Comments
 (0)