Skip to content

Commit

Permalink
Update uniform-versioning.md and glossary.md: minor fixups (Azure#29368)
Browse files Browse the repository at this point in the history
* Update uniform-versioning.md

* Update glossary.md
  • Loading branch information
Konrad Jamrozik authored Jun 7, 2024
1 parent 86b70ce commit e90dc8b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
2 changes: 1 addition & 1 deletion documentation/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ A data-plane service has a path of form:

> [!NOTE]
> Some existing services follow different directory structure layouts.
> All such layouts are legacy, deprecated, and not allowed going forward.
> All such layouts are legacy, deprecated, and strongly discouraged going forward.
For example, [`specification/containerservice/resource-manager/Microsoft.ContainerService/aks`]
is a folder for the `aks` service within the `Microsoft.ContainerService` ARM Resource Provider namespace.
Expand Down
7 changes: 5 additions & 2 deletions documentation/uniform-versioning.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
| Short Link: | [aka.ms/azsdk/uniform-versioning](https://aka.ms/azsdk/uniform-versioning) |
|--|--|

# Uniform versioning

> [!NOTE]
Expand All @@ -11,7 +14,7 @@ In brief, it means:
> If a new service API version is released, also a new documentation reference must be released to describe it.
> Similarly, a new version of given SDK package must be released to refer to the new service version.
Each `service` within a `service group` can version independently of each other.
Each `service` within a `service group` or `grouping directory` can version independently of each other.

## Uniform versioning rules

Expand Down Expand Up @@ -55,7 +58,7 @@ The **uniform versioning** has several implications and implementation decisions
### No API version mixing within a service

- Nowhere within a service, documentation for it, or SDK referencing it,
can multiple service API versions be mixed. as such:
can multiple service API versions be mixed. As such:
- `preview` API versions cannot be mixed with `stable` API versions.
- No HTTP API endpoint for given API version can have any kind of dependency on service endpoint from any other API version.
- The above apply to a stand-alone service as well as to a service that is a member of a `service group`.
Expand Down

0 comments on commit e90dc8b

Please sign in to comment.