Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate all endpoints under the /acs/systems route #297

Closed
wants to merge 22 commits into from
Closed

Generate all endpoints under the /acs/systems route #297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
af27f39
Update blueprint to 0.11.3
andrii-balitskyi Aug 8, 2024
6b3f956
Generate api reference for /acs/systems route endpoints
andrii-balitskyi Aug 8, 2024
eb94148
Update blueprint registry url
andrii-balitskyi Aug 8, 2024
ce67eb1
Remove leading whitespaces from api-reference layout
andrii-balitskyi Aug 8, 2024
f2c08dd
Add api resource layout
andrii-balitskyi Aug 8, 2024
f6d18f3
Add setApiResourceTemplateContext and use it to set context for resou…
andrii-balitskyi Aug 8, 2024
863f9bf
Generate acs system resource page
andrii-balitskyi Aug 8, 2024
de937be
Correct systems/README.md path
andrii-balitskyi Aug 9, 2024
c1c1dc7
Try tripple curly braces
andrii-balitskyi Aug 9, 2024
2e16d3a
Remove .md extension from links
andrii-balitskyi Aug 9, 2024
928c740
Keep base url of link
andrii-balitskyi Aug 9, 2024
4e8241f
Wrap link in 'a' tag
andrii-balitskyi Aug 9, 2024
928f9ea
Use full link in href
andrii-balitskyi Aug 9, 2024
a50bc42
Add data-internal-link attribute
andrii-balitskyi Aug 9, 2024
5703570
Revert postprocess
andrii-balitskyi Aug 9, 2024
d84d47f
Update src/lib/reference.ts
andrii-balitskyi Aug 19, 2024
d27468c
ci: Generate docs
seambot Aug 19, 2024
2381d39
Revert docs/api-clients/access-control-systems/systems/README.md
andrii-balitskyi Aug 19, 2024
38dd709
Remove response properties
andrii-balitskyi Aug 21, 2024
ba7db02
ci: Generate docs
seambot Aug 21, 2024
508cf4a
Support setting context for multiple route resources
andrii-balitskyi Aug 21, 2024
980053e
Disable esling for warning console log lines
andrii-balitskyi Aug 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
224 changes: 224 additions & 0 deletions docs/api/acs/systems/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,224 @@
<header>
<h1>acs_system</h1>
</header>

<hr>

<header>
<h3>acs_system_id</h3>
</header>
<div>
<p>ID of the `acs_system`.</p>
<div>
<span>Format:</span>
<span>string</span>
</div>
</div>

<hr>
<header>
<h3>can_add_acs_users_to_acs_access_groups</h3>
</header>
<div>
<p>Indicates whether the `acs_system` supports [adding users to access groups](../../../capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group.md). See also [Access Group-based Access Control Systems](../../../capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems.md).</p>
<div>
<span>Format:</span>
<span>boolean</span>
</div>
</div>

<hr>
<header>
<h3>can_automate_enrollment</h3>
</header>
<div>
<p>Indicates whether it is possible to [launch enrollment automations](../../../capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut.md) for the `acs_system`.</p>
<div>
<span>Format:</span>
<span>boolean</span>
</div>
</div>

<hr>
<header>
<h3>can_create_acs_access_groups</h3>
</header>
<div>
<p>Indicates whether the `acs_system` supports creating [access groups](../../../capability-guides/access-systems/assigning-users-to-access-groups.md). See also [Access Group-based Access Control Systems](../../../capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems.md).</p>
<div>
<span>Format:</span>
<span>boolean</span>
</div>
</div>

<hr>
<header>
<h3>can_remove_acs_users_from_acs_access_groups</h3>
</header>
<div>
<p>Indicates whether the `acs_system` supports [removing users from access groups](../../../capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group.md). See also [Access Group-based Access Control Systems](../../../capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems.md).</p>
<div>
<span>Format:</span>
<span>boolean</span>
</div>
</div>

<hr>
<header>
<h3>connected_account_ids</h3>
</header>
<div>
<p>IDs of the [connected accounts](../../../core-concepts/connected-accounts.md) associated with the `acs_system`.</p>
<div>
<span>Format:</span>
<span>list</span>
</div>
</div>

<hr>
<header>
<h3>created_at</h3>
</header>
<div>
<p>Date and time at which the `acs_system` was created.</p>
<div>
<span>Format:</span>
<span>string</span>
</div>
</div>

<hr>
<header>
<h3>errors</h3>
</header>
<div>
<p>Errors associated with the `acs_system`.</p>
<div>
<span>Format:</span>
<span>list</span>
</div>
</div>

<hr>
<header>
<h3>external_type</h3>
</header>
<div>
<p>Brand-specific terminology for the `acs_system` type.</p>
<div>
<span>Format:</span>
<span>enum</span>
</div>
</div>

<hr>
<header>
<h3>external_type_display_name</h3>
</header>
<div>
<p>Display name that corresponds to the brand-specific terminology for the `acs_system` type.</p>
<div>
<span>Format:</span>
<span>string</span>
</div>
</div>

<hr>
<header>
<h3>image_alt_text</h3>
</header>
<div>
<p>Alternative text for the `acs_system` image.</p>
<div>
<span>Format:</span>
<span>string</span>
</div>
</div>

