Skip to content

Generate API ref summary section #638

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

Merged
merged 8 commits into from
Jun 11, 2025

Conversation

razor-x
Copy link
Member

@razor-x razor-x commented Jun 11, 2025

No description provided.

@razor-x razor-x force-pushed the evan/cx-341-generate-api-ref-section-in-summarymd branch from d9e7ec8 to b7bb46f Compare June 11, 2025 00:35
@razor-x razor-x force-pushed the evan/cx-341-generate-api-ref-section-in-summarymd branch from aa0fb29 to 04eed91 Compare June 11, 2025 00:42
@razor-x
Copy link
Member Author

razor-x commented Jun 11, 2025

@DebbieAtSeam 🔥 b099048 (#638)

We will find a way to inject this into SUMMARY.md but for now we can just copy/paste and we don't have to hand write this anymore.

Copy link
Member

@DebbieAtSeam DebbieAtSeam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@razor-x This is excellent! Many thanks!

Comment on lines +98 to +108
* [Add an ACS User to an Access Group](api/acs/users/add_to_access_group.md)
* [Create an ACS User](api/acs/users/create.md)
* [Delete an ACS User](api/acs/users/delete.md)
* [Get an ACS User](api/acs/users/get.md)
* [List ACS Users](api/acs/users/list.md)
* [List ACS User-Accessible Entrances](api/acs/users/list_accessible_entrances.md)
* [Remove an ACS User from an Access Group](api/acs/users/remove_from_access_group.md)
* [Revoke ACS User Access to All Entrances](api/acs/users/revoke_access_to_all_entrances.md)
* [Suspend an ACS User](api/acs/users/suspend.md)
* [Unsuspend an ACS User](api/acs/users/unsuspend.md)
* [Update an ACS User](api/acs/users/update.md)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it true that all subsections should be in alpha order? That makes sense for an API ref, unless we want to choose a logical order instead (like CRUD or CRU[other actions]D. Which order is most helpful to devs?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure, let's discuses outside of this PR.

@razor-x razor-x marked this pull request as ready for review June 11, 2025 03:06
@razor-x razor-x requested review from a team as code owners June 11, 2025 03:06
@razor-x razor-x merged commit f6a39fa into main Jun 11, 2025
14 checks passed
@razor-x razor-x deleted the evan/cx-341-generate-api-ref-section-in-summarymd branch June 11, 2025 03:08
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

Successfully merging this pull request may close these issues.

3 participants