Update SQL spec descriptions #970

jaredmoo · 2017-02-25T00:26:38Z

This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.

PR information

The title of the PR is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, see this page.
Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.
If applicable, the PR references the bug/issue that it fixes.
Swagger files are correctly named (e.g. the api-version in the path should match the api-version in the spec).

Quality of Swagger

I have read the contribution guidelines.
My spec meets the review criteria:
- The spec conforms to the Swagger 2.0 specification.
- Validation errors from the Linter extension for VS Code have all been fixed for this spec. (Note: for large, previously checked in specs, there will likely be many errors shown. Please contact our team so we can set a timeframe for fixing these errors if your PR is not going to address them).
- The spec follows the patterns described in the Swagger good patterns document unless the service API makes this impossible.

Reading "Azure SQL" over and over again is exhausting and gets in the way of understanding the docs.

azurecla · 2017-02-25T00:26:47Z

Hi @jaredmoo, I'm your friendly neighborhood Azure Pull Request Bot (You can call me AZPRBOT). Thanks for your contribution!

It looks like you're working at Microsoft (jaredmoo). If you're full-time, we DON'T require a contribution license agreement.

If you are a vendor, DO please sign the electronic contribution license agreement. It will take 2 minutes and there's no faxing! https://cla.azure.com.

TTYL, AZPRBOT;

nathannfan · 2017-02-25T01:00:28Z

arm-sql/2014-04-01/swagger/firewallRules.json

@@ -241,7 +241,7 @@
          "items": {
            "$ref": "#/definitions/ServerFirewallRule"
          },
-          "description": "The list of Azure SQL server firewall rules for the server."
+          "description": "The list of server firewall rules for the server."


Can you just make it "The list of firewall rules for the server" for this one?

nathannfan · 2017-02-25T01:04:05Z

arm-sql/2014-04-01/swagger/sql.core.json

@@ -2,7 +2,7 @@
  "swagger": "2.0",
  "info": {
    "title": "Azure SQL Database API spec",
-    "description": "Provides create, read, update and delete functionality for Azure SQL resources including servers, databases, elastic pools, recommendations, operations, and usage metrics.",


This is the one place I'd like to leave Azure SQL

nathannfan · 2017-02-25T01:04:43Z

arm-sql/2014-04-01/swagger/firewallRules.json

@@ -241,7 +241,7 @@
          "items": {
            "$ref": "#/definitions/ServerFirewallRule"
          },
-          "description": "The list of Azure SQL server firewall rules for the server."
+          "description": "The list of server firewall rules for the server."


Can you just make it "The list of firewall rules for the server" for this one?

nathannfan · 2017-02-25T01:06:12Z

arm-sql/2014-04-01/swagger/sql.core.json

@@ -2,7 +2,7 @@
  "swagger": "2.0",
  "info": {
    "title": "Azure SQL Database API spec",
-    "description": "Provides create, read, update and delete functionality for Azure SQL resources including servers, databases, elastic pools, recommendations, operations, and usage metrics.",


This is the one place I'd like to leave Azure SQL in

nathannfan · 2017-02-25T01:08:43Z

arm-sql/2014-04-01/swagger/sql.core.json

@@ -294,7 +294,7 @@
          "Databases"
        ],
        "operationId": "Databases_ListByServer",
-        "description": "Returns information about an Azure SQL database.",
+        "description": "Returns information about a database.",


I know this isn't your error, but could you put "Returns a list of databases by server."?

nathannfan · 2017-02-25T01:09:11Z

arm-sql/2014-04-01/swagger/sql.core.json

@@ -375,7 +375,7 @@
          "Servers"
        ],
        "operationId": "Servers_List",
-        "description": "Returns information about an Azure SQL server.",
+        "description": "Returns information about a server.",


"Returns a list of servers."?

nathannfan · 2017-02-25T01:09:30Z

arm-sql/2014-04-01/swagger/sql.core.json

@@ -554,7 +554,7 @@
          "Servers"
        ],
        "operationId": "Servers_ListUsages",
-        "description": "Returns information about Azure SQL server usage.",
+        "description": "Returns information about server usage.",


nathannfan · 2017-02-25T01:10:48Z

arm-sql/2014-04-01/swagger/sql.core.json

@@ -943,7 +943,7 @@
          "RecommendedElasticPools"
        ],
        "operationId": "RecommendedElasticPools_Get",
-        "description": "Gets information about an Azure SQL Recommended Elastic Pool.",
+        "description": "Gets information about an recommended elastic pool.",


a recommended

Also restored "Azure SQL Database" wording to doc titles and tweaked list operation descriptions.

nathannfan · 2017-02-25T01:11:36Z

arm-sql/2014-04-01/swagger/sql.core.json

