You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guides/environment-overrides.md
+10-21Lines changed: 10 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,15 +23,22 @@ apiops publish \
23
23
--overrides ./configuration.prod.yaml
24
24
```
25
25
26
-
## IDE Autocomplete (JSON Schema)
26
+
## Copilot-Assisted Configuration
27
+
28
+
If you ran `apiops init`, a Copilot prompt file was generated at `.github/prompts/apiops-configure-overrides.prompt.md`. Open it in VS Code and ask GitHub Copilot to help you configure environment overrides — it will guide you through setting up environment-specific values interactively.
27
29
28
-
Add this comment as the first line of your override file to enable autocomplete in VS Code and other YAML-aware editors:
30
+
## IDE Autocompletion with JSON Schema
31
+
32
+
A JSON Schema is available for `configuration.{env}.yaml` override files. Add yaml-language-server comment at the top of your override file. Requires yaml language extension in VSCode.
The schema validates section names, entry structure, nested sub-resource overrides, and supports `{#[TOKEN_NAME]#}` placeholder values. It is published at [`schemas/v1/override-config.schema.json`](https://github.com/Azure/apiops-cli/blob/main/schemas/v1/override-config.schema.json).
38
+
The schema provides:
39
+
- Property name autocompletion for all resource sections
40
+
- Validation of the override structure (name + properties format)
41
+
- Inline documentation including token substitution syntax
35
42
36
43
## Override file format (APIOps Toolkit-compatible)
If you ran `apiops init`, a Copilot prompt file was generated at `.github/prompts/apiops-configure-overrides.prompt.md`. Open it in VS Code and ask GitHub Copilot to help you configure environment overrides — it will guide you through setting up environment-specific values interactively.
575
-
576
-
## IDE Autocompletion with JSON Schema
577
-
578
-
A JSON Schema is available for `configuration.{env}.yaml` override files. Add this comment at the top of your override file to enable autocompletion in VS Code (with the YAML extension):
0 commit comments