You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by "soreana (via GitHub)" <gi...@apache.org> on 2023/08/16 15:23:52 UTC
[GitHub] [cloudstack] soreana opened a new pull request, #7876: Api command descriptions
soreana opened a new pull request, #7876:
URL: https://github.com/apache/cloudstack/pull/7876
### Description
This PR fixes the issue #7776 and the spelling issues mentioned in: https://github.com/apache/cloudstack-go/pull/64
<!-- For new features, provide link to FS, dev ML discussion etc. -->
<!-- In case of bug fix, the expected and actual behaviours, steps to reproduce. -->
<!-- When "Fixes: #<id>" is specified, the issue/PR will automatically be closed when this PR gets merged -->
<!-- For addressing multiple issues/PRs, use multiple "Fixes: #<id>" -->
<!-- Fixes: # -->
<!--- ********************************************************************************* -->
<!--- NOTE: AUTOMATATION USES THE DESCRIPTIONS TO SET LABELS AND PRODUCE DOCUMENTATION. -->
<!--- PLEASE PUT AN 'X' in only **ONE** box -->
<!--- ********************************************************************************* -->
### Types of changes
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] Enhancement (improves an existing feature and functionality)
- [x] Cleanup (Code refactoring and cleanup, that may add test cases)
### Feature/Enhancement Scale or Bug Severity
#### Feature/Enhancement Scale
- [ ] Major
- [x] Minor
#### Bug Severity
- [ ] BLOCKER
- [ ] Critical
- [ ] Major
- [ ] Minor
- [x] Trivial
### How Has This Been Tested?
<!-- Please describe in detail how you tested your changes. -->
<!-- Include details of your testing environment, and the tests you ran to -->
<!-- see how your change affects other areas of the code, etc. -->
This PR doesn't need specific testing, it only changes some api call descriptions.
<!-- Please read the [CONTRIBUTING](https://github.com/apache/cloudstack/blob/main/CONTRIBUTING.md) document -->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [cloudstack] soreana commented on pull request #7876: Api command descriptions
Posted by "soreana (via GitHub)" <gi...@apache.org>.
soreana commented on PR #7876:
URL: https://github.com/apache/cloudstack/pull/7876#issuecomment-1680837748
@blueorangutan package
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [cloudstack] blueorangutan commented on pull request #7876: Api command descriptions
Posted by "blueorangutan (via GitHub)" <gi...@apache.org>.
blueorangutan commented on PR #7876:
URL: https://github.com/apache/cloudstack/pull/7876#issuecomment-1682043831
@soreana a [SF] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [cloudstack] soreana commented on pull request #7876: Api command descriptions
Posted by "soreana (via GitHub)" <gi...@apache.org>.
soreana commented on PR #7876:
URL: https://github.com/apache/cloudstack/pull/7876#issuecomment-1682042108
Thanks @weizhouapache I've updated the pr, let me know if it requires more changes.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [cloudstack] soreana commented on a diff in pull request #7876: Api: update command domainId/account descriptions
Posted by "soreana (via GitHub)" <gi...@apache.org>.
soreana commented on code in PR #7876:
URL: https://github.com/apache/cloudstack/pull/7876#discussion_r1298445699
##########
api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkCmd.java:
##########
@@ -118,7 +118,9 @@ public class CreateNetworkCmd extends BaseCmd implements UserCmd {
private Long projectId;
@Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "domain ID of the account owning a network. " +
- "If no account is provided then network will be assigned to the caller account and domain")
+ "If the account or acltype is not specified, the network will be automatically assigned to the caller account and domain. " +
Review Comment:
Done π
##########
api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkCmd.java:
##########
@@ -118,7 +118,9 @@ public class CreateNetworkCmd extends BaseCmd implements UserCmd {
private Long projectId;
@Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "domain ID of the account owning a network. " +
- "If no account is provided then network will be assigned to the caller account and domain")
+ "If the account or acltype is not specified, the network will be automatically assigned to the caller account and domain. " +
Review Comment:
Done π
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [cloudstack] blueorangutan commented on pull request #7876: Api command descriptions
Posted by "blueorangutan (via GitHub)" <gi...@apache.org>.
blueorangutan commented on PR #7876:
URL: https://github.com/apache/cloudstack/pull/7876#issuecomment-1680838109
@soreana a [SF] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [cloudstack] blueorangutan commented on pull request #7876: Api command descriptions
Posted by "blueorangutan (via GitHub)" <gi...@apache.org>.
blueorangutan commented on PR #7876:
URL: https://github.com/apache/cloudstack/pull/7876#issuecomment-1680922353
Packaging result [SF]: :heavy_check_mark: el7 :heavy_check_mark: el8 :heavy_check_mark: el9 :heavy_check_mark: debian :heavy_check_mark: suse15. SL-JID 6805
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [cloudstack] DaanHoogland commented on pull request #7876: Api: update command domainId/account descriptions
Posted by "DaanHoogland (via GitHub)" <gi...@apache.org>.
DaanHoogland commented on PR #7876:
URL: https://github.com/apache/cloudstack/pull/7876#issuecomment-1685289366
only parameter description fields have changed, merging
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [cloudstack] soreana commented on pull request #7876: Api command descriptions
Posted by "soreana (via GitHub)" <gi...@apache.org>.
soreana commented on PR #7876:
URL: https://github.com/apache/cloudstack/pull/7876#issuecomment-1682042499
@blueorangutan package
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [cloudstack] weizhouapache commented on a diff in pull request #7876: Api command descriptions
Posted by "weizhouapache (via GitHub)" <gi...@apache.org>.
weizhouapache commented on code in PR #7876:
URL: https://github.com/apache/cloudstack/pull/7876#discussion_r1296157976
##########
api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkCmd.java:
##########
@@ -118,7 +118,8 @@ public class CreateNetworkCmd extends BaseCmd implements UserCmd {
private Long projectId;
@Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "domain ID of the account owning a network. " +
- "If no account is provided then network will be assigned to the caller account and domain")
+ "If the account or acltype is not specified, the network will be automatically assigned to the caller account and domain." +
+ "To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in your api call.")
Review Comment:
your -> the ?
##########
api/src/main/java/org/apache/cloudstack/api/command/user/volume/UploadVolumeCmd.java:
##########
@@ -78,7 +78,7 @@ public class UploadVolumeCmd extends BaseAsyncCmd implements UserCmd {
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "an optional domainId. If the account parameter is used, domainId must also be used.")
+ description = "an optional domainId. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.")
Review Comment:
volume , not virtual machine
##########
api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkCmd.java:
##########
@@ -118,7 +118,8 @@ public class CreateNetworkCmd extends BaseCmd implements UserCmd {
private Long projectId;
@Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "domain ID of the account owning a network. " +
- "If no account is provided then network will be assigned to the caller account and domain")
+ "If the account or acltype is not specified, the network will be automatically assigned to the caller account and domain." +
Review Comment:
if account is not specified, but acltype is Domain, the network will be created for the specified domain.
##########
api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotCmd.java:
##########
@@ -62,7 +62,7 @@ public class CreateSnapshotCmd extends BaseAsyncCreateCmd {
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume.")
+ description = "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. If account is NOT provided then virtual machine will be assigned to the caller account and domain.")
Review Comment:
snapshot
##########
api/src/main/java/org/apache/cloudstack/api/command/user/volume/CreateVolumeCmd.java:
##########
@@ -70,7 +70,8 @@ public class CreateVolumeCmd extends BaseAsyncCreateCustomIdCmd implements UserC
type = CommandType.UUID,
entityType = DomainResponse.class,
description = "the domain ID associated with the disk offering. If used with the account parameter"
- + " returns the disk volume associated with the account for the specified domain.")
+ + " returns the disk volume associated with the account for the specified domain." +
+ "If account is NOT provided then virtual machine will be assigned to the caller account and domain.")
Review Comment:
volume , not virtual machine
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [cloudstack] codecov[bot] commented on pull request #7876: Api command descriptions
Posted by "codecov[bot] (via GitHub)" <gi...@apache.org>.
codecov[bot] commented on PR #7876:
URL: https://github.com/apache/cloudstack/pull/7876#issuecomment-1680929375
## [Codecov](https://app.codecov.io/gh/apache/cloudstack/pull/7876?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
> Merging [#7876](https://app.codecov.io/gh/apache/cloudstack/pull/7876?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) (be93a38) into [4.18](https://app.codecov.io/gh/apache/cloudstack/commit/72e3491cefa1e51d2c884dfe36a637a25adbfba4?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) (72e3491) will **not change** coverage.
> Report is 5 commits behind head on 4.18.
> The diff coverage is `n/a`.
```diff
@@ Coverage Diff @@
## 4.18 #7876 +/- ##
=========================================
Coverage 13.02% 13.02%
Complexity 9039 9039
=========================================
Files 2720 2720
Lines 257094 257094
Branches 40092 40092
=========================================
Hits 33489 33489
Misses 219401 219401
Partials 4204 4204
```
| [Files Changed](https://app.codecov.io/gh/apache/cloudstack/pull/7876?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) | Coverage Ξ | |
|---|---|---|
| [.../api/command/admin/ratelimit/ResetApiLimitCmd.java](https://app.codecov.io/gh/apache/cloudstack/pull/7876?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-cGx1Z2lucy9hcGkvcmF0ZS1saW1pdC9zcmMvbWFpbi9qYXZhL29yZy9hcGFjaGUvY2xvdWRzdGFjay9hcGkvY29tbWFuZC9hZG1pbi9yYXRlbGltaXQvUmVzZXRBcGlMaW1pdENtZC5qYXZh) | `0.00% <ΓΈ> (ΓΈ)` | |
| [...tungsten/api/command/ListTungstenFabricTagCmd.java](https://app.codecov.io/gh/apache/cloudstack/pull/7876?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-cGx1Z2lucy9uZXR3b3JrLWVsZW1lbnRzL3R1bmdzdGVuL3NyYy9tYWluL2phdmEvb3JnL2FwYWNoZS9jbG91ZHN0YWNrL25ldHdvcmsvdHVuZ3N0ZW4vYXBpL2NvbW1hbmQvTGlzdFR1bmdzdGVuRmFicmljVGFnQ21kLmphdmE=) | `0.00% <ΓΈ> (ΓΈ)` | |
| [...e/datastore/util/ListElastistorVolumeResponse.java](https://app.codecov.io/gh/apache/cloudstack/pull/7876?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-cGx1Z2lucy9zdG9yYWdlL3ZvbHVtZS9jbG91ZGJ5dGUvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2Nsb3Vkc3RhY2svc3RvcmFnZS9kYXRhc3RvcmUvdXRpbC9MaXN0RWxhc3Rpc3RvclZvbHVtZVJlc3BvbnNlLmphdmE=) | `0.00% <ΓΈ> (ΓΈ)` | |
| [...dstack/api/response/LdapConfigurationResponse.java](https://app.codecov.io/gh/apache/cloudstack/pull/7876?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-cGx1Z2lucy91c2VyLWF1dGhlbnRpY2F0b3JzL2xkYXAvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2Nsb3Vkc3RhY2svYXBpL3Jlc3BvbnNlL0xkYXBDb25maWd1cmF0aW9uUmVzcG9uc2UuamF2YQ==) | `0.00% <ΓΈ> (ΓΈ)` | |
| [...dstack/api/response/LinkAccountToLdapResponse.java](https://app.codecov.io/gh/apache/cloudstack/pull/7876?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-cGx1Z2lucy91c2VyLWF1dGhlbnRpY2F0b3JzL2xkYXAvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2Nsb3Vkc3RhY2svYXBpL3Jlc3BvbnNlL0xpbmtBY2NvdW50VG9MZGFwUmVzcG9uc2UuamF2YQ==) | `93.33% <ΓΈ> (ΓΈ)` | |
| [...udstack/api/response/LinkDomainToLdapResponse.java](https://app.codecov.io/gh/apache/cloudstack/pull/7876?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-cGx1Z2lucy91c2VyLWF1dGhlbnRpY2F0b3JzL2xkYXAvc3JjL21haW4vamF2YS9vcmcvYXBhY2hlL2Nsb3Vkc3RhY2svYXBpL3Jlc3BvbnNlL0xpbmtEb21haW5Ub0xkYXBSZXNwb25zZS5qYXZh) | `85.71% <ΓΈ> (ΓΈ)` | |
| [...loud/api/auth/DefaultLoginAPIAuthenticatorCmd.java](https://app.codecov.io/gh/apache/cloudstack/pull/7876?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache#diff-c2VydmVyL3NyYy9tYWluL2phdmEvY29tL2Nsb3VkL2FwaS9hdXRoL0RlZmF1bHRMb2dpbkFQSUF1dGhlbnRpY2F0b3JDbWQuamF2YQ==) | `0.00% <ΓΈ> (ΓΈ)` | |
... and [1 file with indirect coverage changes](https://app.codecov.io/gh/apache/cloudstack/pull/7876/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)
:mega: Weβre building smart automated test selection to slash your CI/CD build times. [Learn more](https://about.codecov.io/iterative-testing/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [cloudstack] blueorangutan commented on pull request #7876: Api command descriptions
Posted by "blueorangutan (via GitHub)" <gi...@apache.org>.
blueorangutan commented on PR #7876:
URL: https://github.com/apache/cloudstack/pull/7876#issuecomment-1682118297
Packaging result [SF]: :heavy_check_mark: el7 :heavy_check_mark: el8 :heavy_check_mark: el9 :heavy_check_mark: debian :heavy_check_mark: suse15. SL-JID 6817
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [cloudstack] weizhouapache commented on a diff in pull request #7876: Api command descriptions
Posted by "weizhouapache (via GitHub)" <gi...@apache.org>.
weizhouapache commented on code in PR #7876:
URL: https://github.com/apache/cloudstack/pull/7876#discussion_r1298101926
##########
api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkCmd.java:
##########
@@ -118,7 +118,9 @@ public class CreateNetworkCmd extends BaseCmd implements UserCmd {
private Long projectId;
@Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "domain ID of the account owning a network. " +
- "If no account is provided then network will be assigned to the caller account and domain")
+ "If the account or acltype is not specified, the network will be automatically assigned to the caller account and domain. " +
Review Comment:
line 121 could be more clear like
```
"If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. " +
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [cloudstack] DaanHoogland merged pull request #7876: Api: update command domainId/account descriptions
Posted by "DaanHoogland (via GitHub)" <gi...@apache.org>.
DaanHoogland merged PR #7876:
URL: https://github.com/apache/cloudstack/pull/7876
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@cloudstack.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org