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.

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

Page templates improvements #318

Merged
merged 23 commits into from
Aug 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
2b8e472
Change property details order and add line break between type and for…
andrii-balitskyi Aug 26, 2024
1759bb2
Capitalize boolean type
andrii-balitskyi Aug 26, 2024
573c9d1
Fix resource property deprecation message and format
andrii-balitskyi Aug 26, 2024
d6bd7ea
Un-italicize return type, add line break btw type and required in api…
andrii-balitskyi Aug 26, 2024
2dd3b8b
REmove italic text from api-reference.hbs
andrii-balitskyi Aug 26, 2024
14c6ac1
Make return type a heading parallel to request params in api-referenc…
andrii-balitskyi Aug 26, 2024
0ecf6be
Bump blueprint to 0.14.2
andrii-balitskyi Aug 26, 2024
5e772f4
ci: Generate docs
seambot Aug 26, 2024
441b4de
Add resource description
andrii-balitskyi Aug 26, 2024
3400185
Remove type from api-route page, use capitalized format only
andrii-balitskyi Aug 27, 2024
175280c
Add "Properties" header after resource name in api-route layout
andrii-balitskyi Aug 27, 2024
235b51d
Decrease all heading levels by one in api-route.hbs
andrii-balitskyi Aug 27, 2024
f2c2a24
Endpoints section includes only first paragraph from the endpoint des…
andrii-balitskyi Aug 27, 2024
5e64eb0
Remove console log
andrii-balitskyi Aug 27, 2024
192ceed
Fix heading levels of events and endpoints sections in api-route.hbs
andrii-balitskyi Aug 27, 2024
dabcb2a
Move resource description after its name
andrii-balitskyi Aug 27, 2024
a5f4be8
Test adding a new line in the beginning of endpoint page to render h1…
andrii-balitskyi Aug 27, 2024
dc4e12b
Test adding forward slash
andrii-balitskyi Aug 27, 2024
585a373
Remove forward slash
andrii-balitskyi Aug 28, 2024
4ba99fb
All caps format if it's 'id'
andrii-balitskyi Aug 28, 2024
68fdd6b
Add property enum values
andrii-balitskyi Aug 28, 2024
9e45e47
Fix line break syntax
andrii-balitskyi Aug 28, 2024
86fcb76
Move enum values after description
andrii-balitskyi Aug 28, 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
131 changes: 64 additions & 67 deletions docs/api/acs/systems/README.md
Original file line number Diff line number Diff line change
@@ -1,197 +1,194 @@
## `acs_system`
# `acs_system`

Represents an [access control system](../../../capability-guides/access-systems.md).

## Properties

### `acs_system_id`

ID of the `acs_system`.
Format: `ID`

Type: `string`
Format: `string`
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).
Format: `Boolean`

Type: `boolean`
Format: `boolean`
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`.
Format: `Boolean`

Type: `boolean`
Format: `boolean`
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).
Format: `Boolean`

Type: `boolean`
Format: `boolean`
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).
Format: `Boolean`

Type: `boolean`
Format: `boolean`
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`.
Format: `List`

Type: `array`
Format: `list`
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.
Format: `Datetime`

Type: `string`
Format: `string`
Date and time at which the `acs_system` was created.

---

### `errors`

Errors associated with the `acs_system`.
Format: `List`

Type: `array`
Format: `list`
Errors associated with the `acs_system`.

---

### `external_type`

Format: `Enum`

Brand-specific terminology for the `acs_system` type.

Type: `string`
Format: `enum`
Possible enum values:
- `pti_site`
- `alta_org`
- `salto_site`
- `brivo_account`
- `hid_credential_manager_organization`
- `visionline_system`
- `assa_abloy_credential_service`
- `latch_building`

---

### `external_type_display_name`

Display name that corresponds to the brand-specific terminology for the `acs_system` type.
Format: `String`

Type: `string`
Format: `string`
Display name that corresponds to the brand-specific terminology for the `acs_system` type.

---

### `image_alt_text`

Alternative text for the `acs_system` image.
Format: `String`

Type: `string`
Format: `string`
Alternative text for the `acs_system` image.

---

### `image_url`

URL for the image that represents the `acs_system`.
Format: `String`

Type: `string`
Format: `string`
URL for the image that represents the `acs_system`.

---

### `name`

Name of the `acs_system`.
Format: `String`

Type: `string`
Format: `string`
Name of the `acs_system`.

---

### `system_type`

{% hint style="warning" %}
**Deprecated** use something else.
**Deprecated**. Use `external_type`.
{% endhint %}

