Skip to content

Conversation

@danbiwer
Copy link
Contributor

Proposed changes

Update API reference to reflect recent changes to the Insights Accounts Create and Update API endpoints

Related issues (optional)

https://github.com/pulumi/pulumi-service/issues/34822

@claude
Copy link
Contributor

claude bot commented Nov 19, 2025

Documentation Review

Thanks for updating the API reference documentation! The changes accurately reflect the parameter updates from cron to scanSchedule. Here are a few observations:

Issues Found

Line 39: Inconsistent spacing in parameter description
The scanSchedule parameter description has inconsistent spacing. Should align with other parameter descriptions:

| `scanSchedule`   | string | body  | The schedule for automated scans. Valid values: `none`, `daily`                                   |

Line 88: Same spacing issue in Update Account section

| `scanSchedule`   | string | body  | The schedule for automated scans. Valid values: `none`, `daily`                                   |

Style Observations

  1. Good: The new "Update Account" section follows the same structure as "Create Account" which maintains consistency.
  2. Good: The example response messages are clear and informative.
  3. Good: Parameter table formatting is consistent with the rest of the document.

Content Accuracy

  • The parameter change from cron to scanSchedule is consistently applied in both the Create and Update sections.
  • The valid values (none, daily) are clearly documented.
  • The URL encoding example (FizzBuzz%20AWS%20Staging) is helpful for users.

Overall, this is a solid update to the API documentation. The changes are clear and well-structured.


Mention me (@claude) if you'd like additional reviews or fixes applied.

@pulumi-bot
Copy link
Collaborator

@danbiwer danbiwer marked this pull request as ready for review November 19, 2025 20:16
@claude
Copy link
Contributor

claude bot commented Nov 19, 2025

Documentation Review

I've reviewed the changes to the Insights Accounts API documentation. The updates are clear and accurate, with just a few minor issues to address:

Issues Found

Line 23: Missing period at end of list item

The new bullet point is missing a period at the end for consistency with the other list items.

- Updating existing Insights accounts

Line 39: Inconsistent trailing spaces in table description

The table cell descriptions should have consistent spacing. The current line has extra trailing spaces after "daily".

| `scanSchedule`   | string | body  | The schedule for automated scans. Valid values: `none`, `daily` |

Line 84: Same spacing issue in Update Account table

Same trailing space issue in the Update Account parameters table.

| `scanSchedule`   | string | body  | The schedule for automated scans. Valid values: `none`, `daily` |

Line 112: Missing period at end of sentence

The last sentence in the file is missing a period.

Lists Insight Accounts available to the authenticated user.

Positive Notes

  • Clear documentation of the API change from cron to scanSchedule
  • Good addition of the Update Account section with complete PATCH endpoint documentation
  • Accurate status code update (204 No Content)
  • Consistent example structure between Create and Update sections
  • Proper use of code blocks and table formatting

Recommendation

The changes are well-structured and ready to merge after fixing the minor punctuation and spacing issues noted above.


Mention @claude if you'd like me to review any additional changes or help with fixes.

@pulumi-bot
Copy link
Collaborator

@danbiwer danbiwer merged commit 3f0c8f7 into master Nov 19, 2025
14 checks passed
@danbiwer danbiwer deleted the danbiwer/insights-create-update-docs branch November 19, 2025 20:24
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.

4 participants