Skip to content

Fixes for code review comments from https://github.com/Azure/azure-rest-api-specs/pull/752 #761

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.

Sign up for GitHub

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

Merged
fearthecowboy merged 8 commits into from
Jan 18, 2017
Merged

Fixes for code review comments from https://github.com/Azure/azure-rest-api-specs/pull/752 #761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c8391a5
Fixes for code review comments
Nov 24, 2016
c26c550
Make resourcegroup the first parameter if applicable.
Nov 24, 2016
66457e2
Address CR comments from https://github.com/Azure/azure-rest-api-spec…
Dec 1, 2016
8f3244d
Merge remote-tracking branch 'upstream/master'
Dec 1, 2016
794b910
Merge remote-tracking branch 'upstream/master'
Dec 13, 2016
8012acb
Address more comments on PR
Dec 13, 2016
7b662e5
Merge remote-tracking branch 'upstream/master'
Jan 17, 2017
68306ef
Fix HTTP status codes for start/stop/restart app and deployment slots…
Jan 17, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 54 additions & 107 deletions arm-web/2015-04-01/Domains.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@
"summary": "Get all domains in a subscription.",
"description": "Get all domains in a subscription.",
"operationId": "Domains_List",
"consumes": [],
"produces": [
"application/json",
"text/json"
Expand Down Expand Up @@ -99,7 +98,6 @@
"summary": "Generate a single sign-on request for the domain management portal.",
"description": "Generate a single sign-on request for the domain management portal.",
"operationId": "Domains_GetControlCenterSsoRequest",
"consumes": [],
"produces": [
"application/json",
"text/json",
Expand Down Expand Up @@ -181,17 +179,16 @@
"summary": "Get all domains in a resource group.",
"description": "Get all domains in a resource group.",
"operationId": "Domains_ListByResourceGroup",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"$ref": "#/parameters/subscriptionIdParameter"
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
Expand All @@ -218,14 +215,16 @@
"summary": "Get a domain.",
"description": "Get a domain.",
"operationId": "Domains_Get",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"name": "domainName",
"in": "path",
Expand All @@ -236,9 +235,6 @@
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
Expand All @@ -256,8 +252,8 @@
"tags": [
"Domains"
],
"summary": "Create a domain.",
"description": "Create a domain.",
"summary": "Creates or updates a domain.",
"description": "Creates or updates a domain.",
"operationId": "Domains_CreateOrUpdate",
"consumes": [
"application/json",
Expand All @@ -271,12 +267,16 @@
"text/xml"
],
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"name": "domainName",
"in": "path",
"description": "Name of the domain.",
"required": true,
"type": "string"
"type": "string",
"pattern": "[a-zA-Z0-9][a-zA-Z0-9\\.-]+"
},
{
"name": "domain",
Expand All @@ -290,9 +290,6 @@
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
Expand Down Expand Up @@ -320,9 +317,10 @@
"summary": "Delete a domain.",
"description": "Delete a domain.",
"operationId": "Domains_Delete",
"consumes": [],
"produces": [],
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"name": "domainName",
"in": "path",
Expand All @@ -339,9 +337,6 @@
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
Expand All @@ -364,12 +359,14 @@
"summary": "Lists domain ownership identifiers.",
"description": "Lists domain ownership identifiers.",
"operationId": "Domains_ListOwnershipIdentifiers",
"consumes": [],
"produces": [
"application/json",
"text/json"
],
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"name": "domainName",
"in": "path",
Expand All @@ -380,9 +377,6 @@
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
Expand All @@ -408,14 +402,16 @@
"summary": "Get ownership identifier for domain",
"description": "Get ownership identifier for domain",
"operationId": "Domains_GetOwnershipIdentifier",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"name": "domainName",
"in": "path",
Expand All @@ -433,9 +429,6 @@
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
Expand Down Expand Up @@ -468,6 +461,9 @@
"text/xml"
],
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"name": "domainName",
"in": "path",
Expand All @@ -494,9 +490,6 @@
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
Expand All @@ -517,9 +510,10 @@
"summary": "Delete ownership identifier for domain",
"description": "Delete ownership identifier for domain",
"operationId": "Domains_DeleteOwnershipIdentifier",
"consumes": [],
"produces": [],
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"name": "domainName",
"in": "path",
Expand All @@ -537,9 +531,6 @@
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
Expand Down Expand Up @@ -572,6 +563,9 @@
"text/xml"
],
"parameters": [
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"name": "domainName",
"in": "path",
Expand All @@ -598,9 +592,6 @@
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
Expand All @@ -614,70 +605,18 @@
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/operationresults/{operationId}": {
"get": {
"tags": [
"Domains"
],
"summary": "Get the status of a domain purchase operation.",
"description": "Get the status of a domain purchase operation.",
"operationId": "Domains_GetOperation",
"consumes": [],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"parameters": [
{
"name": "domainName",
"in": "path",
"description": "Name of the domain.",
"required": true,
"type": "string"
},
{
"name": "operationId",
"in": "path",
"description": "ID of the domain purchase operation.",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/subscriptionIdParameter"
},
{
"$ref": "#/parameters/resourceGroupNameParameter"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
],
"responses": {
"202": {
"description": "Domain purchase is in progress.",
"schema": {
"$ref": "#/definitions/Domain"
}
},
"200": {
"description": "Domain purchase was successful.",
"schema": {
"$ref": "#/definitions/Domain"
}
},
"500": {
"description": "Domain purchase request failed."
}
}
}
}
},
"definitions": {
"Address": {
"description": "Address information for domain registration.",
"required": [
"address1",
"city",
"country",
"postalCode",
"state"
],
Copy link
Copy Markdown
Contributor

@amarzavery amarzavery Nov 24, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@naveedaz: General comment: Since webapp has a big surface area for their APIs, there are lot of objects. It is hard for us to cover all the objects manually. It would be nice if the individual service teams would diligently mark the model properties as required or provide default values or mark them readOnly wherever necessary. The intent of the initial code review was to get this message across.
What are the required properties of the "Contact" object? Currently everything is optional. It is hard to believe that everything is optional. The service would definitely want some required properties in the "Contact" model
These are the following properties:

"properties": {
  "addressMailing": {
   "$ref": "#/definitions/Address",
   "description": "Mailing address."
  },
  "email": {
   "description": "Email address.",
   "type": "string"
  },
  "fax": {
   "description": "Fax number.",
   "type": "string"
  },
  "jobTitle": {
   "description": "Job title.",
   "type": "string"
  },
  "nameFirst": {
   "description": "First name.",
   "type": "string"
  },
  "nameLast": {
   "description": "Last name.",
   "type": "string"
  },
  "nameMiddle": {
   "description": "Middle name.",
   "type": "string"
  },
  "organization": {
   "description": "Organization.",
   "type": "string"
  },
  "phone": {
   "description": "Phone number.",
   "type": "string"
  }
}

"type": "object",
"properties": {
"address1": {
Expand Down Expand Up @@ -707,7 +646,13 @@
}
},
"Contact": {
"description": "Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \r\n directories as per ICANN requirements.",
"description": "Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \n directories as per ICANN requirements.",
"required": [
"email",
"nameFirst",
"nameLast",
"phone"
],
"type": "object",
"properties": {
"addressMailing": {
Expand Down Expand Up @@ -878,7 +823,7 @@
"type": "boolean"
},
"readyForDnsRecordManagement": {
"description": "<code>true</code> if Azure can assign this domain to App Service apps; otherwise, <code>false</code>. This value will be <code>true</code> if domain registration status is active and \r\n it is hosted on name servers Azure has programmatic access to.",
"description": "<code>true</code> if Azure can assign this domain to App Service apps; otherwise, <code>false</code>. This value will be <code>true</code> if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to.",
"type": "boolean",
"readOnly": true
},
Expand Down Expand Up @@ -926,7 +871,7 @@
"type": "boolean"
},
"domainType": {
"description": "Domain type.",
"description": "Valid values are Regular domain: Azure will charge the full price of domain registration, SoftDeleted: Purchasing this domain will simply restore it and this operation will not cost anything.",
"enum": [
"Regular",
"SoftDeleted"
Expand Down Expand Up @@ -965,15 +910,18 @@
"properties": {
"url": {
"description": "URL where the single sign-on request is to be made.",
"type": "string"
"type": "string",
"readOnly": true
},
"postParameterKey": {
"description": "Post parameter key.",
"type": "string"
"type": "string",
"readOnly": true
},
"postParameterValue": {
"description": "Post parameter value. Client should use 'application/x-www-form-urlencoded' encoding for this value.",
"type": "string"
"type": "string",
"readOnly": true
}
}
},
Expand Down Expand Up @@ -1145,8 +1093,7 @@
"Resource": {
"description": "Azure resource.",
"required": [
"location",
"name"
"location"
],
"properties": {
"id": {
Expand Down Expand Up @@ -1198,7 +1145,7 @@
"type": "string",
"maxLength": 90,
"minLength": 1,
"pattern": "^[-\\\\w\\\\._\\\\(\\\\)]+[^\\\\.]$"
"pattern": "^[-\\w\\._\\(\\)]+[^\\.]$"
},
"apiVersionParameter": {
"name": "api-version",
Expand Down
Loading