Skip to content

Update synthetics nerdgraph examples to indicate optional fields more clearly #20718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

shevaun-nr
Copy link
Contributor

Update Nerdgraph API examples to correctly indicate which fields are optional for monitors

  • The existing docs place several mandatory fields for monitor runtimes in the 'optional' section. Many of these are not optional, even though they have only one accepted value.
  • Specifically, the RUNTIME_* options are not optional; even though they have only one acceptable value, if they are not specified the defaults used by the backend are invalid (the legacy runtime options).
  • The issue above is exacerbated by the Nerdgraph Explorer - the runtime values are considered optional in the backend, so the explorer doesn't enforce them. However the request will fail without them due to invalid defaults being used. Users will refer to the docs for an explanation.
  • To address this, this PR changes the section title and marks the fields which are actually optional.

A more ideal version of this would be to change the API to use more correct defaults, but this should help in the meantime.

Copy link

netlify bot commented May 20, 2025

Deploy Preview for docs-website-netlify ready!

Name Link
🔨 Latest commit 1b33e84
🔍 Latest deploy log https://app.netlify.com/projects/docs-website-netlify/deploys/682c6cba2bb3f90008c95200
😎 Deploy Preview https://deploy-preview-20718--docs-website-netlify.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.

Copy link

Hi @shevaun-nr 👋

Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes).

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.

1 participant