Release generated ACS systems API reference pages #316
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Generate reference page for /acs/systems/list
* Update api-reference template, add responseKey to file response context
* Update blueprint package registry url
* Remove license
* Add eq helper
* ci: Generate docs
* Change default return value to {}
* ci: Generate docs
* Bump seam types to 1.229.1
* ci: Generate docs
* Remove default value when no code samples are provided
* Default to void when there's not responseKey
* Add type to request params
* ci: Generate docs
* Bump blueprint to 0.14.0 and fix req param types
* ci: Generate docs
* Fix setEndpointTemplateContext
* ci: Generate docs
---------
Co-authored-by: Seam Bot <devops@getseam.com>
… properties (#314) * Update api-reference template, add responseKey to file response context * Update blueprint package registry url * Remove license * Add eq helper * ci: Generate docs * Change default return value to {} * ci: Generate docs * Bump seam types to 1.229.1 * ci: Generate docs * Remove default value when no code samples are provided * Default to void when there's not responseKey * Add type to request params * ci: Generate docs * Create api resource page template * Set context for resource page * Update reference.ts to actually set context for resource pages * ci: Generate docs * Add missing new line to the end of src/layouts/api-resource.hbs * Fix indentation * ci: Generate docs * Bump blueprint to 0.14.0 and fix req param types * ci: Generate docs * Fix setEndpointTemplateContext * ci: Generate docs * Update src/layouts/api-resource.hbs * ci: Generate docs * Update src/layouts/api-resource.hbs * ci: Generate docs * Update src/layouts/api-resource.hbs Co-authored-by: Evan Sosenko <evan@getseam.com> * ci: Generate docs * Rename api-resource template to api-route + the set context fn * Rename src/layouts/api-resource.hbs to src/layouts/api-route.hbs --------- Co-authored-by: Seam Bot <devops@getseam.com> Co-authored-by: Evan Sosenko <evan@getseam.com>
* Do not generate sdk pages * Remove empty sdk files * ci: Generate docs * Update metalsmith.ts * Disable SDK gen * ci: Format code * Do not generate any SDKs * Set type * Remove sdk from src * Remove generated sdk pages --------- Co-authored-by: Seam Bot <devops@getseam.com>
* wip: rename paths * rename paths * revert gitbook * add missing redirect directories * revert overview.md * Apply suggestions from code review --------- Co-authored-by: Evan Sosenko <evan@getseam.com>
* rename reset-workspace -> reset_sandbox * get-workspace * revoke-access-to-a-device-from-a-user-identity.md * user_identities/remove_acs_user * list_acs_users * list_acs_systems * list_accessible_devices * list-user-identities * grant_access_to_device * get-a-user-identity * list-enrollmnent-automations * launch-an-enrollment-automation.md * enrollment_automations/get * get-an-enrollment-automation.md * rename user-identities -> user_identities * rename enrollment-automations -> enrollment_automations * enrollment_automations/README.md * add user_identities/enrollment_automations/README.md * rename delete-a-user-identity * rename create-a-user-identity * add_acs_user * update-noise-threshold * create-noise-threshold * rename noise thresholds * unlock-a-lock * locks * list-locks * get-lock * list-events * get-an-event * update-device * update-unmanaged-device * list-unmanaged-device * list-device-providers * list-devices * list-devices * get-device-1 * delete-device * list-connected-accounts * get-a-connected-account * delete-a-connected-account * connected_accounts/README.md * list-connect-webview * get-a-connect-webview * delete-a-connect-webview * create-a-connect-webview * connect_webviews * list-client-sessions * grant-access-to-a-client-session * get-or-create-a-client-session * get-a-client-session * delete-a-client-session * client_sessions * action_attempts * uesrs * systems * list-credentials-with-access-to-an-entrance * list-entrances * get-an-entrance * entrances * update-a-credential * unassign-a-credential-from-a-user * list-accessible-entrances * list-credentials * get-credential * delete-credential * create-credential-for-user * assign-a-credential-to-a-user * credentials * list-users-in-access-group * list-access-groups * get-access-group * access_groups * acs * update-an-access-code * list-unmanaged-access-codes * delete-an-unmanaged-access-code * convert-an-unmanaged-access-code * pull-backup-access-code * list-access-codes * get-an-access-code * delete-an-access-code * create-many-access-codes * create-many-access-codes * access_codes * access-control-systems * acs /client-sessions * /connect-webviews * connected_accounts * noise-sensors * docs/api-clients/acs/access_groups/README.md * revert overview.md
* Change property details order and add line break between type and format in api-route.hbs * Capitalize boolean type * Fix resource property deprecation message and format * Un-italicize return type, add line break btw type and required in api-reference.hbs * REmove italic text from api-reference.hbs * Make return type a heading parallel to request params in api-reference layout * Bump blueprint to 0.14.2 * ci: Generate docs * Add resource description * Remove type from api-route page, use capitalized format only * Add "Properties" header after resource name in api-route layout * Decrease all heading levels by one in api-route.hbs * Endpoints section includes only first paragraph from the endpoint description * Remove console log * Fix heading levels of events and endpoints sections in api-route.hbs * Move resource description after its name * Test adding a new line in the beginning of endpoint page to render h1 header * Test adding forward slash * Remove forward slash * All caps format if it's 'id' * Add property enum values * Fix line break syntax * Move enum values after description --------- Co-authored-by: Seam Bot <devops@getseam.com>
* Adjust link targets * ci: Generate docs * Remove +1 in link path * ci: Generate docs * Update links to /acs/systems * Only generate relative links to files that exist * ci: Generate docs * Fix link back to README.md * ci: Generate docs * Include hash in link * Fix relative path --------- Co-authored-by: Seam Bot <devops@getseam.com>
|
Latest preview looking good. Code formatting pending #322 |
DebbieAtSeam
approved these changes
Aug 30, 2024
There was a problem hiding this comment.
@razor-x So exciting!!! I'm assuming that we can still additional fine-tune things later, right?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Release the generated
/api/acs/systemspages.