Align filter format with APIOps Toolkit#115
Open
petehauge wants to merge 3 commits into
Open
Conversation
- Rename filter config keys from *Names suffix to bare camelCase plurals (e.g., apiNames -> apis, backendNames -> backends, versionSetNames -> versionSets) to match the Toolkit's configuration.extractor.yaml schema - Rename filter config filename from configuration.extract.yaml to configuration.extractor.yaml across templates, CI/CD workflows, and docs - Add graceful handling for apimServiceName in override config (Toolkit uses this for target APIM instance; CLI logs info and ignores it) - Override config format already aligned (same section names and properties wrapper structure as Toolkit) - Update all 13 test files, 7 docs, CI/CD templates, and specs Closes #114 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
petehauge
changed the title
The config loader now accepts both Toolkit-style keys (e.g., apis, backends, versionSets) and legacy *Names keys (e.g., apiNames, backendNames, versionSetNames). Legacy keys emit a deprecation warning. Using both forms for the same field is an error. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
petehauge
commented
Jun 6, 2026
| ``` | ||
|
|
||
| The filter YAML format is compatible. Rename the file if you prefer the v2 convention, and pass it with `--filter`: | ||
| The filter YAML format is fully compatible with v1. You can use your existing `configuration.extractor.yaml` as-is with the `--filter` flag: |
Collaborator
Author
There was a problem hiding this comment.
Instead of "v1" we should say "APIOps Toolkit"... (this should be fixed everywhere, we shouldn't use 'v1' terminology if possible)
Collaborator
Author
There was a problem hiding this comment.
Fixed — replaced all \�1/\�2\ references throughout \migration-from-v1.md\ with \APIOps Toolkit/\�piops-cli\ respectively. See commit fd1c93f.
Use "APIOps Toolkit" instead of "v1" and "apiops-cli" instead of "v2" throughout the migration guide for clarity. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fully aligns the apiops-cli configuration format with the APIOps Toolkit (
Azure/apiops), so users can take their existing Toolkit configuration files and use them with apiops-cli unchanged.Changes
1. Filter config key names — Renamed from
*Namessuffix to bare camelCase plurals to match the Toolkit'sConfigurationKeyderivation:apiNamesapisbackendNamesbackendsproductNamesproductsnamedValueNamesnamedValuesversionSetNamesversionSetsBackward compatibility: The config loader accepts both Toolkit-style keys (e.g.,
apis) and legacy*Nameskeys (e.g.,apiNames). Legacy keys emit a deprecation warning. Using both forms for the same field is an error.2. Filter config filename — Renamed
configuration.extract.yaml→configuration.extractor.yamlacross all templates, CI/CD workflows, and documentation.3.
apimServiceNamehandling — The Toolkit supports anapimServiceNameroot-level field in override configs. The CLI now accepts this gracefully (logs info that CLI uses--service-nameinstead, and ignores the field).Files Changed
Verification
src/Related Issue(s)
Closes #114