Skip to content

Conversation

@jhlodin
Copy link
Contributor

@jhlodin jhlodin commented Nov 19, 2025

https://cockroachlabs.atlassian.net/browse/DOC-15444

Addresses:

  • Extra backslashes in some code blocks
  • Missing commas
  • Prioritize API flow for gathering cluster_id
  • Incorrect endpoint for backup configuration
  • Inconsistent use of single/double/no quotes in curl examples (opted to enforce double quotes for all literals, no quotes for URLs, to align with other API docs like Stripe

@netlify
Copy link

netlify bot commented Nov 19, 2025

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 08d2c1d
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/6924aa3fc97adf0008074d87

@netlify
Copy link

netlify bot commented Nov 19, 2025

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 08d2c1d
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/6924aa3f0af2410008388db6

@github-actions
Copy link

github-actions bot commented Nov 19, 2025

Files changed:

@netlify
Copy link

netlify bot commented Nov 19, 2025

Netlify Preview

Name Link
🔨 Latest commit 5a80d16
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/691e278d2dcac60008608907
😎 Deploy Preview https://deploy-preview-21210--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link

netlify bot commented Nov 19, 2025

Netlify Preview

Name Link
🔨 Latest commit 08d2c1d
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/6924aa3fb8058a00087cdcee
😎 Deploy Preview https://deploy-preview-21210--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@jhlodin jhlodin changed the title Fix backup and restore API docs bugs Fix miscellaneous API docs bugs Nov 20, 2025
@jhlodin jhlodin requested a review from alicia-l2 November 20, 2025 16:24
@peachdawnleach peachdawnleach self-requested a review November 20, 2025 19:07
Copy link
Contributor

@peachdawnleach peachdawnleach left a comment

Choose a reason for hiding this comment

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

LGTM- lmk if you need another look after tech review

Copy link

@alicia-l2 alicia-l2 left a comment

Choose a reason for hiding this comment

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

beyond the JSON and --data json nits i think everything looks good! thanks so much for helping w this PR I know it ballooned a ton but I think it'l lbe really helpful for code snippets moving forward.

@jhlodin jhlodin enabled auto-merge (squash) November 24, 2025 18:57
@jhlodin jhlodin merged commit 029a362 into main Nov 24, 2025
6 checks passed
@jhlodin jhlodin deleted the jl/doc-15444 branch November 24, 2025 19:09
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.

3 participants