Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IoT Central API user changes #10014

Merged
merged 4 commits into from
Jul 7, 2020
Merged

Conversation

viv-liu
Copy link
Contributor

@viv-liu viv-liu commented Jul 2, 2020

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

  • Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
    • adding/removing APIs.
    • adding/removing properties.
    • adding/removing API-version.
    • adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

  • If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
    Please follow the link to find more details on API review process.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jul 2, 2020

[Staging] Swagger Validation Report

BreakingChange: 3 Errors, 0 Warnings [Detail] [Expand]
Rule Message
1026 - TypeChanged The new version has a different type 'object' than the previous one 'string'.
New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L790:11
Old: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L771:11
1034 - AddedRequiredProperty The new version has new required property 'role' that was not found in the old version.
New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L792:13
1034 - AddedRequiredProperty The new version has new required property 'role' that was not found in the old version.
New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L790:11
Old: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L771:11
LintDiff: 2 Errors, 0 Warnings [Detail] [Expand]
Rule Message
An error occurred while executing JSON.parse() on the linter output for specification/iotcentral/data-plane/readme.md: "role":"Lint Diff",
"new":"https://github.com/Azure/azure-rest-api-specs/blob/4c6f62e08c1acf8a7c443e86d4c7705228b151f5/specification/iotcentral/data-plane/readme.md",
"old":"https://github.com/Azure/azure-rest-api-specs/blob/master/specification/iotcentral/data-plane/readme.md"
An error occurred while executing JSON.parse() on the linter output for specification/iotcentral/data-plane/readme.md: "role":"Lint Diff",
"new":"https://github.com/Azure/azure-rest-api-specs/blob/4c6f62e08c1acf8a7c443e86d4c7705228b151f5/specification/iotcentral/data-plane/readme.md",
"old":"https://github.com/Azure/azure-rest-api-specs/blob/master/specification/iotcentral/data-plane/readme.md"
️✔️Avocado [Detail]
 Validation passes for Avocado. 
Posted by Swagger Pipeline | How to fix these errors?

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jul 2, 2020

azure-sdk-for-go - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jul 2, 2020

azure-sdk-for-java - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jul 2, 2020

Azure CLI Extension Generation - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jul 2, 2020

azure-sdk-for-js - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jul 2, 2020

azure-sdk-for-net - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jul 2, 2020

azure-sdk-for-python - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jul 2, 2020

Trenton Generation - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@azuresdkci
Copy link
Contributor

Can one of the admins verify this patch?

"email": {
"description": "Email address of the user.",
"type": "string",
"format": "email"
Copy link
Member

Choose a reason for hiding this comment

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

This is not a valid OpenAPI format and is the cause of the linter failure, can you please remove it.

Copy link
Member

Choose a reason for hiding this comment

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

@jhendrixMSFT this should work in theory
https://swagger.io/docs/specification/data-models/data-types/

However, format is an open value, so you can use any formats, even not those defined by the OpenAPI Specification, such as:

  • email
  • uuid
  • uri
  • hostname
  • ipv4
  • ipv6
    and others
    Tools can use the format to validate the input or to map the value to a specific type in the chosen programming language. Tools that do not support a specific format may default back to the type alone, as if the format is not specified.

But I agree in practice the linter will not like it, and since it's ignored by autorest anyway, better to remove it

Copy link
Member

Choose a reason for hiding this comment

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

I missed the part about format being open-ended, thanks for the correction.

{
"$ref": "#/parameters/Subdomain"
}
{ "$ref": "#/parameters/CentralDnsSuffixInPath" },
Copy link
Member

Choose a reason for hiding this comment

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

The formatting of this doc is wrong, please see https://aka.ms/AA6h31t on how to fix.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Got it, thanks

@jhendrixMSFT
Copy link
Member

Also please fix the spell check failure.

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jul 2, 2020

azure-sdk-for-python-track2 - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@viv-liu
Copy link
Contributor Author

viv-liu commented Jul 2, 2020

I fixed the spellcheck issue.

@viv-liu
Copy link
Contributor Author

viv-liu commented Jul 6, 2020

@jhendrixMSFT any other feedback?

@jhendrixMSFT
Copy link
Member

@viv-liu yes the email format still needs to be removed.

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@lmazuel lmazuel merged commit 452b7b6 into Azure:master Jul 7, 2020
00Kai0 pushed a commit to 00Kai0/azure-rest-api-specs that referenced this pull request Oct 12, 2020
* user changes

* Ran prettier

* Spell check fix

* Removed format email
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