docs(rest-api): remove enum comment suppression guard clause#20490
Draft
jkodroff wants to merge 1 commit into
Draft
docs(rest-api): remove enum comment suppression guard clause#20490jkodroff wants to merge 1 commit into
jkodroff wants to merge 1 commit into
Conversation
The two upstream enum field comments this guard withheld — StackPermission.Creator and AppUpdateKind.Rename — have been reworded at the source in pulumi-service (pulumi/pulumi-service#46718, merged), so the engineer-facing wording no longer leaks into the public API docs. Drop the $suppressComments denylist and the $typeName tracking that only fed it; the $c comment now renders whenever present. Fixes #20488 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Collaborator
|
Your site preview for commit 0540827 is ready! 🎉 http://www-testing-pulumi-docs-origin-pr-20490-05408274.s3-website.us-west-2.amazonaws.com |
Collaborator
Lighthouse Performance ReportCommit: 0540827 | Metric definitions
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Removes the temporary guard clause in
layouts/partials/openapi/enum-values.htmlthat suppressed two engineer-facing enum field comments from the public REST API docs (StackPermission.CreatorandAppUpdateKind.Rename).The upstream fix — pulumi/pulumi-service#46718, which rewords those comments at the source (the Java IDL that generates the OpenAPI spec) — has merged, so the guard is no longer needed. Enum comments now render whenever present.
The
$suppressCommentsdenylist and the$typeNamevariable that only fed it are both removed.Fixes #20488
Draft note
Kept as a draft until the reworded comments ship and are live in the OpenAPI spec consumed by this site. Once confirmed live, mark ready for review.
🤖 Generated with Claude Code