Skip to content

Commit f01cdcf

Browse files
authored
Align docs and comments with preview API version default
1 parent 6d7d684 commit f01cdcf

5 files changed

Lines changed: 9 additions & 13 deletions

File tree

docs/commands/extract.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,6 @@ apiops extract \
7575
| `--subscription-id <id>` | string | env: `AZURE_SUBSCRIPTION_ID` | Azure subscription ID (required) |
7676
| `--log-level <level>` | string | `info` | Log level: `debug`, `info`, `warn`, `error` |
7777
| `--format <type>` | string | `text` | Output format: `text` or `json` |
78-
| `--api-version <version>` | string | `2024-05-01` (env: `AZURE_API_VERSION`) | APIM REST API version override |
7978
| `--cloud <name>` | string | `public` | Sovereign cloud: `public`, `china`, `usgov`, `germany` |
8079
| `--client-id <id>` | string || Service principal client ID |
8180
| `--client-secret <secret>` | string || Service principal client secret |

docs/commands/publish.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@ apiops publish \
8686
| `--subscription-id <id>` | string | env: `AZURE_SUBSCRIPTION_ID` | Azure subscription ID (required) |
8787
| `--log-level <level>` | string | `info` | Log level: `debug`, `info`, `warn`, `error` |
8888
| `--format <type>` | string | `text` | Output format: `text` or `json` |
89-
| `--api-version <version>` | string | `2024-05-01` (env: `AZURE_API_VERSION`) | APIM REST API version override |
9089
| `--cloud <name>` | string | `public` | Sovereign cloud: `public`, `china`, `usgov`, `germany` |
9190
| `--client-id <id>` | string || Service principal client ID |
9291
| `--client-secret <secret>` | string || Service principal client secret |

docs/reference/configuration.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Available on all commands (`extract`, `publish`, `init`):
3939
| `--cloud <name>` | Azure cloud environment | `public` |
4040
| `--log-level <level>` | Log verbosity: `debug`, `info`, `warn`, `error` | `info` |
4141
| `--format <format>` | Output format | `text` |
42-
| `--api-version <version>` | APIM REST API version | `2024-05-01` |
42+
| `--api-version <version>` | APIM REST API version | `2025-09-01-preview` |
4343

4444
### `apiops extract` Flags
4545

@@ -86,10 +86,8 @@ Available on all commands (`extract`, `publish`, `init`):
8686
| `AZURE_CLIENT_ID` | all | Service principal client ID for authentication |
8787
| `AZURE_CLIENT_SECRET` | all | Service principal client secret for authentication |
8888
| `AZURE_TENANT_ID` | all | Microsoft Entra ID (Azure AD) tenant ID |
89-
| `AZURE_API_VERSION` | extract, publish | APIM REST API version (default: `2024-05-01`) |
89+
| `AZURE_API_VERSION` | extract, publish | APIM REST API version (default: `2025-09-01-preview`) |
9090
| `COMMIT_ID` | publish | Git commit SHA for incremental publish (alternative to `--commit-id`) |
91-
| `OTEL_EXPORTER_OTLP_ENDPOINT` | extract, publish | OpenTelemetry OTLP exporter endpoint for telemetry |
92-
| `APPLICATIONINSIGHTS_CONNECTION_STRING` | extract, publish | Azure Monitor Application Insights connection string for telemetry |
9391

9492
### Authentication Environment Variables
9593

@@ -151,7 +149,7 @@ backends:
151149
| Azure cloud | `public` | `--cloud` |
152150
| Log level | `info` | `--log-level` |
153151
| Output format | `text` | `--format` |
154-
| API version | `2024-05-01` | `--api-version` or `AZURE_API_VERSION` |
152+
| API version | `2025-09-01-preview` | `--api-version` or `AZURE_API_VERSION` |
155153
| Transitive deps | enabled | `--no-transitive` |
156154
| Dry run | disabled | `--dry-run` |
157155
| Delete unmatched | disabled | `--delete-unmatched` |

src/cli/extract-command.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,9 @@ async function executeExtract(
7777
}
7878

7979
// Build service context
80-
// Default to a recent preview API version so newer resource types (e.g.
81-
// MCP-typed APIs) are returned by ARM list endpoints. Older versions
82-
// (e.g. 2024-05-01) silently omit MCP APIs from /apis.
80+
// Default to 2025-09-01-preview so newer resource types (e.g. MCP-typed
81+
// APIs) are returned by ARM list endpoints. Older versions (e.g. 2024-05-01)
82+
// can silently omit MCP APIs from /apis.
8383
const apiVersion = globalOpts.apiVersion ?? process.env.AZURE_API_VERSION ?? '2025-09-01-preview';
8484
const cloudName = globalOpts.cloud ?? 'public';
8585
const cloudConfig = getCloudConfig(cloudName);

src/cli/publish-command.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,9 @@ async function executePublish(
8989
}
9090

9191
// Build service context
92-
// Default to a recent preview API version so newer resource types (e.g.
93-
// MCP-typed APIs) are accepted by ARM. Older versions (e.g. 2024-05-01)
94-
// reject MCP API payloads.
92+
// Default to 2025-09-01-preview so newer resource types (e.g. MCP-typed
93+
// APIs) are accepted by ARM. Older versions (e.g. 2024-05-01) can reject
94+
// MCP API payloads.
9595
const apiVersion =
9696
globalOpts.apiVersion ?? process.env.AZURE_API_VERSION ?? '2025-09-01-preview';
9797
const cloudName = globalOpts.cloud ?? 'public';

0 commit comments

Comments
 (0)