Type: `string`
Format: `enum`
Format: `Enum`

Possible enum values:
- `pti_site`
- `alta_org`
- `salto_site`
- `brivo_account`
- `hid_credential_manager_organization`
- `visionline_system`
- `assa_abloy_credential_service`
- `latch_building`

---

### `system_type_display_name`

{% hint style="warning" %}
**Deprecated** use something else.
**Deprecated**. Use `external_type_display_name`.
{% endhint %}

Type: `string`
Format: `string`
Format: `String`

---

### `visionline_metadata`

Type: `object`
Format: `record`
Format: `Record`

---

### `warnings`

Warnings associated with the `acs_system`.
Format: `List`

Type: `array`
Format: `list`
Warnings associated with the `acs_system`.

---

### `workspace_id`

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

Type: `string`
Format: `string`
ID of the [workspace](../../../core-concepts/workspaces.md) that contains the `acs_system`.

---

## Endpoints
# Endpoints

### [`/acs/systems/get`](.//acs/systems/get.md)
## [`/acs/systems/get`](.//acs/systems/get.md)

Returns a specified [access control system](../../../capability-guides/access-systems.md).

Specify the desired access control system by including the corresponding `acs_system_id` in the request body.

---

### [`/acs/systems/list`](.//acs/systems/list.md)
## [`/acs/systems/list`](.//acs/systems/list.md)

Returns a list of all [access control systems](../../../capability-guides/access-systems.md).

To filter the list of returned access control systems by a specific connected account ID, include the
`connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the
response includes all access control systems connected to your workspace.

---

### [`/acs/systems/list_compatible_credential_manager_acs_systems`](.//acs/systems/list_compatible_credential_manager_acs_systems.md)
## [`/acs/systems/list_compatible_credential_manager_acs_systems`](.//acs/systems/list_compatible_credential_manager_acs_systems.md)

Returns a list of all credential manager ACS systems that are compatible with a specified
[access control system](../../../capability-guides/access-systems.md).

Specify the ACS system for which you want to retrieve all compatible credential manager ACS
systems by including the corresponding `acs_system_id` in the request body.

---

## Events
# Events
9 changes: 5 additions & 4 deletions docs/api/acs/systems/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,17 @@ Returns a specified [access control system](../../../capability-guides/access-sy

Specify the desired access control system by including the corresponding `acs_system_id` in the request body.

*Return Type: [acs_system](../README.md)*

## Request Parameters

### `acs_system_id`

*Type:* `string`
*Required:* Yes
Type: `string`\
Required: Yes

ID of the desired access control system.

---

## Return Type

[acs_system](../README.md)
11 changes: 6 additions & 5 deletions docs/api/acs/systems/list.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# List ACS Systems

```
POST /acs/systems/list ⇒ { acs_systems }
POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] }
```

Returns a list of all [access control systems](../../../capability-guides/access-systems.md).
Expand All @@ -10,8 +10,6 @@ To filter the list of returned access control systems by a specific connected ac
`connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the
response includes all access control systems connected to your workspace.

*Return Type: [acs_system](../README.md)*

{% tabs %}
{% tab title="JavaScript" %}
### Request
Expand Down Expand Up @@ -75,10 +73,13 @@ acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33">]

### `connected_account_id`

*Type:* `string`
*Required:* No
Type: `string`\
Required: No

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

---

## Return Type

Array<[acs_system](../README.md)>
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# List Compatible Credential Manager ACS Systems

```
POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_systems }
POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_systems: [acs_system, …] }
```

Returns a list of all credential manager ACS systems that are compatible with a specified
Expand All @@ -10,16 +10,17 @@ Returns a list of all credential manager ACS systems that are compatible with a
Specify the ACS system for which you want to retrieve all compatible credential manager ACS
systems by including the corresponding `acs_system_id` in the request body.

*Return Type: [acs_system](../README.md)*

## Request Parameters

### `acs_system_id`

*Type:* `string`
*Required:* Yes
Type: `string`\
Required: Yes

ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems.

---

## Return Type

Array<[acs_system](../README.md)>
9 changes: 5 additions & 4 deletions package-lock.json

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

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@
"dependencies": {
"@metalsmith/layouts": "^2.7.0",
"@metalsmith/metadata": "^0.3.0",
"@seamapi/blueprint": "^0.14.0",
"@seamapi/blueprint": "^0.14.2",
"change-case": "^5.4.4",
"jstransformer-handlebars": "^1.2.0",
"metalsmith": "^2.6.3"
},
Expand Down
Loading