Skip to content

Hygiene: cross-ref rich-text attachments in recordable-subtypes plan#427

Open
jeremy wants to merge 3 commits into
mainfrom
track-a-hygiene-searchresult-issue
Open

Hygiene: cross-ref rich-text attachments in recordable-subtypes plan#427
jeremy wants to merge 3 commits into
mainfrom
track-a-hygiene-searchresult-issue

Conversation

@jeremy

@jeremy jeremy commented Jul 25, 2026

Copy link
Copy Markdown
Member

Follow-up hygiene track after #408 (rich-text *_attachments coverage).

What

Adds a forward-looking cross-reference to recordable-subtypes-doc.md:
CloudFile and GoogleDocument are rich-text emitters, so their eventual
absorption must carry their own *_attachments companion arrays — otherwise
the rich-text projection coverage completed in #408 would silently regress for
the newly-modeled subtypes.

Companion issue work (this track, not code)

Verify

  • make validate-api-gaps clean (23 entries).

Summary by cubic

Adds a cross-reference in recordable-subtypes-doc.md so CloudFile and GoogleDocument keep their own *_attachments arrays when absorbed, preserving rich‑text coverage from #408. Also updates rich-text-attachments-coverage.md to point provenance to #408 (closes #405), standardize that phrasing, and link the out‑of‑scope SearchResult.attachments to #428; closes #355.

Written for commit f975a26. Summary will update on new commits.

Review in cubic

CloudFile and GoogleDocument are rich-text emitters; note that their
absorption must carry their own `*_attachments` companion arrays so the
rich-text projection coverage (rich-text-attachments-coverage) isn't
silently missed when those subtypes land.
Copilot AI review requested due to automatic review settings July 25, 2026 05:13
@github-actions github-actions Bot added the spec Changes to the Smithy spec or OpenAPI label Jul 25, 2026
@github-actions

github-actions Bot commented Jul 25, 2026

Copy link
Copy Markdown

Spec Change Impact

  • Operations/Types/Resources Changes:

    • No operations, types, or resources were added, modified, or removed in this update. This appears to be a hygiene/structural refactor.
  • SDKs Needing Regeneration:

    • All SDKs need regeneration to ensure alignment with the updated spec.
  • Breaking API Changes:

    • No breaking changes detected. No operations or fields were removed.
  • SDKs Requiring Updates:

    • Go
    • TypeScript
    • Ruby
    • Kotlin
    • Swift

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 25, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR is a documentation hygiene follow-up to the rich-text *_attachments coverage work, adding a cross-reference reminder in the recordable subtypes absorption plan so future modeling of CloudFile / GoogleDocument doesn’t regress the now-complete rich-text attachment projection coverage.

Tip

If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.

Changes:

  • Add an explicit note that CloudFile / GoogleDocument must include their own *_attachments companion arrays when absorbed.
  • Link the note to rich-text-attachments-coverage as the canonical reference for the projection-completeness requirement.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

No issues found across 1 file

Re-trigger cubic

…tachments to #428

Copilot/human review on #427: the rich-text-attachments brief called #405 'this
PR' and left the generic SearchResult attachments key untracked. #405 was the
tracking issue; the merged PR is #408 (closes #405). Point the provenance at
#408 and link the out-of-scope SearchResult.attachments bullet to its filed
issue #428.
Copilot AI review requested due to automatic review settings July 25, 2026 06:12
@github-actions github-actions Bot removed the documentation Improvements or additions to documentation label Jul 25, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comment thread spec/api-gaps/rich-text-attachments-coverage.md Outdated

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

All reported issues were addressed across 1 file (changes from recent commits).

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread spec/api-gaps/rich-text-attachments-coverage.md Outdated
Second occurrence said '#408 (merged #405)'; make both read '#408 (closes #405)'.
Copilot AI review requested due to automatic review settings July 25, 2026 06:50
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 25, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation spec Changes to the Smithy spec or OpenAPI

Projects

None yet

2 participants