@@ -1560,7 +1560,7 @@
          "$ref": "#/definitions/Resource"
        }
      ],
-      "description": "Represents an Azure SQL Recommended Elastic Pool."
+      "description": "Represents an recommended elastic pool."


Maybe ctrl+replace 'an recommended'

nathannfan · 2017-02-25T01:11:40Z

arm-sql/2014-04-01/swagger/sql.core.json

@@ -1560,7 +1560,7 @@
          "$ref": "#/definitions/Resource"
        }
      ],
-      "description": "Represents an Azure SQL Recommended Elastic Pool."
+      "description": "Represents an recommended elastic pool."


Maybe ctrl+replace 'an recommended'

anuchandy

CI is failing specifically with error "FATAL: Error generating client model: System.InvalidOperationException: Swagger document contains two or more x-ms-enum extensions with the same name 'ServiceObjectiveName' and different values.", please take a look and fix.

anuchandy · 2017-02-25T02:58:19Z

arm-sql/2014-04-01/swagger/firewallRules.json

@@ -99,7 +99,7 @@
            "in": "path",
            "required": true,
            "type": "string",
-            "description": "The name of the Azure SQL server firewall rule."
+            "description": "The name of the f rule."


f -> "firewall"

jaredmoo · 2017-02-25T23:07:00Z

Fixed, thanks. Node build seems to be hitting a transient error.

anuchandy · 2017-02-26T19:09:35Z

@jaredmoo thanks, restarted job and now it is passing.

jaredmoo · 2017-02-27T20:45:29Z

Can I get a review and merge here?

- Removed 'information about' wording - Fixed 'an data warehouse' - Made tense consistent - Corrected TDE description

anuchandy · 2017-02-27T21:41:21Z

@jaredmoo thanks, merging.

AutorestCI · 2017-02-27T21:45:52Z

Azure/azure-sdk-for-ruby#700

AutorestCI · 2017-02-27T21:46:01Z

No modification for NodeJS

AutorestCI · 2017-02-27T21:46:37Z

Azure/azure-sdk-for-python#1010

jaredmoo · 2017-02-27T21:54:29Z

Thanks!

jaredmoo added 2 commits February 24, 2017 16:09

More documentation of editon, pool name, and slo.

5abe507

"Azure SQL Database" -> "database", etc

5a6c315

Reading "Azure SQL" over and over again is exhausting and gets in the way of understanding the docs.

azurecla added the cla-not-required label Feb 25, 2017

azuresdkci assigned anuchandy Feb 25, 2017

nathannfan reviewed Feb 25, 2017

View reviewed changes

"server firewall rule" -> "firewall rule".

591e256

Also restored "Azure SQL Database" wording to doc titles and tweaked list operation descriptions.

nathannfan reviewed Feb 25, 2017

View reviewed changes

Fixed "an recommended"

8ee9f82

nathannfan approved these changes Feb 25, 2017

View reviewed changes

anuchandy reviewed Feb 25, 2017

View reviewed changes

jaredmoo added 2 commits February 25, 2017 14:22

Fixed firewall rule description type

2bfd26c

Fixed inconsistent ServiceObjectiveName enum.

ccf545e

Additional changes to op descriptions

51a23a7

- Removed 'information about' wording - Fixed 'an data warehouse' - Made tense consistent - Corrected TDE description

anuchandy approved these changes Feb 27, 2017

View reviewed changes

anuchandy merged commit 80ebb4c into Azure:master Feb 27, 2017

AutorestCI mentioned this pull request Feb 27, 2017

Automatic PR from RestAPI-PR970 Azure/azure-sdk-for-ruby#700

Closed

AutorestCI mentioned this pull request Feb 27, 2017

Automatic PR from RestAPI-PR970 Azure/azure-sdk-for-python#1010

Merged

jaredmoo deleted the slo-docs branch March 1, 2017 19:44

Update SQL spec descriptions #970

Update SQL spec descriptions #970

Uh oh!

Conversation

jaredmoo commented Feb 25, 2017 • edited by azuresdkci Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR information

Quality of Swagger

Uh oh!

azurecla commented Feb 25, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anuchandy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jaredmoo commented Feb 25, 2017

Uh oh!

anuchandy commented Feb 26, 2017

Uh oh!

jaredmoo commented Feb 27, 2017

Uh oh!

anuchandy commented Feb 27, 2017

Uh oh!

AutorestCI commented Feb 27, 2017

Uh oh!

AutorestCI commented Feb 27, 2017

Uh oh!

AutorestCI commented Feb 27, 2017

Uh oh!

jaredmoo commented Feb 27, 2017

Uh oh!

Uh oh!

jaredmoo commented Feb 25, 2017 •

edited by azuresdkci

Loading