Skip to content

Commit 0c4cc80

Browse files
Copilotmarkcowl
andauthored
Move ARM/versioning.md to Versioning/06-evolving-apis.md and update all references
Agent-Logs-Url: https://github.com/Azure/typespec-azure/sessions/5ae43f24-5a9b-4ac4-9c08-9ef4240f81c4 Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com>
1 parent 2e05824 commit 0c4cc80

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed

website/src/content/docs/docs/howtos/Versioning/01-about-versioning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ llmstxt: true
55

66
See [`@typespec/versioning` documentation](https://typespec.io/docs/libraries/versioning/guide) for the general versioning concept. This guide expands on how Azure Services should define and manage API versions.
77

8-
See [Common Versioning Scenarios](../ARM/versioning.md) for how to make specific kinds of common API changes in your specs.
8+
See [Evolving APIs using the Versioning Library](./06-evolving-apis.md) for how to make specific kinds of common API changes in your specs.
99

1010
## How Versioning Works in TypeSpec
1111

website/src/content/docs/docs/howtos/Versioning/04-preview-after-stable.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Adding a Preview Version when the Last Version was Stable
33
llmstxt: true
44
---
55

6-
When the latest api-version in your TypeSpec spec is a stable version, adding a new preview version is simply adding any new types and operations in the new preview and marking them with the appropriate versioning decoration, as described in [Common Versioning Scenarios](../ARM/versioning.md).
6+
When the latest api-version in your TypeSpec spec is a stable version, adding a new preview version is simply adding any new types and operations in the new preview and marking them with the appropriate versioning decoration, as described in [Evolving APIs using the Versioning Library](./06-evolving-apis.md).
77

88
## Making Changes to your TypeSpec spec
99

website/src/content/docs/docs/howtos/Versioning/05-stable-after-stable.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Adding a Stable Version when the Last Version was Stable
33
llmstxt: true
44
---
55

6-
When the latest api-version in your TypeSpec spec is a stable version, adding a new stable version is simply adding any new types and operations in the new stable and marking them with the appropriate versioning decoration, as described in [Common Versioning Scenarios](../ARM/versioning.md).
6+
When the latest api-version in your TypeSpec spec is a stable version, adding a new stable version is simply adding any new types and operations in the new stable and marking them with the appropriate versioning decoration, as described in [Evolving APIs using the Versioning Library](./06-evolving-apis.md).
77

88
## Making Changes to your TypeSpec spec
99

website/src/content/docs/docs/howtos/ARM/versioning.md renamed to website/src/content/docs/docs/howtos/Versioning/06-evolving-apis.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: Versioning
3-
description: Managing versioning for ARM services
2+
title: Evolving APIs using the Versioning Library
3+
description: How to add, remove, or modify resources, operations, and properties across API versions
44
llmstxt: true
55
---
66

7-
This document explains how to manage versioning in TypeSpec projects, including how to add, remove, or modify resources, operations, and properties across API versions.
7+
This document explains how to evolve your API across versions in TypeSpec projects, including how to add, remove, or modify resources, operations, and properties using versioning decorators.
88

99
## Introduction
1010

website/src/content/docs/docs/howtos/Versioning/uncommon-scenarios/02-perpetual-preview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ For some Resource Providers, whenever a new stable version is released, a new pr
8080
newName: int32;
8181
```
8282

83-
- Add any new type changes to stable version (A + 1) and decorate appropriately, as shown in the [versioning guide](../../ARM/versioning.md). Note that these changes should also appear in the new preview (A + 2)
83+
- Add any new type changes to stable version (A + 1) and decorate appropriately, as shown in the [versioning guide](../06-evolving-apis.md). Note that these changes should also appear in the new preview (A + 2)
8484
- Remove version `A` from the versions enumeration
8585

8686
```diff lang=tsp
@@ -213,7 +213,7 @@ For some Resource Providers, whenever a new stable version is released, a new pr
213213
214214
- Do the following with the Original
215215
- Follow the instructions for normalizing decoration in the [converting specifications](./01-converting-specs.md#normalizing-version-decoration-optional) document. This will remove any redundant decoration between the new stable and preview versions (`A + 1` and `A + 2`).
216-
- Add any type changes that are introduced in the new preview and decorate appropriately, following the [versioning guide](../../ARM/versioning.md)
216+
- Add any type changes that are introduced in the new preview and decorate appropriately, following the [versioning guide](../06-evolving-apis.md)
217217
- Add a new example folder for the new preview version and populate with appropriate examples.
218218
- Compile the spec to produce artifacts (especially the new stable and preview version (`A + 1` and `A + 2`) APIs).
219219
- Copy the README.md from copy 1 and add the new preview version to the file.

0 commit comments

Comments
 (0)