Azure / Azure/apiops-cli

[Doc Drift] README extract flags table missing `--remove-stale`

Đang mở Phù hợp với người mới
#250 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
type:documentation
Ngôn ngữ chính
TypeScript
Star
26
Fork
9
Merge trung bình
1 ngày 3 giờ
Pull request đã merge (30 ngày)
20

Mô tả

### What drifted

The `apiops extract` flags table in `README.md` is missing the `--remove-stale` flag. The flag exists in the CLI (confirmed by `apiops extract --help`) and is documented in `docs/commands/extract.md`, but was not added to the README summary table when it was introduced in commit `570ca00` ("fix: reconcile stale extraction artifacts safely").

### Source of truth

`apiops extract --help` output:
```
--remove-stale Remove stale managed artifacts in the selected scope
```

`docs/commands/extract.md` line 69:
```
| `--remove-stale` | boolean | false | No | Remove stale managed artifacts in the selected filter and workspace scope after a fully successful extraction |
```

### Affected documentation

- `README.md` — the `### \`apiops extract\`` section's flags table (currently lists only `--resource-group`, `--service-name`, `--output`, `--filter`, `--no-transitive`)

### Suggested update

Add a row for `--remove-stale` to the README extract flags table:

| `--remove-stale` | | Remove stale managed artifacts after a fully successful extraction |

> Generated by [Documentation Freshness Check — System Policy](https://github.com/Azure/apiops-cli/actions/runs/33410933190) · 38.1 AIC · ⌖ 6.97 AIC · ⊞ 6.2K · [◷](https://github.com/search?q=repo%3AAzure%2Fapiops-cli+is%3Aissue+%22gh-aw-workflow-call-id%3A+Azure%2Fapiops-cli%2Fdoc-freshness%22&type=issues)

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Start with the `apiops extract` flags table in `README.md`, then compare it with `docs/commands/extract.md` line 69 and the `apiops extract --help` output mentioned in the issue. Done means the README table includes `--remove-stale` with wording consistent with the documented behavior.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Lĩnh vực
cli, documentation
Loại issue
Tài liệu
Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức độ hoạt động
Sôi nổi
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
94/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.