Skip to content

Commit 776fc6a

Browse files
seambotseambot
committed
ci: Generate docs
1 parent cb3e679 commit 776fc6a

63 files changed

Lines changed: 570 additions & 314 deletions

Some content is hidden

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

‎docs/api/_blueprint.json‎

Lines changed: 66 additions & 66 deletions
Large diffs are not rendered by default.

‎docs/api/acs/access_groups/add_user.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -167,10 +167,14 @@ nil
167167
#### Code
168168

169169
```curl
170-
curl -X POST "https://connect.getseam.com/acs/access_groups/add_user" \
171-
-H "Authorization: Bearer $SEAM_API_KEY" \
172-
-H "Content-Type: application/json" \
173-
-d '{"acs_access_group_id":"44444444-4444-4444-4444-444444444444","acs_user_id":"33333333-3333-3333-3333-333333333333"}'
170+
curl --include --request POST "https://connect.getseam.com/acs/access_groups/add_user" \
171+
--header "Authorization: Bearer $SEAM_API_KEY" \
172+
--json @- <<EOF
173+
{
174+
"acs_access_group_id": "44444444-4444-4444-4444-444444444444",
175+
"acs_user_id": "33333333-3333-3333-3333-333333333333"
176+
}
177+
EOF
174178
```
175179

176180
#### Output

‎docs/api/acs/access_groups/get.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -217,10 +217,13 @@ api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Nam
217217
#### Code
218218

219219
```curl
220-
curl -X POST "https://connect.getseam.com/acs/access_groups/get" \
221-
-H "Authorization: Bearer $SEAM_API_KEY" \
222-
-H "Content-Type: application/json" \
223-
-d '{"acs_access_group_id":"44444444-4444-4444-4444-444444444444"}'
220+
curl --include --request POST "https://connect.getseam.com/acs/access_groups/get" \
221+
--header "Authorization: Bearer $SEAM_API_KEY" \
222+
--json @- <<EOF
223+
{
224+
"acs_access_group_id": "44444444-4444-4444-4444-444444444444"
225+
}
226+
EOF
224227
```
225228

226229
#### Output