<hr>
<header>
<h3>image_url</h3>
</header>
<div>
<p>URL for the image that represents the `acs_system`.</p>
<div>
<span>Format:</span>
<span>string</span>
</div>
</div>

<hr>
<header>
<h3>name</h3>
</header>
<div>
<p>Name of the `acs_system`.</p>
<div>
<span>Format:</span>
<span>string</span>
</div>
</div>

<hr>
<header>
<h3>system_type</h3>
</header>
<div>
<p></p>
<div>
<span>Format:</span>
<span>enum</span>
</div>
<p>This property is deprecated.</p>
</div>

<hr>
<header>
<h3>system_type_display_name</h3>
</header>
<div>
<p></p>
<div>
<span>Format:</span>
<span>string</span>
</div>
<p>This property is deprecated.</p>
</div>

<hr>
<header>
<h3>visionline_metadata</h3>
</header>
<div>
<p></p>
<div>
<span>Format:</span>
<span>record</span>
</div>
</div>

<hr>
<header>
<h3>warnings</h3>
</header>
<div>
<p></p>
<div>
<span>Format:</span>
<span>list</span>
</div>
</div>

<hr>
<header>
<h3>workspace_id</h3>
</header>
<div>
<p>ID of the [workspace](../../../core-concepts/workspaces.md) that contains the `acs_system`.</p>
<div>
<span>Format:</span>
<span>string</span>
</div>
</div>

<hr>
25 changes: 25 additions & 0 deletions docs/api/acs/systems/get.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
#




### Request Parameters

**acs_system_id**
*Type:* ``
*Required:* Yes



### Response Properties


## Samples

{% tabs %}
{% tab title="No samples available" %}
```
No sample requests available.
```
{% endtab %}
{% endtabs %}
58 changes: 17 additions & 41 deletions docs/api/acs/systems/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,50 +9,14 @@ response includes all access control systems connected to your workspace.

### Request Parameters

**connected_account_id**
*Type:* ``
*Required:* No
**connected_account_id**
*Type:* ``
*Required:* No

ID of the connected account by which to filter the list of returned access control systems.
ID of the connected account by which to filter the list of returned access control systems.

### Response Properties

**acs_system_id**
ID of the `acs_system`.
**can_add_acs_users_to_acs_access_groups**
Indicates whether the `acs_system` supports [adding users to access groups](../../../capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group.md). See also [Access Group-based Access Control Systems](../../../capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems.md).
**can_automate_enrollment**
Indicates whether it is possible to [launch enrollment automations](../../../capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut.md) for the `acs_system`.
**can_create_acs_access_groups**
Indicates whether the `acs_system` supports creating [access groups](../../../capability-guides/access-systems/assigning-users-to-access-groups.md). See also [Access Group-based Access Control Systems](../../../capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems.md).
**can_remove_acs_users_from_acs_access_groups**
Indicates whether the `acs_system` supports [removing users from access groups](../../../capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group.md). See also [Access Group-based Access Control Systems](../../../capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems.md).
**connected_account_ids**
IDs of the [connected accounts](../../../core-concepts/connected-accounts.md) associated with the `acs_system`.
**created_at**
Date and time at which the `acs_system` was created.
**errors**
Errors associated with the `acs_system`.
**external_type**
Brand-specific terminology for the `acs_system` type.
**external_type_display_name**
Display name that corresponds to the brand-specific terminology for the `acs_system` type.
**image_alt_text**
Alternative text for the `acs_system` image.
**image_url**
URL for the image that represents the `acs_system`.
**name**
Name of the `acs_system`.
**system_type**

**system_type_display_name**

**visionline_metadata**

**warnings**

**workspace_id**
ID of the [workspace](../../../core-concepts/workspaces.md) that contains the `acs_system`.

## Samples

Expand All @@ -76,7 +40,19 @@ ID of the [workspace](../../../core-concepts/workspaces.md) that contains the `a

### Response
```python
AcsSystems(0={"acs_system_id":"8d7e0b3a-b889-49a7-9164-4b71a0506a33"})
[AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")]
```
{% endtab %}
{% tab title="Ruby" %}
### Request
```ruby
seam.acs.systems.list(connected_account_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33")
```

### Response
```ruby
[<Seam::AcsSystems:0x00000
acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33">]
```
{% endtab %}
{% tab title="PHP" %}
Expand Down
25 changes: 25 additions & 0 deletions docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
#




### Request Parameters

**acs_system_id**
*Type:* ``
*Required:* Yes



### Response Properties


## Samples

{% tabs %}
{% tab title="No samples available" %}
```
No sample requests available.
```
{% endtab %}
{% endtabs %}
3 changes: 3 additions & 0 deletions docs/sdk/javascript/acs/systems/get.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#


3 changes: 3 additions & 0 deletions docs/sdk/javascript/acs/systems/list_compatible_credential_manager_acs_systems.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#


9 changes: 5 additions & 4 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"dependencies": {
"@metalsmith/layouts": "^2.7.0",
"@metalsmith/metadata": "^0.3.0",
"@seamapi/blueprint": "^0.8.3",
"@seamapi/blueprint": "^0.11.3",
"jstransformer-handlebars": "^1.2.0",
"metalsmith": "^2.6.3"
},
Expand Down
Loading