Skip to content

[Doc Drift] apiops apic command group missing from README and docs #233

Description

@github-actions

What drifted

A new apiops apic command group was added in PR #232 (commit 76e1192) with two subcommands — apiops apic extract and apiops apic publish — for Azure API Center backup/restore. Neither the README nor any file under docs/ or specs/ documents these commands.

Source of truth

src/cli/apic-command.ts — registers the apic command group with the following flags:

apiops apic extract

  • --resource-group <rg> (required)
  • --service-name <svc> (required)
  • --workspace <name> — restrict extraction to a single workspace
  • --output <dir> — output directory (default: ./apic-artifacts)
  • --no-specifications — skip exporting API definition specifications

apiops apic publish

  • --resource-group <rg> (required)
  • --service-name <svc> (required)
  • --source <dir> — source artifacts directory (default: ./apic-artifacts)
  • --dry-run — preview changes without applying them
  • --no-specifications — skip importing API definition specifications

src/cli/index.ts line 15 confirms the command is registered in the CLI entry point.

Affected documentation

  • README.md## Commands section lists only apiops extract, apiops publish, and apiops init; the apiops apic group is entirely absent
  • docs/commands/ (if it exists) — no coverage of the new command group

Suggested update

Add an ### apiops apic extract and ### apiops apic publish subsection (or a ### apiops apic group section) to README.md under ## Commands, following the same table format used for the existing APIM commands. Document the required and optional flags with their defaults. A brief note explaining the Azure API Center provider's purpose (disaster-recovery backup/restore of Microsoft.ApiCenter/services control-plane state) would also help users discover the feature.

Generated by Documentation Freshness Check — System Policy · 26 AIC · ⌖ 6.03 AIC · ⊞ 6.2K ·

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions