Show visible_to_clients in cloud/google create examples#418
Conversation
The cloud file and Google document sections already describe the top-level visible_to_clients create parameter in prose; surface it in the generated create examples too so it's visible where readers copy the request and response payloads.
There was a problem hiding this comment.
Pull request overview
Updates the Basecamp API documentation examples so the already-documented top-level visible_to_clients create parameter is reflected directly in the create request payloads and resulting response examples for Cloud Files and Google Documents.
Changes:
- Add top-level
"visible_to_clients": trueto the create request JSON examples. - Update the create/update response JSON examples to show
"visible_to_clients": true.
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.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| sections/google_documents.md | Adds visible_to_clients to create payload example and aligns response examples accordingly. |
| sections/cloud_files.md | Adds visible_to_clients to create payload example and aligns response examples accordingly. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 055bf7639d
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Match the copyable create commands to the example responses, which now show a client-visible record, by posting the top-level flag.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (2)
sections/google_documents.md:137
- AGENTS.md indicates everything under
sections/is a mirror ofbasecamp/bc3’sdoc/api/and direct edits here will be overwritten by the next sync (AGENTS.md:5-15). If this change did not come from running the bc3 sync, it will diverge and be lost; please ensure it’s landed in bc3 and then re-synced/committed here (or at least note in the PR description that this commit is the sync output).
"description": "<div>Quarterly roadmap document</div>",
"url": "https://docs.google.com/document/d/abcd1234/edit",
"document_type": "doc"
},
"visible_to_clients": true
sections/cloud_files.md:146
- AGENTS.md says
sections/files are copied verbatim frombasecamp/bc3and direct edits here will be overwritten by the next sync (AGENTS.md:5-15). Please ensure this change was made in bc3 and then synced/committed here; otherwise it will silently diverge and be lost.
"title": "Brand assets",
"description": "<div>Logos and color tokens</div>",
"url": "https://www.dropbox.com/s/abcd1234/brand.zip",
"service": "dropbox"
},
"visible_to_clients": true
The cloud file and Google document sections already describe the top-level
visible_to_clientscreate parameter in prose, but the create request/response examples didn't show it.This surfaces it in the examples: the create payloads gain the top-level
visible_to_clientsfield, and the create/update response blocks show"visible_to_clients": true, so readers copying the examples see the parameter in place. Documentation only.