-
Notifications
You must be signed in to change notification settings - Fork 2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Ready for review] Added CDN Profiles to fluent #1257
Conversation
# Conflicts: # azure/src/main/java/com/microsoft/azure/management/Azure.java
Wrapper<EndpointInner> { | ||
|
||
/** | ||
* Get the originHostHeader value. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We use the 3rd person declarative mood for member descriptions, so "Gets" not "Get", "Specifies" not "Specify", etc.
pls scrub the Javadocs to get them consistent with that. thx
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed everywhere in CDN public interfaces
/** | ||
* Get the originHostHeader value. | ||
* | ||
* @return the originHostHeader value |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is not a user-facing statement, as it is meaningless. i know this is the wording in the auto-gen'd one. We need to make it sound user-facing. i.e "origin host header" not "originHostHeader" value. pls scrub the javadocs with this in mind.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed everywhere.
/** | ||
* Get the isHttpsAllowed value. | ||
* | ||
* @return the isHttpsAllowed value |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
for the Boolean, one descriptive way would be to say "true is HTTP is allowed, else false"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed.
Wrapper<EndpointInner> { | ||
|
||
/** | ||
* Get the originHostHeader value. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We use the 3rd person declarative mood for member descriptions, so "Gets" not "Get", "Specifies" not "Specify", etc.
pls scrub the Javadocs to get them consistent with that. thx
Btw - on parameters properties returning a value, we don't need the description, just the @return, so:
@return origin host header
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed
*/ | ||
interface PremiumEndpoint<ParentT> { | ||
/** | ||
* Specifies the Origin of the CDN Endpoint. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there is no need to capitalize "origin"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed
} | ||
} | ||
|
||
/** The final stage of the CDN profile Standard Akamai or Standard Verizone endpoint definition. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Verizon misspelled
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed
WithStandardAttach<ParentT> withCustomDomain(String hostName); | ||
} | ||
|
||
/** The final stage of the CDN profile Premium Verizone endpoint definition. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pls correct all occurrences of the misspelled "Verizone"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed
UpdateDefinitionStages.WithStandardAttach<ParentT> withOrigin(String originName, String originHostName); | ||
|
||
/** | ||
* Specifies the Origin of the CDN Endpoint. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no need to capitalize "origin"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed
* @param profileName Name of the CDN profile which is unique within the resource group. | ||
* @param endpointName Name of the endpoint under the profile which is unique globally. | ||
*/ | ||
void endpointStart(String resourceGroupName, String profileName, String endpointName); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
method names that indicate action start with a verb, not noun --> startEndpoint()
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed
* @param profileName Name of the CDN profile which is unique within the resource group. | ||
* @param endpointName Name of the endpoint under the profile which is unique globally. | ||
*/ | ||
void endpointStop(String resourceGroupName, String profileName, String endpointName); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
stopEndpoint(...)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed
* @param endpointName Name of the endpoint under the profile which is unique globally. | ||
* @param contentPaths The path to the content to be purged. Can describe a file path or a wild card directory. | ||
*/ | ||
void endpointPurgeContent(String resourceGroupName, String profileName, String endpointName, List<String> contentPaths); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
--> purgeEndpointContent(...)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed
* @param endpointName Name of the endpoint under the profile which is unique globally. | ||
* @param contentPaths The path to the content to be loaded. Should describe a file path. | ||
*/ | ||
void endpointLoadContent(String resourceGroupName, String profileName, String endpointName, List<String> contentPaths); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
--> loadEndpointContent(...)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed
@@ -0,0 +1,65 @@ | |||
/** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in the future, pls do not include auto-gen'd code with hand-written code in the same PR. Makes full code reviews pretty much impossible :-)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could we pls have this PR split into PR with auto-gen'd code and PR with hand-written code? Having them all mixed together makes a proper code review pretty much impossible :-)
Working on rebase to split generated and handcrafted files in two separate commits that will make code review easier... |
No description provided.