Skip to content

Update Azure metrics data plane swagger to address few doc generation bugs#3945

Merged
hovsepm merged 21 commits intoAzure:masterfrom
vickyv51:master
Sep 18, 2018
Merged

Update Azure metrics data plane swagger to address few doc generation bugs#3945
hovsepm merged 21 commits intoAzure:masterfrom
vickyv51:master

Conversation

@vickyv51
Copy link
Contributor

@vickyv51 vickyv51 commented Sep 18, 2018

Make following changes to Azure metrics data plane api spec to improve the generated doc spec
-Use consistent naming "xyz_API" for the swagger spec file. (xyz=metricsCreate)
-Update the readme reference of the swagger spec
-Include required fields for more swagger items as applicable
-Escape the backslash and add backslash for audience in header

 - 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
-Rename the file to be consistent with operationId
-Update the readme reference of the swagger spec
-Include required fields for more swagger items as applicable
-Escape the backslash and add backslash for audience in header
…pecs

# Conflicts:
#	specification/monitor/data-plane/preview/2018-09-01-preview/MetricsCreate.json
#	specification/monitor/data-plane/preview/2018-09-01-preview/MetricsCreate_API.json
#	specification/monitor/data-plane/preview/2018-09-01-preview/azureMonitorCustomMetricsIngestionApi.json
#	specification/monitor/data-plane/readme.md
@AutorestCI
Copy link

AutorestCI commented Sep 18, 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 18, 2018

Automation for azure-sdk-for-js

Nothing to generate for azure-sdk-for-js

@azuresdkci
Copy link
Contributor

Can one of the admins verify this patch?

@hovsepm
Copy link
Contributor

hovsepm commented Sep 18, 2018

@vickyv51 please add human readable description with short summary of the change. e.g. why do you need to change the name of the swagger?

@vickyv51
Copy link
Contributor Author

Make following changes to Azure metrics data plane api spec to improve the generated doc spec
-Use consistent naming "xyz_API" for the swagger spec file. (xyz=metricsCreate)
-Update the readme reference of the swagger spec
-Include required fields for more swagger items as applicable
-Escape the backslash and add backslash for audience in header

@hovsepm hovsepm merged commit e3ee543 into Azure:master Sep 18, 2018
@AutorestCI
Copy link

AutorestCI commented Sep 18, 2018

Automation for azure-sdk-for-ruby

Nothing to generate for azure-sdk-for-ruby

@AutorestCI
Copy link

AutorestCI commented Sep 18, 2018

Automation for azure-sdk-for-node

Nothing to generate for azure-sdk-for-node

@AutorestCI
Copy link

AutorestCI commented Sep 18, 2018

Automation for azure-sdk-for-java

Nothing to generate for azure-sdk-for-java

@AutorestCI
Copy link

AutorestCI commented Sep 19, 2018

Automation for azure-sdk-for-go

Nothing to generate for azure-sdk-for-go

mccleanp pushed a commit that referenced this pull request Mar 23, 2022
* Generate 2021-06-01 api only

* Fix ruby

* Fix C#

Co-authored-by: Shuo Li <shul@microsoft.com>
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.

4 participants

Comments