seamapi / docs

Welcome to the Seam Docs.
https://docs.seam.co
4 stars 10 forks source link

fix: rename /api-clients/access-control-systems -> /api-clients/acs #308

Closed mikewuu closed 3 weeks ago

mikewuu commented 1 month ago

closes #303 closes #304

Note: did not rename to remove resource.

eg. in the examples, this was one of the redirects

-    * [List Systems](api-clients/access-control-systems/systems/list-systems.md)
+    * [List Systems](api-clients/acs/systems/list.md)

But I've left it as the following for consistency with the rest of the files (not jus acs)

-    * [List Systems](api-clients/access-control-systems/systems/list-systems.md)
+    * [List Systems](api-clients/acs/systems/list-systems.md)
mikewuu commented 4 weeks ago

@razor-x renamed everything in /api-clients. Wasn't 100% on the naming for some of the routes, specifically ones that include other resource names, like list-credentials-with-access-to-an-entrance.

See https://github.com/seamapi/docs/pull/308/files#diff-3bdea6261687f749bccd68763ce01cfe6249305137f746ef6ef7c3f7eadebd0d for all the renamings

razor-x commented 4 weeks ago

@mikewuu All the routes need to match the API exactly, i.e., every file is 1to1 with and API route.

api-clients/acs/entrances/list-credentials-with-access-to-an-entrance.md => api-clients/acs/entrances/list_credentials_with_access.md

Additionally, we need all the paths to match the API, so for example, these still need to be fixed, etc.

docs/api-clients/devices/list-unmanaged.md => docs/api-clients/devices/unmanaged/list.md
docs/api-clients/user-identities/add-an-acs-user.md => docs/api-clients/user_identities/add_acs_user.md
... any file that does not match the API route it documents exactly
mikewuu commented 3 weeks ago

@razor-x , closing in favor of #312 as this PR got stale.