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

Generate /docs/acs/systems/README.md with acs_system resource and properties #300

Closed
Tracked by #268
razor-x opened this issue Aug 15, 2024 · 4 comments
Closed
Tracked by #268
Assignees

Comments

@razor-x
Copy link
Contributor

razor-x commented Aug 15, 2024

Note the content is just an example to demonstrate the format, e.g., acs_system_id is not actually deprecated.

Description here, but not supported yet (see https://github.com/seamapi/docs/issues/305)

## acs_system

### acs_system_id

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

ID of the `acs_system`.

Type: `string`
Format: `uuid`
---

## Endpoints

### [/acs/systems/list]()

List ACS Systems.

### [/acs/systems/get]()

Get an ACS System.

## Events

### acs_system.connected

An ACS system was connected.

#### acs_system_id

ID of the `acs_system`

#### created_at

When the event was created.
---
```
@razor-x
Copy link
Contributor Author

razor-x commented Aug 15, 2024

@DebbieAtSeam Should we prefer using "code" in titles or normal? E.g.,

### `/acs/systems/list`
### `acs_system_id`
### `acs_system`
### `acs_system.connected`

or

### /acs/systems/list
### acs_system_id
### acs_system
### acs_system.connected

@razor-x
Copy link
Contributor Author

razor-x commented Aug 15, 2024

We want to include events on this page, but the first version does not need to include events (we will need to make sure blueprint supports what we want).

#307

@razor-x
Copy link
Contributor Author

razor-x commented Aug 15, 2024

Open question: how to map which resources should be included on the README.md pages? This is more "metadata" for routes and namespaces which we can't support in blueprint yet, so we can start by using #305.

For now, we can just hard code a filter for acs_system

@DebbieAtSeam
Copy link
Contributor

@DebbieAtSeam Should we prefer using "code" in titles or normal? E.g.,


### `/acs/systems/list`

### `acs_system_id`

### `acs_system`

### `acs_system.connected`

or


### /acs/systems/list

### acs_system_id

### acs_system

### acs_system.connected

@razor-x I vote for code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants