Refactor sql readme.md #2640
Merged
Refactor sql readme.md #2640
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
- Rename schema-* to package-pure-* in order to follow convention for python multi-version - Rename package-2017-10-preview to package-composite-v1. The reasons for this are explained in package-2017-03-01-preview tag. The next tag that I add in the near future will be package-composite-v2, which will represent a breaking change & major version bump for clients. - Improved description of various sections - Whitespace/header consistency
Automation for azure-sdk-for-pythonA PR has been created for you based on this PR content. Once this PR will be merged, content will be added to your service PR: |
|
I would like review from the following SDK representatives: Please note: I will soon be adding a new tag |
Automation for azure-libraries-for-javaA PR has been created for you based on this PR content. Once this PR will be merged, content will be added to your service PR: |
Automation for azure-sdk-for-goA PR has been created for you based on this PR content. Once this PR will be merged, content will be added to your service PR: |
|
@sarangan12 That's the perfect opportunity for you to check this PR contains the tag you need for ruby |
lmazuel
reviewed
Mar 13, 2018
|
|
||
| ### Tag: package-2017-10-preview | ||
| ### Tag: package-composite-v1 |
lmazuel
requested changes
Mar 13, 2018
| @@ -405,8 +449,7 @@ Please also specify `--go-sdk-folder=<path to the root directory of your azure-s | |||
| output-folder: $(go-sdk-folder)/services/sql/mgmt/2014-04-01/sql | |||
| ``` | |||
|
|
|||
|
|
|||
| ## Python | |||
There was a problem hiding this comment.
Please remove this Python section, there is currently two Python sections in this file and this one is the bad one.
marstr
requested changes
Mar 13, 2018
| Please also specify `--go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>`. | ||
|
|
||
| ``` yaml $(tag) == 'package-pure-2017-10-preview' && $(go) | ||
| output-folder: $(go-sdk-folder)/services/sql/mgmt/2017-103-01-preview/sql |
There was a problem hiding this comment.
Typo here! Looks like the date is malformed.
| These are the global settings for the Sql API. | ||
|
|
||
| ``` yaml | ||
| title: SqlManagementClient | ||
| description: The Azure SQL Database management API provides a RESTful set of web services that interact with Azure SQL Database services to manage your databases. The API enables you to create, retrieve, update, and delete databases. | ||
| openapi-type: arm | ||
| tag: package-2017-03-preview | ||
| tag: package-composite-v1 |
There was a problem hiding this comment.
I think this makes a lot of sense. It makes explicit the composite nature of input-file tags.
To be clear though, the v1 here isn't something that we expect to be exposed to customers, and is just a hint for the SDK creator, right?
marstr
approved these changes
Mar 13, 2018
|
@payiAzure fyi |
|
@lmazuel I have removed the bad python section Can we aim to get this merged today? thx @trgrie fyi |
lmazuel
approved these changes
Mar 14, 2018
milismsft
approved these changes
Mar 14, 2018
|
@marstr looks like we are good to merge, thx |
Automation for azure-sdk-for-nodeNothing to generate for azure-sdk-for-node |
9 tasks
RandalliLama
added a commit
that referenced
this pull request
Mar 16, 2018
* Add purge operations to AppInsights management plane (#2528) * Add purge to management plane API * Adding purge status operation * Change purge statue to enum * capitalize response status * [AppInsights Data Plane] Fix table schema (#2527) * Remove internal schena column * Fix row schema * Application Insights: Add Favorites and Web Test Locations APIs (#2416) * Initial addition of favorites and locations API * Complete web test locations API - favor 'web test' names/descriptions over 'synthetic monitor' as web test is more customer-centric naming - create example data for the web test api * Spelling update * Updated parameters for favorite API * Add favorites API and examples - ensure tests run against the applicationinsights folder successfully * Add collectionFormat to comma-separated tags list parameter for favorites - generating API in CSharp generated errors * Enum for favorite type should be set to modelAsString as further favorite types are possible in future. * Update suppressions to include specific instances I need suppressed (no global suppressions where possible). * Suppress some noisey test warnings from API specifications from my peers. * PR suggestions - Remove x-ms-pageable annotation from our list operation, in the service code we never paganate our data. - Add x-ms-enum annotation to one enum data type where it was missing. * Event Hub: Added missing API to respective API version Swaggers (#2457) * Added the missing API discovered in ARM_RP_Fundamentals to the respective API version swagger and review comments * added tag for 2014-09 * Update the output-folder to match azure-sdk-for-net paths in Vision package (#2529) * Added enableBatchedOperations property to ServiceBus Queue (#2534) * [Don't Merge, Service roll out 2/28/2018] Swagger For new rdbms API change for new biz model (#2414) * Add new version for mysql and pgsql * Correct readme version * Correct create properties parameter * Correct PG namespace and some other comment * Update Examples folder to examples * Correct property name cases in the examples * Corrected the ServerResult objects in CRUD samples * Correct property values for server response in samples * make createtime and lastmodifiedtime for logfileproperties to readonly * Web Python conf (#2549) * Add a directive for node and TS (#2550) * Swagger specs for all existing versions of Microsoft.PolicyInsights (#2523) * Swagger specs for all existing versions of Microsoft.PolicyInsights * Add support for --validate; make where clauses explicit in existing (approval request pending) suppressions; add new suppression for equivalent paths error (approval request pending) * Fix $top in examples; fix casing in examples * Fix two more instances of $top type in examples * Fix metadata examples by adding content type header and changing the body to a single string * Remove EQUIVALENT_PATH suppressions; add extendedProperties as additionalProperties; add @odata.count to operations; remove "type" from "rows" in first 2017-08-09-preview and add descriptions * Fix remaining examples with bad casings * Fix additionalParameters definition; fix duplicate paths * Remove redundant operations path/definitions from one of the swagger files for each version (one per namespace is sufficient as long as both files are fed into autorest as a bundle) * DataMigration py conf (#2553) * Fix recommendation resource properties, add disable recommendation APIs (#2548) * Add Billing Account resource to Billing RP. (#2517) * Add "Classic Account" ARM resource. * 1. Change classic account property name from "userPrincipalName" to "principalName" 2. Add examples * Fix API version in examples. * Add example links. * ClassicAccount->BillingAccount * Removing "uuid" - billing account name may be a concatenation of uuid and additional keys. * Remove unused parameters. * 1. Add new version to readme.md 2. Fix validation warnings * Fix descriptions. * Fix type mismatch error. * Adding missing parameter in example. * Fix ms-examples name. * Compute spec change for zone resilient images (#2551) * Compute spec change for zone resilient images * Address feedback from the previous iteration * [DO NOT MERGE]update swaggers for azure elastic pool operation (#2520) * update swaggers for azure database and elastic pool operation * update ListDatabaseOperations and ListElasticPoolOperations examples * Only update the swagger for elastic pool operations * end * remove two not needed folders. Fix the error in ListElasticPoolOperation * Update the cancel operations swagger on database and pool, and corresponding examples * fix indentation in cancelOperations.json and cancelPoolOperations.json * Update Azure Database Migration Service to add Managed Instance as target (#2531) * Copy over 2017-11-15-preview folder in preparation for adding 2018-03-15-preview api version. * Update Azure Database Migration Service to add Managed Instance as target * Take out GeoRestore option (#2559) * [Monitor] Fixing issue with metricsnamespace incorrecly specified as client level argument #2565 (#2566) * [Monitor] Make all attributes of EventData class readonly (#2254) * [Monitor] Fixing issue with metricnamespace specification as client level argument #2565 * [Azure Search] Change output path for .NET data plane SDK (#2554) This is part of a planned refactoring that will split the Azure Search .NET data plane SDK into separate packages. * Fix links in the PR template (#2571) * Remove unused API (#2564) Please note this is not a GA API and has been deprecated for a while. There is no current user for it. * Adding preview/stable to the example layout. (#2561) * Adding preview/stable to the example layout. * Fixing formatting * fixed Go SDK path for automation (#2562) * [Monitor] Fixing issue with metrics api queryparameter name (#2575) (#2577) * add databricks activity (#2568) * Swagger completeness for Redis Cache (#2537) * Default string modeled as parameter for auto generation to work correctly * Adding CheckNameAvailability and listUpgradeNotifications into swagger for redis * Fixing code review comments * remove "/" at end for list apis * Name change for notification * Fixing code review comments in PR * Fixing examples that are breaking the build * Add missing type specifier to enum definition. (#2580) * Change group name for operations path, and rename response type definition (#2563) * Swagger specs for all existing versions of Microsoft.PolicyInsights * Add support for --validate; make where clauses explicit in existing (approval request pending) suppressions; add new suppression for equivalent paths error (approval request pending) * Fix $top in examples; fix casing in examples * Fix two more instances of $top type in examples * Fix metadata examples by adding content type header and changing the body to a single string * Remove EQUIVALENT_PATH suppressions; add extendedProperties as additionalProperties; add @odata.count to operations; remove "type" from "rows" in first 2017-08-09-preview and add descriptions * Fix remaining examples with bad casings * Fix additionalParameters definition; fix duplicate paths * Remove redundant operations path/definitions from one of the swagger files for each version (one per namespace is sufficient as long as both files are fed into autorest as a bundle) * Change group name for operations path, and rename response type definition * Change group name for operations path, and rename response type definition (old API versions) * ApiManagement 2018-01-01 version spec (#2292) * Copy the 2017-03-01 files * 2018-01-01 specific changes revert x-ms-enum and update description * 202 on create or update, network status and backend flatten 202 on create or update, networkstatus backend flatten Head for ApiRevision * Fix ValidationRegex of Ids and length * Fix the TagResource contract * Make PUT operation on portalsettings resources ARM-compliant Fix examples * Removed x-ms-client-flatten * NextLinkName and fix Check Entity Exist * Bring back default responses and fix examples * [Do not merge] CDN in all languages in conf (#2514) * CDN in all languages in conf * Review from Node and Amar * Use "net" in tag and not "csharp" * Remove wrong C# comment from Readme * Update Ruby to match real repo * Fix Ruby folder * Azure migrate GA and public preview rest api specs. (#2446) * Azure migrate GA and public preview rest api specs. * Resolving PR comments and semantic errors * Modifying dictionary definition in rest api specs * Defining dictionary in data model * add delete restore points API (#2593) * fix name for backward compatibility * fix name for backward compatibility 2 * fix return type name * fix message - sdk review comment * add delete restore points API and change to async for create API * [Refactor] Client name should be more specific (#2596) As per request: Azure/azure-sdk-for-python#2048 (review) * Add DNS 2017-10-01 API version (#2558) * Add DNS 2017-10-01 API version * Copy 2017-09-01 DNS API version to 2017-10-01 * Add 2017-10-01 DNS API version * Add x-ms-client-name for recordsetnamesuffix for RecordSets_ListAllByDnsZone * Update Sql-ResourceManager readme for list and cancel database/pool operation (#2592) * Update Sql-ResourceManager readme for a previous pull request on updating list and cancel operation on database and pool * fix a type in readme * keep the default tag as unchanged for now * ApiManagement. Fix reference (#2606) * ApiManagement. Fix reference * apimdiagnostics. * syntax error fix * Sampling settings added to logger entity (#2600) * remove async keyword since mocha does not run the tests correctly. (#2609) * Build Network with Autorest.Python 3.0 (#2611) * Reorganize policyinsights; change modelAsString for x-ms-enum to true (#2599) * Swagger specs for all existing versions of Microsoft.PolicyInsights * Add support for --validate; make where clauses explicit in existing (approval request pending) suppressions; add new suppression for equivalent paths error (approval request pending) * Fix $top in examples; fix casing in examples * Fix two more instances of $top type in examples * Fix metadata examples by adding content type header and changing the body to a single string * Remove EQUIVALENT_PATH suppressions; add extendedProperties as additionalProperties; add @odata.count to operations; remove "type" from "rows" in first 2017-08-09-preview and add descriptions * Fix remaining examples with bad casings * Fix additionalParameters definition; fix duplicate paths * Remove redundant operations path/definitions from one of the swagger files for each version (one per namespace is sufficient as long as both files are fed into autorest as a bundle) * Change group name for operations path, and rename response type definition * Change group name for operations path, and rename response type definition (old API versions) * Reorganize files; change modelAsString for x-ms-enum to true Reorganize files (remove resource type based subfolders; rename conflicting example files to have resource type name; change swagger spec files and MD file based on new file locations and names); change modelAsString for x-ms-enum to true based on API review board recommendation * Dummy change to kick the CI again * update roledefinition filters to be in sync with the filters present in service (#2586) * fix the hardcoding of api version for classicadmin in sdk * fix 2017 version preview file * update filter to make it in sync with service * update filter to make it in sync with service * Fix java code generation for resources (#2613) * Add on error deployment ARM (#2560) * Add on error deployment ARM * Update readme.md file * Add provisioning state for the on error deployment * Add on error deployment examples * fix json * json formatting * Fix schema for examples * 2018-01-01 sync of api changes from 2017-03-01 (#2585) * Copy changes from 2017-03-01 to 2018-01-01 * 2018-01-01 version specific changes * [Cognitive Services] March release (add usages operation, addnew/decomission some APIs) (#2544) * March release initial checkin 1. Add usages operation; 2. Add new APIs; 3. Remove decommisioned APIs * Add WebLM back Add WebLM back * Adding ZRS support for snapshots, new apiversion 2018-04-01 (#2552) * adding disk.json zrs support for snapshots * change modelAsString to true to support new enums * adding create option restore * adding example files * adding examples folder and moving files * adding file * Update readme.md * adding 200 responses... * Adding 2 new APIs for VMSS: Redeploy and PerformMaintenance (#2589) * Fix SDK breaking change in 2017-10-01 DNS Swagger (#2612) * Fix SDK breaking change in 2017-10-01 DNS Swagger and add linter error suppressions * Add scoping to error suppressions in 2017-10-01 DNS Swagger * ApiMgmt Py conf (#2624) * Change the default tag to 2017-10 (#2516) * Add swagger for dataWarehouseUserActivities API (#2389) * Add swagger for dataWarehouseUserActivities Add swagger for dataWarehouseUserActivities * add example file add example file * correct case sensitive name datawarehouseUserActivities to dataWarehouseUserActivities * add dataWarehouseUserActivityName add dataWarehouseUserActivityName * remove "value" GET ".../activities/current" should be a get single API, so it should not have "value" * Replace tab spaces with blank spaces * add missing "body" * Reducing CI Log output Verbosity (#2619) * Reducing CI Log output Verbosity Removing "-v" option from Swagger -> SDK jobs. Updating the reporter used by `mocha` to use the "min" reporter. Documenation of available options is here: http://ricostacruz.com/mocha/#reporters * Using most up-to-date OAV * Adding back Swagger -> SDK verbosity. * Adding OperationalInsights Purge, PurgeStatus operations (#2541) * Adding OperationalInsights Purge, PurgeStatus operations * Modifying long running operation * Diagnostics and Tags are per Api Revision (#2622) * API managment: make the same description for API 2016-07-07 SubscriptionIdParameter. (#2631) * Swagger for Salesforce Marketing Cloud Connector, ServiceUri in Dynamics LS, and SSL support in MongoDB LS (#2579) * Add example for creating Revisions (#2633) * [Cognitive Services] Change type of limit/currentValue to double from integer (#2627) Change limit/currentValue to double from integer * Rename BillingAccount->EnrollmentAccount. (#2626) * Remove entities-view-parameter from swagger (#2602) * Add Microsoft.Databricks workspaces swagger (#2594) * copy of managedapplications.json * change to databricks.json * renaming. * databricks api * address comments: add patch tags, change GenericResource to TrackedResouce, add some common parameters. * move sku from TrackedResource to Workspace. * move resourceGroupName and WorkspaceName to method level * fix error response. * add listWorkspacesByResourceGroup nad listWorkspacesBySubscription. * Adding Container Exec Spec (#2584) * Adding exec api to swagger operation * fixing small syntax error * Updating correct examples for async operation * fixing ARM header field * remvoing extra async operations * Update Python version * Remove advisor Java block from CognitiveServices readme.md (#2641) * Adding changes to support Private DNS Public Preview (#2587) * Copy 2017-10-01 DNS API version to 2018-03-01-preview * Add 2018-03-01-preview DNS API version * updating examples to version 2018-03-01-preview * Adding private zone example * removing the required property on zoneType also fixing example * Adding scoping to error suppressions * Update iotdps.json (#425) * Added Tags filter for budgets and updated the api version (#2625) * Added Tags filter for budgets and updated the api version Added Tags filter for budgets and updated the api version * Updated comments Updated comments * Incorporated review comments Incorporated review comments * Incorporated review comments Incorporated review comments * Incorporated review comment Incorporated review comment * Group DPSCertificate->List with other operations (#2643) * fixing relative paths to definitons and commondefinitions.json * Update iotdps.json "operationId": "DpsCertificates_List", -> "operationId": "DpsCertificate_List", so the list operation is grouped with the others on docs * Fix generated doc structure (#2634) * Plug disks 2018-04-01 for multi api versionning (#2648) * correct tier enum for postgres (#2629) * XMSParameterLocation Fixes (#2649) * Add node config to keyvault for Swagger to SDK (#2650) * Make OSDisk in storage profile optional (#2652) * Fix SDK breaking change in 2017-10-01 DNS Swagger ref #2612 (#2656) * Allow Ruby failure on CI (#2653) * Updating Travis to enforce branch strategy (#2657) * Updating Travis to enforce branch strategy * Fixing some typos * One more shot * Negating logic * Refactor sql readme.md (#2640) * Refactor sql readme.md - Rename schema-* to package-pure-* in order to follow convention for python multi-version - Rename package-2017-10-preview to package-composite-v1. The reasons for this are explained in package-2017-03-01-preview tag. The next tag that I add in the near future will be package-composite-v2, which will represent a breaking change & major version bump for clients. - Improved description of various sections - Whitespace/header consistency * Added package-pure-2017-10 including Go support * Commented on Go api-versions * Removed bad python section * Fixed typo in 2017-10 go package * Add more enum values for Identity/type in generic resource swagger (#2617) * Add more enum values for Identity/type in generic resource swagger Resource types like "Microsoft.Compute/VirtualMachines" have more than one enum value for Identity/type. Updating generic resource swagger so it is up-to-date. * Revert changes in swagger spec for 2017 API Version * [Monitor] Fixing incorrect specification of top parameter for Metrics API (#2655) (#2662) * [Monitor] Make all attributes of EventData class readonly (#2254) * [Monitor] Fixing issue with metricnamespace specification as client level argument #2565 * [Monitor] Fixing incorrect specification of top parameter for Metrics API (#2655) * Cleaning up branchStrategy messaging (#2663) * Cleaning up branchStrategy messaging * Fixing typo * Improve Microsoft.Insights schema generation (#2632) * Improve Microsoft.Insights schema generation - Case of microsoft.insights updated to Microsoft.Insights throughout - Added schema tag to readme.md to limit the input files * Properly move folder to update case of name * Adding 2018-01-22 version for ProvisioningServices and IotHubs (#2542) * adding DPS camelCase changes, IoT Hub camelCase changes, basic sku * adding 2018-01-22 changes for dps and iothub * Add partner name for managmentparnter action response (#2665) * Adding preview version of Event Hubs Cluster to Azure REST API specs. (#2272) * Adding preview version of Event Hubs Cluster to Azure REST API specs. * Adding capacity property to EH Cluster examples. * Differentiating update semantics with patch semantics. * RP-Cluster API: Revamping namespaces enumeration in cluster. * Adding cluster sku property bag and moving capacity to sku. Also adding metricId property to the custom properties bag. * RP-Cluster: Modifiying EHCluster references to Cluster references. Adding changes to readme file as well. * RP-Cluster: Adding Event Hubs operations API to Cluster swagger. * RP-Cluster: Removing leftover EHNamespaces definitions. * Cluster: Distinguishing between Cluster and Configuration clients in operation ids. * [AKS] update list of supported VM sizes (#2668) * [AKS] update list of supported VM sizes * Sync up ACS VM sizes with AKS sizes * Fixing error in naming convention for rows and cols (#2651) * Support azureFunctionReceivers in actionGroup APIs (#2659) * [AKS] specify byte format for base64-encoded kubeconfig (#2669) * Adding API Specs for Long Term Retention V2 (#2256) * Adding API Specs for Long Term Retention V2 This change adds the swagger documentation for the Long Term Retention V2 feature along with examples for each of the APIs.. This includes the following APIs: Get an LTR Backup Get all LTR Backups under a database Get all LTR Backups under a server Get all LTR Backups under a location Delete an LTR Backup Set a database's LTR Policy Get a database's LTR Policy * Remove empty properties and update retention description This update is a response to the few comments that Anu left on the PR. It removes an empty properties entry and updates the retention descriptions to explain that they use an ISO 8601 standard. * Description and Entity Name Changes Made some slight changes to the entity names to better align with LTR V1 and added some better descriptors to some property descriptions. * Fixing Incorrect Description The weekOfYear parameter is not in an ISO 8601 format, it is just an integer between 1 and 52. Fixing that accordingly. * Remove Conflicting Definitions Need to remove backupLongTermRetentionPolicies so it doesn't conflict with the new backupLongTermRetentionPolicies. * Remove Reference to backupLongTermRetentionPolicies.json Need to remove the reference to backupLongTermRetentionPolicies.json in the readme. * Update ResourceId Updated the resource ID for longTermRetentionBackups so servers and databases are now longTermRetentionServers and longTermRetentionDatabases, respectively. This better aligns with REST. * Re-Adding LongTermRetentionPolicyGet.json LongTermRetentionPolicyGet.json was accidentally deleted in the last commit. * Fix Travis CI Errors Made some changes to the examples to fix the Travis CI errors. * Updating more references to BackupLongTermRetentionPolic(y|ies) * Re-adding backupLongTermRetentionPolicies.json * removing .travis.yml that was accidentally added * Revert "removing .travis.yml that was accidentally added" This reverts commit 3b80fa0. * Revert "Re-adding backupLongTermRetentionPolicies.json" This reverts commit b98cf6c. * undoing accidental .travis.yml * Fixing errors in model PR_ONLY=true Travis CI run * Fixing another Travis CI error * Removing .travis.yml from the change and changing LongTermRetentionPolicy to BackupLongTermRetentionPolicy to keep it consistent * resetting backupLongTermRetentionPolicies.json * Update more references of LongTermRetentionPolicy to BackupLongTermRetentionPolicy * updating readme.md comment * Add package-version for ADF (#2674) * Remove azure-validation from readme file (#2676) * Add CODEOWNERS file (#2673) This file will be used to automatically request PR reviews from SMEs on the service teams. It is autogenerated based on previous PR submitters. * Add Go tag for api management, api version 2018-01-01 (#2677) * Add Go tag for api management, api version 2018-01-01 * Generate go to preview path
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.
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
api-versionin the path should match theapi-versionin the spec).Quality of Swagger