Docs example says products are auto-included transitively, but they aren't extracted with `products: []`
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 76/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- azure
- Domain
- cli, documentation
Research direction
Read docs/guides/filtering-resources.md, especially the “Transitive Dependency Behavior” and “How To: Extract Just One API” sections. Reproduce the issue with apiops extract, version 1.0.1, and the filter shown; done means the documentation accurately describes whether products are included when products: [] is set.
Written by the indexing model from the issue text.
Description
Question
Thefiltering guide has this example under "Transitive Dependency Behavior":
apis:
- petstore-api
And petstore-api is assigned to:
- Product starter → auto-included
- Tag production → auto-included
The extract output includes all of these, even though only apiNames was specified in the filter.
I set up a filter based on the "How To: Extract Just One API" section on the same page, which lists only version sets, backends, named values, policy fragments, and tags as auto-included when their keys are set to [], and does not mention products:
apis:
- my-api-1
- my-api-2
backends: []
namedValues: []
products: []
tags: []
versionSets: []
loggers: []
diagnostics: []
groups: []
policyFragments: []
gateways: []
schemas: []
subscriptions: []
policies: []
policyRestrictions: []
documentations: []
workspaces: []
After running apiops extract with this filter, the products folder is empty. I confirmed directly against the APIM instance that both APIs are still assigned to their respective products, so the association exists and just isn't showing up in the extract output.
Did I misunderstand something about how the filter or --filter/transitive resolution is supposed to work here, or is the "Products containing the API" line in the Transitive Dependency Behavior example not accurate for the current release?
Context
@azure-tools/apiops-cli version 1.0.1. Filter file only sets apis: with two explicit API names and products: [], no --no-transitive flag passed to apiops extract.
- Dominant language
- TypeScript
- Stars
- 29
- Forks
- 10
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 22
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Azure/apiops-cli
-
type:documentation
Difficulty 1/5 Under an hour Newbie friendliness 94/100
Azure/apiops-cli#250 ·
-
Documentation P2
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Azure/apiops-cli#24 · 1 comment ·
-
type:bug
Difficulty 4/5 3-5 days Newbie friendliness 55/100
Azure/apiops-cli#291 ·
-
type:bug
Difficulty 3/5 1-2 days Newbie friendliness 58/100
Azure/apiops-cli#276 ·
-
type:feature
Difficulty 5/5 Over a week Newbie friendliness 30/100
Azure/apiops-cli#275 · 2 comments · 2 reactions ·
All issues in Azure/apiops-cli
Similar issues
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100