Docs example says products are auto-included transitively, but they aren't extracted with `products: []`

オープン 初心者向け
#277 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
76/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
azure
領域
cli, documentation

調査の方向性

docs/guides/filtering-resources.md、特に「Transitive Dependency Behavior」と「How To: Extract Just One API」のセクションを読んでください。apiops extract、バージョン 1.0.1、および示されているフィルターを使って問題を再現してください。products: [] を設定したときにプロダクトが含まれるかどうかをドキュメントが正確に説明していれば完了です。

索引モデルが issue の本文から書いたものです。

説明

type:question
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.

主要言語
TypeScript
スター
29
フォーク
10
平均マージ
1日 14時間
マージ済み PR（30日）
22

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Azure/apiops-cli のほかの issue

Azure/apiops-cli の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。