Skip to content

Commit 823ce84

Browse files
authored
Merge pull request #185477 from adrianhall/ado1888284
(#1888284) Add warning about editing a non-current revision
2 parents 75ef46f + 09babd1 commit 823ce84

File tree

2 files changed

+34
-8
lines changed

2 files changed

+34
-8
lines changed

articles/api-management/api-management-revisions.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,20 @@ When you create a revision, you can set a description for your own tracking purp
5252

5353
When you set a revision as current you can also optionally specify a public change log note. The change log is included in the developer portal for your API users to view. You can modify your change log note using the `Update-AzApiManagementApiRelease` PowerShell cmdlet.
5454

55-
> [!NOTE]
56-
> Certain API properties such as **Display name** and the **API suffix** can only be updated in the current revision.
55+
> [!CAUTION]
56+
> If you are editing a non-current revision of an API, you cannot change the following properties:
57+
>
58+
> * Name
59+
> * Type
60+
> * Description
61+
> * Subscription required
62+
> * API version
63+
> * API version description
64+
> * Path
65+
> * Protocols
66+
>
67+
> These properties can only be changed in the current revision. If your edits change any of the above
68+
> properties of a non-current revision, the error message `Can't change property for non-current revision` will be displayed.
5769
5870
## Versions and revisions
5971

articles/api-management/edit-api.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,22 @@ title: Edit an API with the Azure portal | Microsoft Docs
33
description: Learn how to use API Management (APIM) to edit an API. Add, delete, or rename operations in the APIM instance, or edit the API's swagger.
44
services: api-management
55
documentationcenter: ''
6-
author: dlepow
7-
manager: cfowler
6+
author: adrianhall
87
editor: ''
98

109
ms.service: api-management
1110
ms.workload: mobile
1211
ms.tgt_pltfrm: na
1312
ms.topic: article
14-
ms.date: 11/08/2017
15-
ms.author: danlep
13+
ms.date: 01/19/2022
14+
ms.author: adhal
1615

1716
---
1817
# Edit an API
1918

20-
The steps in this tutorial show you how to use API Management (APIM) to edit an API.
19+
The steps in this tutorial show you how to use API Management (APIM) to edit an API.
2120

22-
+ You can do it by adding, deleting, renaming operations in the APIM instance.
21+
+ You can add, rename, or delete operations in the Azure portal.
2322
+ You can edit your API's swagger.
2423

2524
## Prerequisites
@@ -55,6 +54,21 @@ You can update your backbend API from the Azure portal by following these steps:
5554
3. Update the swagger.
5655
4. Press **Save**.
5756

57+
> [!CAUTION]
58+
> If you are editing a non-current revision of an API, you cannot change the following properties:
59+
>
60+
> * Name
61+
> * Type
62+
> * Description
63+
> * Subscription required
64+
> * API version
65+
> * API version description
66+
> * Path
67+
> * Protocols
68+
>
69+
> If your edits change any of the above properties of a non-current revision, the error message
70+
> `Can't change property for non-current revision` will be displayed.
71+
5872
[!INCLUDE [api-management-define-api-topics.md](../../includes/api-management-define-api-topics.md)]
5973

6074
## Next steps

0 commit comments

Comments
 (0)