feat: Use 03-01 spec from azure-rest-api-specs repo to regenerate CLI #19
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Owner
blackchoey
commented
Apr 22, 2024
blackchoey
commented
- Use 03-01 spec from https://github.com/Azure/azure-rest-api-specs/blob/main/specification/apicenter/resource-manager/Microsoft.ApiCenter/stable/2024-03-01/apicenter.json to regenerate CLI
- I made some patches to the spec for following reasons, related change can be found at patch API Center 2024-03-01 spec to workaround bugs from typespec azure-rest-api-specs#1
- There're 2 bugs from typespec that causes some parameters been treated as option, and parameters for update commands being deleted
- The 03-01 spec does not have importFromApim API definition
blackchoey
commented
Apr 22, 2024
| @@ -309,7 +312,7 @@ def content(self): | |||
| typ=AAZObjectType, | |||
| typ_kwargs={"flags": {"required": True, "client_flatten": True}} | |||
| ) | |||
| _builder.set_prop("properties", AAZObjectType, typ_kwargs={"flags": {"client_flatten": True}}) | |||
| _builder.set_prop("properties", AAZObjectType, ".", typ_kwargs={"flags": {"required": True, "client_flatten": True}}) | |||
There was a problem hiding this comment.
expected change due to the manual workaround of typespec bug
blackchoey
commented
Apr 22, 2024
| @@ -379,7 +382,7 @@ def _build_schema_on_200_201(cls): | |||
| flags={"read_only": True}, | |||
| ) | |||
| _schema_on_200_201.properties = AAZObjectType( | |||
| flags={"client_flatten": True}, | |||
| flags={"required": True, "client_flatten": True}, | |||
There was a problem hiding this comment.
expected change due to the manual workaround of typespec bug
blackchoey
commented
Apr 22, 2024
| @@ -49,6 +49,7 @@ def _build_arguments_schema(cls, *args, **kwargs): | |||
| help="The id of the API.", | |||
| required=True, | |||
| fmt=AAZStrArgFormat( | |||
| pattern="^[a-zA-Z0-9-]{3,90}$", | |||
There was a problem hiding this comment.
expected change as the new API spec provides constraints for the value
blackchoey
commented
Apr 22, 2024
| @@ -184,7 +186,7 @@ def _build_schema_on_200(cls): | |||
| flags={"read_only": True}, | |||
| ) | |||
| _schema_on_200.value = AAZListType( | |||
| flags={"read_only": True}, | |||
| flags={"required": True, "read_only": True}, | |||
There was a problem hiding this comment.
expected change because the new API spec marks this property as required
blackchoey
commented
Apr 22, 2024
| @@ -151,9 +151,10 @@ def _build_schema_on_200(cls): | |||
| _schema_on_200 = cls._schema_on_200 | |||
| _schema_on_200.next_link = AAZStrType( | |||
| serialized_name="nextLink", | |||
| flags={"read_only": True}, | |||
There was a problem hiding this comment.
expected change as the API spec marks the property as readonly
formulahendry
approved these changes
Apr 22, 2024
blackchoey
added a commit
that referenced
this pull request
Apr 29, 2024
* fix: --title --kind --custom-property parameters (#1) * feat: support yaml file in register command (#3) * fix: workspace parameter should not be required (#2) * style: fix lint issues (#6) * chore: update codeowner for apic-extension (#5) * feat: revert changes to min cli version (#4) * feat: resolve comments to CLI experience (#10) * feat: mark "apic api register" command as preview (#13) * feat: remove --terms-of-service parameter (#12) * feat: remove --workspace-name parameter (#11) * feat: support python 3.8 and 3.9 (#14) * feat: fix command descriptions (#17) * tests: add test cases for 'apic service' commands (#16) * feat: Use 03-01 spec from azure-rest-api-specs repo to regenerate CLI (#19) * fix: CLI errors (#20) * fix: import error when run CLI command * fix: no workspace name error when run import specification command * feat: mark some parameters as required (#21) * feat: mark --assignments parameter required for metadata commands * doc: update sample commands * feat: mark --source-resource-ids parameter as required for import-from-apim command * doc: update description for import-from-apim command * feat: bump version to 1.0.0b5 and update changelog (#18) * build: fix ci (#22) * style: fix style warnings * test:fix test cases * fix: service update command failure (#28) * doc: fix command samples (#30) * doc: update changelog per feedback (#29) * doc: remove extra spaces in register command help message (#34) * doc: update api definition and metadata command samples (#36)
blackchoey
added a commit
that referenced
this pull request
Apr 29, 2024
* fix: --title --kind --custom-property parameters (#1) * feat: support yaml file in register command (#3) * fix: workspace parameter should not be required (#2) * style: fix lint issues (#6) * chore: update codeowner for apic-extension (#5) * feat: revert changes to min cli version (#4) * feat: resolve comments to CLI experience (#10) * feat: mark "apic api register" command as preview (#13) * feat: remove --terms-of-service parameter (#12) * feat: remove --workspace-name parameter (#11) * feat: support python 3.8 and 3.9 (#14) * feat: fix command descriptions (#17) * tests: add test cases for 'apic service' commands (#16) * feat: Use 03-01 spec from azure-rest-api-specs repo to regenerate CLI (#19) * fix: CLI errors (#20) * fix: import error when run CLI command * fix: no workspace name error when run import specification command * feat: mark some parameters as required (#21) * feat: mark --assignments parameter required for metadata commands * doc: update sample commands * feat: mark --source-resource-ids parameter as required for import-from-apim command * doc: update description for import-from-apim command * feat: bump version to 1.0.0b5 and update changelog (#18) * build: fix ci (#22) * style: fix style warnings * test:fix test cases * fix: service update command failure (#28) * doc: fix command samples (#30) * doc: update changelog per feedback (#29) * doc: remove extra spaces in register command help message (#34) * doc: update api definition and metadata command samples (#36)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.