- Notifications
You must be signed in to change notification settings - Fork1.1k
docs: group enumerated values by property in API docs#21372
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
+506 −1,664
Conversation
This file contains hidden or 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
This change modifies how enumerated values are displayed in the APIdocumentation tables. Instead of creating a separate row for each enumvalue, values are now grouped by property name and displayed ascomma-separated lists in a single row.Before:| Property | Value ||--------------|-----------|| `login_type` | `password` || `login_type` | `github` || `login_type` | `oidc` |After:| Property | Value(s) ||--------------|---------------------------------|| `login_type` | `password`, `github`, `oidc` |This significantly reduces the height of enum tables, especially fortypes with many possible values like `codersdk.APIKeyScope`.Changes:- Added `groupEnumsByName()` function to main.dot template- Updated enum rendering in main.dot, responses.def, and parameters.def- Header changed from 'Value' to 'Value(s)' to reflect grouping- Regenerated all API documentationFixes#13840
Sort enum values within each property group for consistent orderingin the API documentation tables.
Remove duplicate enum values that appeared when the same propertyhad enum values defined in multiple places in the schema.
johnstcn approved these changesDec 22, 2025
Comment on lines +67 to +84
| function groupEnumsByName(enums) { | ||
| var grouped = {}; | ||
| for (var i = 0; i < enums.length; i++) { | ||
| var e = enums[i]; | ||
| if (!grouped[e.name]) { | ||
| grouped[e.name] = []; | ||
| } | ||
| if (grouped[e.name].indexOf(e.value) === -1) { | ||
| grouped[e.name].push(e.value); | ||
| } | ||
| } | ||
| var result = []; | ||
| for (var name in grouped) { | ||
| grouped[name].sort(); | ||
| result.push({name: name, values: grouped[name]}); | ||
| } | ||
| return result; | ||
| } |
Member
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
TIL you can embed JavaScript into a DOT 🤯
0af038b intomain 32 checks passed
Uh oh!
There was an error while loading.Please reload this page.
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
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.
Description
This change modifies how enumerated values are displayed in the API documentation tables. Instead of creating a separate row for each enum value, values are now grouped by property name and displayed as comma-separated lists in a single row.
Before:
login_typepasswordlogin_typegithublogin_typeoidclogin_typetokenAfter:
login_typepassword,github,oidc,tokenThis significantly reduces the height of enum tables, especially for types with many possible values like
codersdk.APIKeyScope(which had 180+ individual rows before this change).Changes
groupEnumsByName()function tomain.dottemplate that groups enum entries by property namemain.dot,responses.def, andparameters.defto use the new grouped structureStats
The change results in a net reduction of ~1,100 lines in the documentation:
Fixes#13840