‎docs/api/acs/access_groups/list.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -248,10 +248,14 @@ func main() {
248248
#### Code
249249

250250
```curl
251-
curl -X POST "https://connect.getseam.com/acs/access_groups/list" \
252-
-H "Authorization: Bearer $SEAM_API_KEY" \
253-
-H "Content-Type: application/json" \
254-
-d '{"acs_system_id":"11111111-1111-1111-1111-111111111111","acs_user_id":"33333333-3333-3333-3333-333333333333"}'
251+
curl --include --request POST "https://connect.getseam.com/acs/access_groups/list" \
252+
--header "Authorization: Bearer $SEAM_API_KEY" \
253+
--json @- <<EOF
254+
{
255+
"acs_system_id": "11111111-1111-1111-1111-111111111111",
256+
"acs_user_id": "33333333-3333-3333-3333-333333333333"
257+
}
258+
EOF
255259
```
256260

257261
#### Output

‎docs/api/acs/access_groups/list_accessible_entrances.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -211,10 +211,13 @@ func main() {
211211
#### Code
212212

213213
```curl
214-
curl -X POST "https://connect.getseam.com/acs/access_groups/list_accessible_entrances" \
215-
-H "Authorization: Bearer $SEAM_API_KEY" \
216-
-H "Content-Type: application/json" \
217-
-d '{"acs_access_group_id":"44444444-4444-4444-4444-444444444444"}'
214+
curl --include --request POST "https://connect.getseam.com/acs/access_groups/list_accessible_entrances" \
215+
--header "Authorization: Bearer $SEAM_API_KEY" \
216+
--json @- <<EOF
217+
{
218+
"acs_access_group_id": "44444444-4444-4444-4444-444444444444"
219+
}
220+
EOF
218221
```
219222

220223
#### Output

‎docs/api/acs/access_groups/list_users.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -269,10 +269,13 @@ func main() {
269269
#### Code
270270

271271
```curl
272-
curl -X POST "https://connect.getseam.com/acs/access_groups/list_users" \
273-
-H "Authorization: Bearer $SEAM_API_KEY" \
274-
-H "Content-Type: application/json" \
275-
-d '{"acs_access_group_id":"44444444-4444-4444-4444-444444444444"}'
272+
curl --include --request POST "https://connect.getseam.com/acs/access_groups/list_users" \
273+
--header "Authorization: Bearer $SEAM_API_KEY" \
274+
--json @- <<EOF
275+
{
276+
"acs_access_group_id": "44444444-4444-4444-4444-444444444444"
277+
}
278+
EOF
276279
```
277280

278281
#### Output

‎docs/api/acs/access_groups/remove_user.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,10 +173,14 @@ nil
173173
#### Code
174174

175175
```curl
176-
curl -X POST "https://connect.getseam.com/acs/access_groups/remove_user" \
177-
-H "Authorization: Bearer $SEAM_API_KEY" \
178-
-H "Content-Type: application/json" \
179-
-d '{"acs_access_group_id":"44444444-4444-4444-4444-444444444444","acs_user_id":"33333333-3333-3333-3333-333333333333"}'
176+
curl --include --request POST "https://connect.getseam.com/acs/access_groups/remove_user" \
177+
--header "Authorization: Bearer $SEAM_API_KEY" \
178+
--json @- <<EOF
179+
{
180+
"acs_access_group_id": "44444444-4444-4444-4444-444444444444",
181+
"acs_user_id": "33333333-3333-3333-3333-333333333333"
182+
}
183+
EOF
180184
```
181185

182186
#### Output

‎docs/api/acs/credentials/assign.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -167,10 +167,14 @@ nil
167167
#### Code
168168

169169
```curl
170-
curl -X POST "https://connect.getseam.com/acs/credentials/assign" \
171-
-H "Authorization: Bearer $SEAM_API_KEY" \
172-
-H "Content-Type: application/json" \
173-
-d '{"acs_user_id":"33333333-3333-3333-3333-333333333333","acs_credential_id":"66666666-6666-6666-6666-666666666666"}'
170+
curl --include --request POST "https://connect.getseam.com/acs/credentials/assign" \
171+
--header "Authorization: Bearer $SEAM_API_KEY" \
172+
--json @- <<EOF
173+
{
174+
"acs_user_id": "33333333-3333-3333-3333-333333333333",
175+
"acs_credential_id": "66666666-6666-6666-6666-666666666666"
176+
}
177+
EOF
174178
```
175179

176180
#### Output

‎docs/api/acs/credentials/create.md‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -330,10 +330,22 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs
330330
#### Code
331331

332332
```curl
333-
curl -X POST "https://connect.getseam.com/acs/credentials/create" \
334-
-H "Authorization: Bearer $SEAM_API_KEY" \
335-
-H "Content-Type: application/json" \
336-
-d '{"acs_user_id":"33333333-3333-3333-3333-333333333333","access_method":"mobile_key","allowed_acs_entrance_ids":["55555555-5555-5555-5555-555555555555","55555555-5555-5555-5555-000000000000"],"credential_manager_acs_system_id":"88888888-8888-8888-8888-888888888888","is_multi_phone_sync_credential":true,"starts_at":"2024-03-01T10:40:00Z","ends_at":"2024-03-04T10:40:00Z"}'
333+
curl --include --request POST "https://connect.getseam.com/acs/credentials/create" \
334+
--header "Authorization: Bearer $SEAM_API_KEY" \
335+
--json @- <<EOF
336+
{
337+
"acs_user_id": "33333333-3333-3333-3333-333333333333",
338+
"access_method": "mobile_key",
339+
"allowed_acs_entrance_ids": [
340+
"55555555-5555-5555-5555-555555555555",
341+
"55555555-5555-5555-5555-000000000000"
342+
],
343+
"credential_manager_acs_system_id": "88888888-8888-8888-8888-888888888888",
344+
"is_multi_phone_sync_credential": true,
345+
"starts_at": "2024-03-01T10:40:00Z",
346+
"ends_at": "2024-03-04T10:40:00Z"
347+
}
348+
EOF
337349
```
338350

339351
#### Output

‎docs/api/acs/credentials/delete.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -152,10 +152,13 @@ nil
152152
#### Code
153153

154154
```curl
155-
curl -X POST "https://connect.getseam.com/acs/credentials/delete" \
156-
-H "Authorization: Bearer $SEAM_API_KEY" \
157-
-H "Content-Type: application/json" \
158-
-d '{"acs_credential_id":"66666666-6666-6666-6666-666666666666"}'
155+
curl --include --request POST "https://connect.getseam.com/acs/credentials/delete" \
156+
--header "Authorization: Bearer $SEAM_API_KEY" \
157+
--json @- <<EOF
158+
{
159+
"acs_credential_id": "66666666-6666-6666-6666-666666666666"
160+
}
161+
EOF
159162
```
160163

161164
#### Output

0 commit comments

Comments
 (0)