Conversation
There was a problem hiding this comment.
Pull request overview
This PR aims to update documentation to inform users about the US region endpoint. However, it introduces critical bugs by incorrectly modifying nested schema documentation paths.
Changes:
- Added comment to API URI configuration examples to indicate the US region endpoint alternative (
https://api.us.stackguardian.io) - Modified nested schema headers in documentation files (incorrectly changing them from
configto attribute names likesource_config_dest_kindandsource_config_kind)
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/index.md | Added helpful comment about US region API endpoint |
| docs/guides/Installation.md | Updated API URI with US region information and corrected from test API to production API |
| docs-templates/index.md.tmpl | Added US region comment to template file |
| docs-templates/guides/Installation.md | Updated template with US region information and corrected from test API to production API |
| docs/resources/policy.md | INCORRECTLY changed nested schema path from config to source_config_dest_kind |
| docs/resources/connector.md | INCORRECTLY changed nested schema path from config to source_config_dest_kind |
| docs/data-sources/policy.md | INCORRECTLY changed nested schema path from config to source_config_kind |
| docs/data-sources/connector.md | INCORRECTLY changed nested schema path from config to source_config_dest_kind |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/data-sources/connector.md
Outdated
|
|
||
| <a id="nestedatt--discovery_settings--benchmarks--runtime_source--config"></a> | ||
| ### Nested Schema for `discovery_settings.benchmarks.runtime_source.config` | ||
| ### Nested Schema for `discovery_settings.benchmarks.runtime_source.source_config_dest_kind` |
There was a problem hiding this comment.
The nested schema path is incorrect. This header should describe the schema for the config attribute, not source_config_dest_kind. The correct header should be: ### Nested Schema for discovery_settings.benchmarks.runtime_source.config
The source_config_dest_kind is a sibling attribute at the same level as config, not a nested schema. Looking at line 74, you can see that config is defined as an Attributes object with its own nested schema, and that's what this section should document. This same pattern is correctly followed in other files like docs/resources/runner_group.md at line 87.
| ### Nested Schema for `discovery_settings.benchmarks.runtime_source.source_config_dest_kind` | |
| ### Nested Schema for `discovery_settings.benchmarks.runtime_source.config` |
docs/data-sources/policy.md
Outdated
|
|
||
| <a id="nestedatt--policies_config--policy_vcs_config--custom_source--config"></a> | ||
| ### Nested Schema for `policies_config.policy_vcs_config.custom_source.config` | ||
| ### Nested Schema for `policies_config.policy_vcs_config.custom_source.source_config_kind` |
There was a problem hiding this comment.
The nested schema path is incorrect. This header should describe the schema for the config attribute, not source_config_kind. The correct header should be: ### Nested Schema for policies_config.policy_vcs_config.custom_source.config
The source_config_kind is a sibling attribute at the same level as config, not a nested schema. Looking at line 86, you can see that config is defined as an Attributes object with its own nested schema, and that's what this section should document. This same pattern is correctly followed in other files like docs/resources/runner_group.md at line 87.
| ### Nested Schema for `policies_config.policy_vcs_config.custom_source.source_config_kind` | |
| ### Nested Schema for `policies_config.policy_vcs_config.custom_source.config` |
Update docs to display the correct url for stackguardian API and for the US region