From 1650ba6f5279a5541bab98c40b010142bceceb11 Mon Sep 17 00:00:00 2001 From: frankqianms Date: Mon, 30 Sep 2024 09:08:05 +0800 Subject: [PATCH 1/4] doc: update 1.0.1 release history --- src/apic-extension/HISTORY.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/apic-extension/HISTORY.rst b/src/apic-extension/HISTORY.rst index 9587ffbdf4d..bf826302f9c 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -3,6 +3,15 @@ Release History =============== +1.0.1 +++++++++++++++++++ +* Add: Example for ``az apic api update`` command. +* Add: Example with system assigned identity for ``az apic create`` and ``az apic update`` commands. +* Add: ``--custom-metadata-only`` parameter to ``az apic metadata export`` command. +* Fix: Extracting external documentation from spec bug in ``az apic register`` command. +* Remove: Duplicate example for ``az apic create `` command. +* Remove: The ``summary`` scope setting in ``az apic api register`` command. + 1.0.0 ++++++++++++++++++ Potential Impact: The changes in this release, including the renaming of commands and parameters, may require changes to existing scripts and integrations. Please review the changes carefully and update your code accordingly. From b9cd37df18fc9a574e9c323824af5d09d80f3420 Mon Sep 17 00:00:00 2001 From: frankqianms Date: Mon, 30 Sep 2024 09:21:55 +0800 Subject: [PATCH 2/4] refactor: change note style --- src/apic-extension/HISTORY.rst | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/src/apic-extension/HISTORY.rst b/src/apic-extension/HISTORY.rst index bf826302f9c..03af46ae159 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -3,14 +3,21 @@ Release History =============== -1.0.1 +1.1.0 ++++++++++++++++++ -* Add: Example for ``az apic api update`` command. -* Add: Example with system assigned identity for ``az apic create`` and ``az apic update`` commands. -* Add: ``--custom-metadata-only`` parameter to ``az apic metadata export`` command. -* Fix: Extracting external documentation from spec bug in ``az apic register`` command. -* Remove: Duplicate example for ``az apic create `` command. -* Remove: The ``summary`` scope setting in ``az apic api register`` command. +Potential Impact: The changes in this release, including the renaming of commands and parameters, may require changes to existing scripts and integrations. Please review the changes carefully and update your code accordingly. + +**Updates:** +* Added example for ``az apic api update`` command. +* Added examples with system assigned identity for ``az apic create`` and ``az apic update`` commands. +* [BREAKING CHANGE] Added ``--custom-metadata-only`` parameter to ``az apic metadata export`` command. + +**Fixes:** +* Resolved errors occurring when extracting external documentation from spec in ``az apic register`` command. + +**Removals:** +* Eliminated duplicate example for ``az apic create `` command. +* [BREAKING CHANGE] Removed the ``summary`` scope setting in ``az apic api register`` command. 1.0.0 ++++++++++++++++++ From e6e224b9f6b90906f6b63ec771a92815670be208 Mon Sep 17 00:00:00 2001 From: frankqianms Date: Mon, 30 Sep 2024 10:42:24 +0800 Subject: [PATCH 3/4] fix: fix --- src/apic-extension/HISTORY.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/apic-extension/HISTORY.rst b/src/apic-extension/HISTORY.rst index 03af46ae159..d8d2c6fff8e 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -5,19 +5,18 @@ Release History 1.1.0 ++++++++++++++++++ -Potential Impact: The changes in this release, including the renaming of commands and parameters, may require changes to existing scripts and integrations. Please review the changes carefully and update your code accordingly. **Updates:** * Added example for ``az apic api update`` command. * Added examples with system assigned identity for ``az apic create`` and ``az apic update`` commands. -* [BREAKING CHANGE] Added ``--custom-metadata-only`` parameter to ``az apic metadata export`` command. +* Added ``--custom-metadata-only`` parameter to ``az apic metadata export`` command. **Fixes:** -* Resolved errors occurring when extracting external documentation from spec in ``az apic register`` command. +* Set external document correctly in ``az apic register`` command. +* [BREAKING CHANGE] Do not use API description as summary in ``az apic register`` command. **Removals:** * Eliminated duplicate example for ``az apic create `` command. -* [BREAKING CHANGE] Removed the ``summary`` scope setting in ``az apic api register`` command. 1.0.0 ++++++++++++++++++ From de969e860a93d490c32ef53cd158d5ea57bb8e60 Mon Sep 17 00:00:00 2001 From: frankqianms Date: Mon, 30 Sep 2024 11:30:06 +0800 Subject: [PATCH 4/4] fix: remove breaking change label --- src/apic-extension/HISTORY.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/apic-extension/HISTORY.rst b/src/apic-extension/HISTORY.rst index d8d2c6fff8e..bfd55310fed 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -13,7 +13,7 @@ Release History **Fixes:** * Set external document correctly in ``az apic register`` command. -* [BREAKING CHANGE] Do not use API description as summary in ``az apic register`` command. +* Do not use API description as summary in ``az apic register`` command. **Removals:** * Eliminated duplicate example for ``az apic create `` command.