Skip to content

Commit f1b6f71

Browse files
razor-xseambot
andauthored
Render response type in success hint (#971)
* Render response type in success hint * ci: Generate docs * Fix formatting for response returns in api-endpoint.hbs * ci: Generate docs --------- Co-authored-by: Seam Bot <[email protected]>
1 parent 9ef1bff commit f1b6f71

File tree

192 files changed

+960
-192
lines changed

Some content is hidden

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

192 files changed

+960
-192
lines changed

codegen/layouts/api-endpoint.hbs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,11 @@ None
7373
7474
## Response
7575
76-
{{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array of [{{response.escapedResourceType}}s]({{#if response.responsePath}}{{response.responsePath}}{{else}}./{{/if}}){{else}}[{{response.escapedResourceType}}]({{#if response.responsePath}}{{response.responsePath}}{{else}}./{{/if}}){{/if}}{{else}}void{{/if}}
76+
{% hint style="success" %}
77+
Returns:
78+
**{{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array of [{{response.escapedResourceType}}s]({{#if response.responsePath}}{{response.responsePath}}{{else}}./{{/if}}){{else}}[{{response.escapedResourceType}}]({{#if response.responsePath}}{{response.responsePath}}{{else}}./{{/if}}){{/if}}{{else}}void{{/if}}**
79+
80+
{% endhint %}
7781
7882
{{#if resourceSamples.length}}
7983

docs/api/access_codes/create.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,11 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest
384384

385385
## Response
386386

387-
[access\_code](.)
387+
{% hint style="success" %}
388+
Returns:
389+
**[access\_code](.)**
390+
391+
{% endhint %}
388392

389393

390394
{% tabs %}

docs/api/access_codes/create_multiple.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,11 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest
443443

444444
## Response
445445

446-
Array of [access\_codes](.)
446+
{% hint style="success" %}
447+
Returns:
448+
**Array of [access\_codes](.)**
449+
450+
{% endhint %}
447451

448452

449453
{% tabs %}

docs/api/access_codes/delete.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,5 +160,9 @@ ID of the device for which you want to delete the access code.
160160

161161
## Response
162162

163-
void
163+
{% hint style="success" %}
164+
Returns:
165+
**void**
166+
167+
{% endhint %}
164168

docs/api/access_codes/generate_code.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,11 @@ ID of the device for which you want to generate a code.
150150

151151
## Response
152152

153-
[access\_code](.)
153+
{% hint style="success" %}
154+
Returns:
155+
**[access\_code](.)**
156+
157+
{% endhint %}
154158

155159

156160
{% tabs %}

docs/api/access_codes/get.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,11 @@ ID of the device containing the access code that you want to get. You must speci
297297

298298
## Response
299299

300-
[access\_code](.)
300+
{% hint style="success" %}
301+
Returns:
302+
**[access\_code](.)**
303+
304+
{% endhint %}
301305

302306

303307
{% tabs %}

docs/api/access_codes/list.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,11 @@ Your user ID for the user by which to filter access codes.
332332

333333
## Response
334334

335-
Array of [access\_codes](.)
335+
{% hint style="success" %}
336+
Returns:
337+
**Array of [access\_codes](.)**
338+
339+
{% endhint %}
336340

337341

338342
{% tabs %}

docs/api/access_codes/pull_backup_access_code.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,11 @@ ID of the access code for which you want to pull a backup access code.
295295

296296
## Response
297297

298-
[access\_code](.)
298+
{% hint style="success" %}
299+
Returns:
300+
**[access\_code](.)**
301+
302+
{% endhint %}
299303

300304

301305
{% tabs %}

docs/api/access_codes/report_device_constraints.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,11 @@ Array of supported code lengths as integers between 4 and 20, inclusive. You can
189189

190190
## Response
191191

192-
void
192+
{% hint style="success" %}
193+
Returns:
194+
**void**
195+
196+
{% endhint %}
193197

194198

195199
---

docs/api/access_codes/simulate/create_unmanaged_access_code.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,11 @@ Name of the simulated unmanaged access code.
255255

256256
## Response
257257

258-
[unmanaged\_access\_code](./../unmanaged)
258+
{% hint style="success" %}
259+
Returns:
260+
**[unmanaged\_access\_code](./../unmanaged)**
261+
262+
{% endhint %}
259263

260264

261265
{% tabs %}

0 commit comments

Comments
 (0)