From 0fb5ad35a3d3a93de429b686c254af812dd5c68f Mon Sep 17 00:00:00 2001 From: Julia Kasper <42241691+juliajuju93@users.noreply.github.com> Date: Fri, 21 Jun 2024 17:40:13 -0700 Subject: [PATCH 01/17] Update HISTORY.rst - jukasper updated changelog --- src/apic-extension/HISTORY.rst | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/src/apic-extension/HISTORY.rst b/src/apic-extension/HISTORY.rst index 9e6488d7070..5e6c14ea9b0 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -5,19 +5,24 @@ Release History 1.0.0 ++++++++++++++++++ -* Update: Redesigned `az apic service import-from-apim` command to provide easier way to specify APIM instance -* Update: Renamed `az apic service *` commands to `az apic *` commands -* Update: Renamed `--name/--service/--service-name/-s` parameters in `az apic *` commands to `--name/-n` -* Update: Renamed `--service/--service-name/-s` parameters in each sub commands to `--service-name/-n` -* Update: Renamed `--metadata-schema/--metadata-schema-name/--name` parameters in `az apic metadata *` commands to `--metadata-name` -* Update: Renamed `--environment-name` parameter in `az apic api register` command to `--environment-id` -* Fix: API title created by register command is not same with provided spec -* Fix: Error not thrown when import spec with >3MB file -* Fix: Error when register API with long description in spec -* Fix: `--definition-id`, `--environment-id`, `--server`, `--title` parameters should be required in `az apic api deployment create` command -* Fix: `--format`, `--specification`, `--value` parameters should be required in `az apic api definition import-specification` command -* Remove: `--state`` parameter for `az apic api deployment` commands. -* Remove: `--file-name`` parameter for `az apic api definition import-specification`, `az apic metadata create` and `az apic metadata update` command. Use the `@filename` syntax provided by Azure CLI to read parameter value from a file directly. +Updates: +* Redesigned `az apic service import-from-apim` command for an easier specification of APIM instances. +* Renamed `az apic service *` commands to `az apic *` commands. +* Renamed `--name/--service/--service-name/-s` parameters in `az apic *` commands to `--name/-n`. +* Renamed `--service/--service-name/-s` parameters in subcommands to `--service-name/-n`. +* Renamed `--metadata-schema/--metadata-schema-name/--name` parameters in `az apic metadata *` commands to `--metadata-name`. +* Renamed `--environment-name` parameter in `az apic api register` command to `--environment-id`. + +Fixes: +* Ensured API title created by `register` command matches the provided specification. +* Addressed the non-throwing of errors when importing specifications with files larger than 3MB. +* Resolved errors occurring when registering APIs with long descriptions in the specification. +* Made `--definition-id`, `--environment-id`, `--server`, `--title` parameters mandatory in `az apic api deployment create` command. +* Made `--format`, `--specification`, `--value` parameters mandatory in `az apic api definition import-specification` command. + +Removals: +* Removed `--state` parameter from `az apic api deployment` commands. +* Eliminated `--file-name` parameter for `az apic api definition import-specification`, `az apic metadata create`, and `az apic metadata update` commands. Introduced usage of the `@filename` syntax for reading parameter values from a file directly in Azure CLI. 1.0.0b5 ++++++++++++++++++ From 94340d6b6edb4b349c4cee063c381563d995839f Mon Sep 17 00:00:00 2001 From: Julia Kasper <42241691+juliajuju93@users.noreply.github.com> Date: Fri, 21 Jun 2024 17:42:52 -0700 Subject: [PATCH 02/17] Update HISTORY.rst --- src/apic-extension/HISTORY.rst | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/src/apic-extension/HISTORY.rst b/src/apic-extension/HISTORY.rst index 5e6c14ea9b0..b91bf973186 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -6,23 +6,23 @@ Release History 1.0.0 ++++++++++++++++++ Updates: -* Redesigned `az apic service import-from-apim` command for an easier specification of APIM instances. -* Renamed `az apic service *` commands to `az apic *` commands. -* Renamed `--name/--service/--service-name/-s` parameters in `az apic *` commands to `--name/-n`. -* Renamed `--service/--service-name/-s` parameters in subcommands to `--service-name/-n`. -* Renamed `--metadata-schema/--metadata-schema-name/--name` parameters in `az apic metadata *` commands to `--metadata-name`. -* Renamed `--environment-name` parameter in `az apic api register` command to `--environment-id`. +- Redesigned `az apic service import-from-apim` command for an easier specification of APIM instances. +- Renamed `az apic service *` commands to `az apic *` commands. +- Renamed `--name/--service/--service-name/-s` parameters in `az apic *` commands to `--name/-n`. +- Renamed `--service/--service-name/-s` parameters in subcommands to `--service-name/-n`. +- Renamed `--metadata-schema/--metadata-schema-name/--name` parameters in `az apic metadata *` commands to `--metadata-name`. +- Renamed `--environment-name` parameter in `az apic api register` command to `--environment-id`. Fixes: -* Ensured API title created by `register` command matches the provided specification. -* Addressed the non-throwing of errors when importing specifications with files larger than 3MB. -* Resolved errors occurring when registering APIs with long descriptions in the specification. -* Made `--definition-id`, `--environment-id`, `--server`, `--title` parameters mandatory in `az apic api deployment create` command. -* Made `--format`, `--specification`, `--value` parameters mandatory in `az apic api definition import-specification` command. +- Ensured API title created by `register` command matches the provided specification. +- Addressed the non-throwing of errors when importing specifications with files larger than 3MB. +- Resolved errors occurring when registering APIs with long descriptions in the specification. +- Made `--definition-id`, `--environment-id`, `--server`, `--title` parameters mandatory in `az apic api deployment create` command. +- Made `--format`, `--specification`, `--value` parameters mandatory in `az apic api definition import-specification` command. Removals: -* Removed `--state` parameter from `az apic api deployment` commands. -* Eliminated `--file-name` parameter for `az apic api definition import-specification`, `az apic metadata create`, and `az apic metadata update` commands. Introduced usage of the `@filename` syntax for reading parameter values from a file directly in Azure CLI. +- Removed `--state` parameter from `az apic api deployment` commands. +- Eliminated `--file-name` parameter for `az apic api definition import-specification`, `az apic metadata create`, and `az apic metadata update` commands. Introduced usage of the `@filename` syntax for reading parameter values from a file directly in Azure CLI. 1.0.0b5 ++++++++++++++++++ From 1ab9aab08a9887df024a48b0fc3b38d568fbd4a8 Mon Sep 17 00:00:00 2001 From: Julia Kasper <42241691+juliajuju93@users.noreply.github.com> Date: Fri, 21 Jun 2024 17:43:11 -0700 Subject: [PATCH 03/17] Update HISTORY.rst --- src/apic-extension/HISTORY.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/src/apic-extension/HISTORY.rst b/src/apic-extension/HISTORY.rst index b91bf973186..ac39bb0f448 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -6,6 +6,7 @@ Release History 1.0.0 ++++++++++++++++++ Updates: + - Redesigned `az apic service import-from-apim` command for an easier specification of APIM instances. - Renamed `az apic service *` commands to `az apic *` commands. - Renamed `--name/--service/--service-name/-s` parameters in `az apic *` commands to `--name/-n`. From 4e51c2c381aec26ebfebc4093b43f45c82150937 Mon Sep 17 00:00:00 2001 From: Julia Kasper <42241691+juliajuju93@users.noreply.github.com> Date: Fri, 21 Jun 2024 17:43:42 -0700 Subject: [PATCH 04/17] Update HISTORY.rst --- src/apic-extension/HISTORY.rst | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/src/apic-extension/HISTORY.rst b/src/apic-extension/HISTORY.rst index ac39bb0f448..098deef99f5 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -7,23 +7,25 @@ Release History ++++++++++++++++++ Updates: -- Redesigned `az apic service import-from-apim` command for an easier specification of APIM instances. -- Renamed `az apic service *` commands to `az apic *` commands. -- Renamed `--name/--service/--service-name/-s` parameters in `az apic *` commands to `--name/-n`. -- Renamed `--service/--service-name/-s` parameters in subcommands to `--service-name/-n`. -- Renamed `--metadata-schema/--metadata-schema-name/--name` parameters in `az apic metadata *` commands to `--metadata-name`. -- Renamed `--environment-name` parameter in `az apic api register` command to `--environment-id`. +* Redesigned `az apic service import-from-apim` command for an easier specification of APIM instances. +* Renamed `az apic service *` commands to `az apic *` commands. +* Renamed `--name/--service/--service-name/-s` parameters in `az apic *` commands to `--name/-n`. +* Renamed `--service/--service-name/-s` parameters in subcommands to `--service-name/-n`. +* Renamed `--metadata-schema/--metadata-schema-name/--name` parameters in `az apic metadata *` commands to `--metadata-name`. +* Renamed `--environment-name` parameter in `az apic api register` command to `--environment-id`. Fixes: -- Ensured API title created by `register` command matches the provided specification. -- Addressed the non-throwing of errors when importing specifications with files larger than 3MB. -- Resolved errors occurring when registering APIs with long descriptions in the specification. -- Made `--definition-id`, `--environment-id`, `--server`, `--title` parameters mandatory in `az apic api deployment create` command. -- Made `--format`, `--specification`, `--value` parameters mandatory in `az apic api definition import-specification` command. + +* Ensured API title created by `register` command matches the provided specification. +* Addressed the non-throwing of errors when importing specifications with files larger than 3MB. +* Resolved errors occurring when registering APIs with long descriptions in the specification. +* Made `--definition-id`, `--environment-id`, `--server`, `--title` parameters mandatory in `az apic api deployment create` command. +* Made `--format`, `--specification`, `--value` parameters mandatory in `az apic api definition import-specification` command. Removals: -- Removed `--state` parameter from `az apic api deployment` commands. -- Eliminated `--file-name` parameter for `az apic api definition import-specification`, `az apic metadata create`, and `az apic metadata update` commands. Introduced usage of the `@filename` syntax for reading parameter values from a file directly in Azure CLI. + +* Removed `--state` parameter from `az apic api deployment` commands. +* Eliminated `--file-name` parameter for `az apic api definition import-specification`, `az apic metadata create`, and `az apic metadata update` commands. Introduced usage of the `@filename` syntax for reading parameter values from a file directly in Azure CLI. 1.0.0b5 ++++++++++++++++++ From 67e673f23213f151fbb057be96b35be2f3f29972 Mon Sep 17 00:00:00 2001 From: Julia Kasper <42241691+juliajuju93@users.noreply.github.com> Date: Fri, 21 Jun 2024 17:48:33 -0700 Subject: [PATCH 05/17] Update HISTORY.rst --- src/apic-extension/HISTORY.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/src/apic-extension/HISTORY.rst b/src/apic-extension/HISTORY.rst index 098deef99f5..b838d8195f7 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -7,12 +7,14 @@ Release History ++++++++++++++++++ Updates: +**Potential Impact**: The updates 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. + * Redesigned `az apic service import-from-apim` command for an easier specification of APIM instances. -* Renamed `az apic service *` commands to `az apic *` commands. -* Renamed `--name/--service/--service-name/-s` parameters in `az apic *` commands to `--name/-n`. -* Renamed `--service/--service-name/-s` parameters in subcommands to `--service-name/-n`. -* Renamed `--metadata-schema/--metadata-schema-name/--name` parameters in `az apic metadata *` commands to `--metadata-name`. -* Renamed `--environment-name` parameter in `az apic api register` command to `--environment-id`. +* **[BREAKING CHANGE]** Renamed `az apic service *` commands to `az apic *` commands. +* **[BREAKING CHANGE]** Renamed `--name/--service/--service-name/-s` parameters in `az apic *` commands to `--name/-n`. +* **[BREAKING CHANGE]** Renamed `--service/--service-name/-s` parameters in subcommands to `--service-name/-n`. +* **[BREAKING CHANGE]** Renamed `--metadata-schema/--metadata-schema-name/--name` parameters in `az apic metadata *` commands to `--metadata-name`. +* **[BREAKING CHANGE]** Renamed `--environment-name` parameter in `az apic api register` command to `--environment-id`. Fixes: From dbe8a5d7f2b325098b83c0697d45c073220fee9f Mon Sep 17 00:00:00 2001 From: Julia Kasper <42241691+juliajuju93@users.noreply.github.com> Date: Fri, 21 Jun 2024 17:49:20 -0700 Subject: [PATCH 06/17] Update HISTORY.rst --- src/apic-extension/HISTORY.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/apic-extension/HISTORY.rst b/src/apic-extension/HISTORY.rst index b838d8195f7..699dbb8d0e9 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -5,18 +5,18 @@ Release History 1.0.0 ++++++++++++++++++ -Updates: +**Updates:** **Potential Impact**: The updates 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. * Redesigned `az apic service import-from-apim` command for an easier specification of APIM instances. -* **[BREAKING CHANGE]** Renamed `az apic service *` commands to `az apic *` commands. +* [BREAKING CHANGE] Renamed `az apic service *` commands to `az apic *` commands. * **[BREAKING CHANGE]** Renamed `--name/--service/--service-name/-s` parameters in `az apic *` commands to `--name/-n`. * **[BREAKING CHANGE]** Renamed `--service/--service-name/-s` parameters in subcommands to `--service-name/-n`. * **[BREAKING CHANGE]** Renamed `--metadata-schema/--metadata-schema-name/--name` parameters in `az apic metadata *` commands to `--metadata-name`. * **[BREAKING CHANGE]** Renamed `--environment-name` parameter in `az apic api register` command to `--environment-id`. -Fixes: +**Fixes:** * Ensured API title created by `register` command matches the provided specification. * Addressed the non-throwing of errors when importing specifications with files larger than 3MB. @@ -24,7 +24,7 @@ Fixes: * Made `--definition-id`, `--environment-id`, `--server`, `--title` parameters mandatory in `az apic api deployment create` command. * Made `--format`, `--specification`, `--value` parameters mandatory in `az apic api definition import-specification` command. -Removals: +**Removals:** * Removed `--state` parameter from `az apic api deployment` commands. * Eliminated `--file-name` parameter for `az apic api definition import-specification`, `az apic metadata create`, and `az apic metadata update` commands. Introduced usage of the `@filename` syntax for reading parameter values from a file directly in Azure CLI. From b7c799d9d43c5d0b5bd1df0fb1b6af66c1a77fea Mon Sep 17 00:00:00 2001 From: Julia Kasper <42241691+juliajuju93@users.noreply.github.com> Date: Fri, 21 Jun 2024 17:50:12 -0700 Subject: [PATCH 07/17] Update HISTORY.rst --- src/apic-extension/HISTORY.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/src/apic-extension/HISTORY.rst b/src/apic-extension/HISTORY.rst index 699dbb8d0e9..ac922bdf30f 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -6,15 +6,14 @@ Release History 1.0.0 ++++++++++++++++++ **Updates:** - -**Potential Impact**: The updates 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. +Potential Impact: The updates 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. * Redesigned `az apic service import-from-apim` command for an easier specification of APIM instances. * [BREAKING CHANGE] Renamed `az apic service *` commands to `az apic *` commands. -* **[BREAKING CHANGE]** Renamed `--name/--service/--service-name/-s` parameters in `az apic *` commands to `--name/-n`. -* **[BREAKING CHANGE]** Renamed `--service/--service-name/-s` parameters in subcommands to `--service-name/-n`. -* **[BREAKING CHANGE]** Renamed `--metadata-schema/--metadata-schema-name/--name` parameters in `az apic metadata *` commands to `--metadata-name`. -* **[BREAKING CHANGE]** Renamed `--environment-name` parameter in `az apic api register` command to `--environment-id`. +* [BREAKING CHANGE] Renamed `--name/--service/--service-name/-s` parameters in `az apic *` commands to `--name/-n`. +* [BREAKING CHANGE] Renamed `--service/--service-name/-s` parameters in subcommands to `--service-name/-n`. +* [BREAKING CHANGE] Renamed `--metadata-schema/--metadata-schema-name/--name` parameters in `az apic metadata *` commands to `--metadata-name`. +* [BREAKING CHANGE] Renamed `--environment-name` parameter in `az apic api register` command to `--environment-id`. **Fixes:** From 28a070e171e185f6e844baec908f0091c430c39f Mon Sep 17 00:00:00 2001 From: Julia Kasper <42241691+juliajuju93@users.noreply.github.com> Date: Fri, 21 Jun 2024 17:50:49 -0700 Subject: [PATCH 08/17] Update HISTORY.rst --- 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 ac922bdf30f..5e271e89fad 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -6,7 +6,7 @@ Release History 1.0.0 ++++++++++++++++++ **Updates:** -Potential Impact: The updates 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. +*Potential Impact: The updates 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.* * Redesigned `az apic service import-from-apim` command for an easier specification of APIM instances. * [BREAKING CHANGE] Renamed `az apic service *` commands to `az apic *` commands. From c3017e23ec1f29c78d2056f6b97a263b457bb1cf Mon Sep 17 00:00:00 2001 From: Julia Kasper <42241691+juliajuju93@users.noreply.github.com> Date: Fri, 21 Jun 2024 17:51:27 -0700 Subject: [PATCH 09/17] Update HISTORY.rst --- 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 5e271e89fad..119adbef4c4 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -6,7 +6,7 @@ Release History 1.0.0 ++++++++++++++++++ **Updates:** -*Potential Impact: The updates 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.* +*The updates 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.* * Redesigned `az apic service import-from-apim` command for an easier specification of APIM instances. * [BREAKING CHANGE] Renamed `az apic service *` commands to `az apic *` commands. From ed46859d751c97fa16cb13572f5af954f75d6211 Mon Sep 17 00:00:00 2001 From: Julia Kasper <42241691+juliajuju93@users.noreply.github.com> Date: Fri, 21 Jun 2024 17:54:31 -0700 Subject: [PATCH 10/17] Update HISTORY.rst --- src/apic-extension/HISTORY.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/apic-extension/HISTORY.rst b/src/apic-extension/HISTORY.rst index 119adbef4c4..7f61da4d491 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -5,7 +5,7 @@ Release History 1.0.0 ++++++++++++++++++ -**Updates:** +###Updates: *The updates 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.* * Redesigned `az apic service import-from-apim` command for an easier specification of APIM instances. @@ -15,7 +15,7 @@ Release History * [BREAKING CHANGE] Renamed `--metadata-schema/--metadata-schema-name/--name` parameters in `az apic metadata *` commands to `--metadata-name`. * [BREAKING CHANGE] Renamed `--environment-name` parameter in `az apic api register` command to `--environment-id`. -**Fixes:** +###Fixes: * Ensured API title created by `register` command matches the provided specification. * Addressed the non-throwing of errors when importing specifications with files larger than 3MB. @@ -23,7 +23,7 @@ Release History * Made `--definition-id`, `--environment-id`, `--server`, `--title` parameters mandatory in `az apic api deployment create` command. * Made `--format`, `--specification`, `--value` parameters mandatory in `az apic api definition import-specification` command. -**Removals:** +###Removals: * Removed `--state` parameter from `az apic api deployment` commands. * Eliminated `--file-name` parameter for `az apic api definition import-specification`, `az apic metadata create`, and `az apic metadata update` commands. Introduced usage of the `@filename` syntax for reading parameter values from a file directly in Azure CLI. From c86b672c514cbcb9a9e25cac173195aab6ee9f9c Mon Sep 17 00:00:00 2001 From: Julia Kasper <42241691+juliajuju93@users.noreply.github.com> Date: Fri, 21 Jun 2024 17:55:23 -0700 Subject: [PATCH 11/17] Update HISTORY.rst --- src/apic-extension/HISTORY.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/apic-extension/HISTORY.rst b/src/apic-extension/HISTORY.rst index 7f61da4d491..119adbef4c4 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -5,7 +5,7 @@ Release History 1.0.0 ++++++++++++++++++ -###Updates: +**Updates:** *The updates 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.* * Redesigned `az apic service import-from-apim` command for an easier specification of APIM instances. @@ -15,7 +15,7 @@ Release History * [BREAKING CHANGE] Renamed `--metadata-schema/--metadata-schema-name/--name` parameters in `az apic metadata *` commands to `--metadata-name`. * [BREAKING CHANGE] Renamed `--environment-name` parameter in `az apic api register` command to `--environment-id`. -###Fixes: +**Fixes:** * Ensured API title created by `register` command matches the provided specification. * Addressed the non-throwing of errors when importing specifications with files larger than 3MB. @@ -23,7 +23,7 @@ Release History * Made `--definition-id`, `--environment-id`, `--server`, `--title` parameters mandatory in `az apic api deployment create` command. * Made `--format`, `--specification`, `--value` parameters mandatory in `az apic api definition import-specification` command. -###Removals: +**Removals:** * Removed `--state` parameter from `az apic api deployment` commands. * Eliminated `--file-name` parameter for `az apic api definition import-specification`, `az apic metadata create`, and `az apic metadata update` commands. Introduced usage of the `@filename` syntax for reading parameter values from a file directly in Azure CLI. From 6a5782cc518235430b53f04c6402eeeb9f800d03 Mon Sep 17 00:00:00 2001 From: Julia Kasper <42241691+juliajuju93@users.noreply.github.com> Date: Fri, 21 Jun 2024 17:56:45 -0700 Subject: [PATCH 12/17] Update HISTORY.rst --- 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 119adbef4c4..fc71a802cee 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -8,7 +8,7 @@ Release History **Updates:** *The updates 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.* -* Redesigned `az apic service import-from-apim` command for an easier specification of APIM instances. +* Redesigned ``az apic service import-from-apim`` command for an easier specification of APIM instances. * [BREAKING CHANGE] Renamed `az apic service *` commands to `az apic *` commands. * [BREAKING CHANGE] Renamed `--name/--service/--service-name/-s` parameters in `az apic *` commands to `--name/-n`. * [BREAKING CHANGE] Renamed `--service/--service-name/-s` parameters in subcommands to `--service-name/-n`. From ec4268f1e1c7ab5fa24fde3ae647d7487f9fb7c8 Mon Sep 17 00:00:00 2001 From: Julia Kasper <42241691+juliajuju93@users.noreply.github.com> Date: Fri, 21 Jun 2024 17:59:12 -0700 Subject: [PATCH 13/17] Update HISTORY.rst --- src/apic-extension/HISTORY.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/src/apic-extension/HISTORY.rst b/src/apic-extension/HISTORY.rst index fc71a802cee..ab1f42d7063 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -9,24 +9,24 @@ Release History *The updates 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.* * Redesigned ``az apic service import-from-apim`` command for an easier specification of APIM instances. -* [BREAKING CHANGE] Renamed `az apic service *` commands to `az apic *` commands. -* [BREAKING CHANGE] Renamed `--name/--service/--service-name/-s` parameters in `az apic *` commands to `--name/-n`. -* [BREAKING CHANGE] Renamed `--service/--service-name/-s` parameters in subcommands to `--service-name/-n`. -* [BREAKING CHANGE] Renamed `--metadata-schema/--metadata-schema-name/--name` parameters in `az apic metadata *` commands to `--metadata-name`. -* [BREAKING CHANGE] Renamed `--environment-name` parameter in `az apic api register` command to `--environment-id`. +* [BREAKING CHANGE] Renamed ``az apic service *`` commands to ``az apic *`` commands. +* [BREAKING CHANGE] Renamed ``--name/--service/--service-name/-s`` parameters in ``az apic *`` commands to ``--name/-n``. +* [BREAKING CHANGE] Renamed ``--service/--service-name/-s`` parameters in subcommands to ``--service-name/-n``. +* [BREAKING CHANGE] Renamed ``--metadata-schema/--metadata-schema-name/--name`` parameters in ``az apic metadata *`` commands to ``--metadata-name``. +* [BREAKING CHANGE] Renamed ``--environment-name`` parameter in ``az apic api register`` command to ``--environment-id``. **Fixes:** -* Ensured API title created by `register` command matches the provided specification. +* Ensured API title created by ``register`` command matches the provided specification. * Addressed the non-throwing of errors when importing specifications with files larger than 3MB. * Resolved errors occurring when registering APIs with long descriptions in the specification. -* Made `--definition-id`, `--environment-id`, `--server`, `--title` parameters mandatory in `az apic api deployment create` command. -* Made `--format`, `--specification`, `--value` parameters mandatory in `az apic api definition import-specification` command. +* Made ``--definition-id``, ``--environment-id``, ``--server``, ``--title`` parameters mandatory in ``az apic api deployment create`` command. +* Made ``--format``, ``--specification``, ``--value`` parameters mandatory in ``az apic api definition import-specification`` command. **Removals:** -* Removed `--state` parameter from `az apic api deployment` commands. -* Eliminated `--file-name` parameter for `az apic api definition import-specification`, `az apic metadata create`, and `az apic metadata update` commands. Introduced usage of the `@filename` syntax for reading parameter values from a file directly in Azure CLI. +* Removed ``--state`` parameter from ``az apic api deployment`` commands. +* Eliminated ``--file-name`` parameter for ``az apic api definition import-specification``, ``az apic metadata create``, and ``az apic metadata update`` commands. Introduced usage of the ``@filename`` syntax for reading parameter values from a file directly in Azure CLI. 1.0.0b5 ++++++++++++++++++ From ef9b693be0cda029f2b6cddf999c4efa7393feb5 Mon Sep 17 00:00:00 2001 From: Julia Kasper <42241691+juliajuju93@users.noreply.github.com> Date: Fri, 21 Jun 2024 18:00:56 -0700 Subject: [PATCH 14/17] Update HISTORY.rst --- src/apic-extension/HISTORY.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/apic-extension/HISTORY.rst b/src/apic-extension/HISTORY.rst index ab1f42d7063..581d2efb8e1 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -20,13 +20,13 @@ Release History * Ensured API title created by ``register`` command matches the provided specification. * Addressed the non-throwing of errors when importing specifications with files larger than 3MB. * Resolved errors occurring when registering APIs with long descriptions in the specification. -* Made ``--definition-id``, ``--environment-id``, ``--server``, ``--title`` parameters mandatory in ``az apic api deployment create`` command. -* Made ``--format``, ``--specification``, ``--value`` parameters mandatory in ``az apic api definition import-specification`` command. +* [BREAKING CHANGE] Made ``--definition-id``, ``--environment-id``, ``--server``, ``--title`` parameters mandatory in ``az apic api deployment create`` command. +* [BREAKING CHANGE] Made ``--format``, ``--specification``, ``--value`` parameters mandatory in ``az apic api definition import-specification`` command. **Removals:** * Removed ``--state`` parameter from ``az apic api deployment`` commands. -* Eliminated ``--file-name`` parameter for ``az apic api definition import-specification``, ``az apic metadata create``, and ``az apic metadata update`` commands. Introduced usage of the ``@filename`` syntax for reading parameter values from a file directly in Azure CLI. +* [BREAKING CHANGE] Eliminated ``--file-name`` parameter for ``az apic api definition import-specification``, ``az apic metadata create``, and ``az apic metadata update`` commands. Introduced usage of the ``@filename`` syntax for reading parameter values from a file directly in Azure CLI. 1.0.0b5 ++++++++++++++++++ From cf1d82db159ec5fb7b84cc928f05d20cb7723eb4 Mon Sep 17 00:00:00 2001 From: Julia Kasper <42241691+juliajuju93@users.noreply.github.com> Date: Fri, 21 Jun 2024 18:01:46 -0700 Subject: [PATCH 15/17] Update HISTORY.rst --- src/apic-extension/HISTORY.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/apic-extension/HISTORY.rst b/src/apic-extension/HISTORY.rst index 581d2efb8e1..ce2ebd68db5 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -5,8 +5,9 @@ Release History 1.0.0 ++++++++++++++++++ +**Potential Impact**: The updates/fixes/removals 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:** -*The updates 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.* * Redesigned ``az apic service import-from-apim`` command for an easier specification of APIM instances. * [BREAKING CHANGE] Renamed ``az apic service *`` commands to ``az apic *`` commands. From 3c7d9727c8baa42b5f1a24afff68af28f624dcd0 Mon Sep 17 00:00:00 2001 From: Julia Kasper <42241691+juliajuju93@users.noreply.github.com> Date: Fri, 21 Jun 2024 18:02:09 -0700 Subject: [PATCH 16/17] Update HISTORY.rst --- 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 ce2ebd68db5..76fd81df8cc 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -5,7 +5,7 @@ Release History 1.0.0 ++++++++++++++++++ -**Potential Impact**: The updates/fixes/removals 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. +**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:** From 9e85eac0ce79504f67b5ece153572b4dfdda7aeb Mon Sep 17 00:00:00 2001 From: Julia Kasper <42241691+juliajuju93@users.noreply.github.com> Date: Fri, 21 Jun 2024 18:04:02 -0700 Subject: [PATCH 17/17] Update HISTORY.rst --- 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 76fd81df8cc..9587ffbdf4d 100644 --- a/src/apic-extension/HISTORY.rst +++ b/src/apic-extension/HISTORY.rst @@ -5,7 +5,7 @@ Release History 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. +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:**