Skip to content

Fix the Azure metrics data-plane api swagger spec to ensure the documentaiton generation works as expected#3911

Merged
jhendrixMSFT merged 17 commits intoAzure:masterfrom
vickyv51:master
Sep 14, 2018
Merged

Fix the Azure metrics data-plane api swagger spec to ensure the documentaiton generation works as expected#3911
jhendrixMSFT merged 17 commits intoAzure:masterfrom
vickyv51:master

Conversation

@vickyv51
Copy link
Contributor

@vickyv51 vickyv51 commented Sep 14, 2018

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

 - Use a shorter operationId
 - Remove any non-success response code with default response clause
 - Add a new example and reference it in the swagger spec
 - Include readme.md file for the swagger spec
 - Inline the readme.python.md file in the readme.md
  - Fix the readme.md naming incompatibilities
  - Remove the c#-ish namespace prefix
-Rename bunch of properties to follow camel case naming
-Update the enum types to have the "x-ms-enum" part of the json
-Update path and namespace for Java section
…imple object type instead. This should make the swagger spec clean and more easily maintainable in the long run
@AutorestCI
Copy link

AutorestCI commented Sep 14, 2018

Automation for azure-sdk-for-python

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-python#3345

@AutorestCI
Copy link

AutorestCI commented Sep 14, 2018

Automation for azure-sdk-for-node

Nothing to generate for azure-sdk-for-node

@AutorestCI
Copy link

AutorestCI commented Sep 14, 2018

Automation for azure-sdk-for-java

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-java#2392

@AutorestCI
Copy link

AutorestCI commented Sep 14, 2018

Automation for azure-sdk-for-ruby

Nothing to generate for azure-sdk-for-ruby

@AutorestCI
Copy link

AutorestCI commented Sep 14, 2018

Automation for azure-sdk-for-go

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-go#2694

@azuresdkci
Copy link
Contributor

Can one of the admins verify this patch?

@vickyv51 vickyv51 changed the title Fix the swagger spec to ensure the documentaiton generation works as expected Fix the Azure metrics data-plane api swagger spec to ensure the documentaiton generation works as expected Sep 14, 2018
@azuresdkci azuresdkci requested a review from dsgouda September 14, 2018 22:45
-Rename the file to be consistent with operationId
@jhendrixMSFT jhendrixMSFT merged commit 9441291 into Azure:master Sep 14, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants