Skip to content

Commit 30bee25

Browse files
committed
removing duplicate paragraph.
1 parent 2b31829 commit 30bee25

2 files changed

Lines changed: 11 additions & 22 deletions

File tree

docs/guides/environment-overrides.md

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,22 @@ apiops publish \
2323
--overrides ./configuration.prod.yaml
2424
```
2525

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.
2729

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.
2933

3034
```yaml
3135
# yaml-language-server: $schema=https://raw.githubusercontent.com/Azure/apiops-cli/main/schemas/v1/override-config.schema.json
3236
```
3337

34-
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
3542

3643
## Override file format (APIOps Toolkit-compatible)
3744

@@ -567,21 +574,3 @@ apiops publish --overrides configuration.prod.yaml --dry-run \
567574
- [Scenarios and Workflows](scenarios-and-workflows.md)
568575
- [GitHub Actions Integration](../ci-cd/github-actions.md)
569576

570-
---
571-
572-
## Copilot-Assisted Configuration
573-
574-
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):
579-
580-
```yaml
581-
# yaml-language-server: $schema=https://raw.githubusercontent.com/Azure/apiops-cli/main/schemas/v1/override-config.schema.json
582-
```
583-
584-
The schema provides:
585-
- Property name autocompletion for all resource sections
586-
- Validation of the override structure (name + properties format)
587-
- Inline documentation including token substitution syntax

docs/guides/filtering-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Only `petstore-api`, `orders-api`, and their transitive dependencies are extract
3838

3939
## IDE Autocomplete (JSON Schema)
4040

41-
Add this comment as the first line of your filter file to enable autocomplete in VS Code and other YAML-aware editors:
41+
Add yaml-language-server comment at the top of your override file. Requires yaml language extension in VSCode.
4242

4343
```yaml
4444
# yaml-language-server: $schema=https://raw.githubusercontent.com/Azure/apiops-cli/main/schemas/v1/extractor-config.schema.json

0 commit comments

Comments
 (0)