Skip to content

Catching up with missing commits (not moved to the new branch), Fixing issue #1475: incorrect example in LogProfiles API documentation for CreateOrUpdate, fixing incorrect logProfiles example names.#1481

Merged
vishrutshah merged 10 commits intoAzure:currentfrom
AuxMon:current
Aug 8, 2017

Conversation

@gucalder
Copy link
Copy Markdown
Contributor

@gucalder gucalder commented Jul 27, 2017

Catching up with missing commits (not moved to the new branch), Fixing issue #1475: incorrect example in LogProfiles API documentation for CreateOrUpdate, fixing incorrect logProfiles example names.

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

…ng issue Azure#1475: incorrect example in LogProfiles API documentation for CreateOrUpdate, fixing incorrect logProfiles example names.
@gucalder
Copy link
Copy Markdown
Contributor Author

Retry of closed PR #1476.

Copy link
Copy Markdown
Contributor

@vishrutshah vishrutshah left a comment

Choose a reason for hiding this comment

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

@gucalder Change looks good but I noticed that there was already existing error in of the swagger. It'd great if we can address it in this PR itself. Thanks!

},
"x-ms-examples": {
"List alert rules": { "$ref": "./examples/deleteLogProfile.json" }
"Delete log profile": { "$ref": "./examples/deleteLogProfile.json" }
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

seems like this example contains an additional response code that has not been modeled in swagger. Could you please verify?

https://travis-ci.org/Azure/azure-rest-api-specs/jobs/258292847#L657

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed

@vishrutshah
Copy link
Copy Markdown
Contributor

@gucalder ping! Could you please see whether we can fix this as part of this PR. Thanks!

@vishrutshah
Copy link
Copy Markdown
Contributor

@gucalder Thanks for fixing the example. I see that there is still one more invalid example/swagger model for operation LogProfiles_CreateOrUpdate. Could you please have a look?

https://travis-ci.org/Azure/azure-rest-api-specs/jobs/260424100#L663

@gucalder
Copy link
Copy Markdown
Contributor Author

gucalder commented Aug 4, 2017

I do not know how to fix this error reported by Linter: "code": "DefinitionsPropertiesNamesCamelCase",
"message": "Property named: 'odata.type', for definition: 'RuleCondition' must follow camelCase style. Example:
'odata.type'.",

@gucalder
Copy link
Copy Markdown
Contributor Author

gucalder commented Aug 4, 2017

Those are 6 of the 10 errors.

@vishrutshah
Copy link
Copy Markdown
Contributor

@gucalder Looks like the rule should not have triggered when there is a odata int eh property name.

Would you please open an issue at https://github.com/Azure/azure-openapi-validator/issues and link to Azure/autorest#2064 so that we can get it taken care. Thanks!

Secondly, Please also have a look at the build MODE:model PR_ONLY=true here. That build ensures that provided examples are matching the swagger models. Let me know if you need any help. Thanks!

@gucalder
Copy link
Copy Markdown
Contributor Author

gucalder commented Aug 7, 2017

Issues with the MODE:model PR_ONLY=true fixed. Waiting for the result of the validations.

@azuresdkciprbot
Copy link
Copy Markdown

Hi There,

I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result:

File: specification/monitor/resource-manager/readme.md
Before the PR: Warning(s): 38 Error(s): 10
After the PR: Warning(s): 23 Error(s): 10

AutoRest Linter Guidelines | AutoRest Linter Issues

Send feedback and make AutoRest Linter Azure Bot smarter day by day!

Thanks for your co-operation.

Copy link
Copy Markdown
Contributor

@vishrutshah vishrutshah left a comment

Choose a reason for hiding this comment

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

Thanks for fixing the errors. I left one question for you. Let me know what you think.

},
{
"name": "serviceDiagnosticSettingsResource",
"name": "parameters",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@gucalder May I ask the reason for this change i.e renaming the parameter. Seems like generating new SDK from this swagger would not be backward compatible as parameter name has changed. Can you please provide your thoughts.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

That is because I changed the wrong file... I need to change the example file, not the spec file.
I am on this.

@azuresdkciprbot
Copy link
Copy Markdown

Hi There,

I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result:

File: specification/monitor/resource-manager/readme.md
Before the PR: Warning(s): 38 Error(s): 10
After the PR: Warning(s): 23 Error(s): 10

AutoRest Linter Guidelines | AutoRest Linter Issues

Send feedback and make AutoRest Linter Azure Bot smarter day by day!

Thanks for your co-operation.

@vishrutshah
Copy link
Copy Markdown
Contributor

Thanks @gucalder for incorporating the feedback.

@vishrutshah vishrutshah added the Monitor Monitor, Monitor Ingestion, Monitor Query label Aug 8, 2017
@vishrutshah vishrutshah merged commit d95a4ce into Azure:current Aug 8, 2017
@AutorestCI
Copy link
Copy Markdown

No modification for AutorestCI/azure-sdk-for-node

@AutorestCI
Copy link
Copy Markdown

@AutorestCI
Copy link
Copy Markdown

@AutorestCI
Copy link
Copy Markdown

No modification for AutorestCI/azure-sdk-for-ruby

@AutorestCI
Copy link
Copy Markdown

No modification for AutorestCI/azure-sdk-for-node

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Monitor Monitor, Monitor Ingestion, Monitor Query

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants