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

Initial add of SR swagger spec #10220

Conversation

arerlend
Copy link

@arerlend arerlend commented Jul 21, 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

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Adding a new service
  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

Please follow the link to find more details on PR review process.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jul 21, 2020

[Staging] Swagger Validation Report

️✔️BreakingChange [Detail]
 There are no breaking changes. 
🔄LintDiff [Detail]
Avocado: 82 Errors, 7 Warnings [Detail] [Expand] Only 10 items are listed, please refer to log for more details.
Rule Message
INCONSISTENT_API_VERSION The API version of the swagger is inconsistent with its file path.
readme: specification/eventhub/resource-manager/readme.md
json: resource-manager/common/v1/definitions.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/timeseriesinsights/data-plane/readme.md
json: preview/2018-11-01-preview/examples/ModelSettingsGet.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/timeseriesinsights/data-plane/readme.md
json: preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage3.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/timeseriesinsights/data-plane/readme.md
json: preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage2.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/timeseriesinsights/data-plane/readme.md
json: preview/2018-11-01-preview/examples/WarmStoreQueryGetSeriesPage1.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/timeseriesinsights/data-plane/readme.md
json: preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage4.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/timeseriesinsights/data-plane/readme.md
json: preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage3.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/timeseriesinsights/data-plane/readme.md
json: preview/2018-11-01-preview/examples/WarmStoreQueryGetEventsPage2.json
INCONSISTENT_API_VERSION The API version of the swagger is inconsistent with its file path.
readme: specification/network/resource-manager/readme.md
json: Microsoft.Network/stable/2020-06-01/vmssNetworkInterface.json
INCONSISTENT_API_VERSION The API version of the swagger is inconsistent with its file path.
readme: specification/network/resource-manager/readme.md
json: Microsoft.Network/stable/2020-06-01/vmssPublicIpAddress.json
ModelValidation: 82 Errors, 0 Warnings [Detail] [Expand] Only 10 items are listed, please refer to log for more details.
Rule Message
[REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md#REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND "In operation "CreateKey", parameter vaultBaseUrl is required in the swagger spec but is not present in the provided example parameter values.") In operation "CreateKey", parameter vaultBaseUrl is required in the swagger spec but is not present in the provided example parameter values.
Url: Microsoft.KeyVault/stable/7.0/keyvault.json#L13
[REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md#REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND "In operation "SetCertificateIssuer", parameter parameter is required in the swagger spec but is not present in the provided example parameter values.") In operation "SetCertificateIssuer", parameter parameter is required in the swagger spec but is not present in the provided example parameter values.
Url: Microsoft.KeyVault/stable/7.0/keyvault.json#L1787
[REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md#REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND "In operation "ImportKey", parameter vaultBaseUrl is required in the swagger spec but is not present in the provided example parameter values.") In operation "ImportKey", parameter vaultBaseUrl is required in the swagger spec but is not present in the provided example parameter values.
Url: Microsoft.KeyVault/stable/7.0/keyvault.json#L13
[REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md#REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND "In operation "DeleteKey", parameter vaultBaseUrl is required in the swagger spec but is not present in the provided example parameter values.") In operation "DeleteKey", parameter vaultBaseUrl is required in the swagger spec but is not present in the provided example parameter values.
Url: Microsoft.KeyVault/stable/7.0/keyvault.json#L13
[REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md#REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND "In operation "UpdateKey", parameter vaultBaseUrl is required in the swagger spec but is not present in the provided example parameter values.") In operation "UpdateKey", parameter vaultBaseUrl is required in the swagger spec but is not present in the provided example parameter values.
Url: Microsoft.KeyVault/stable/7.0/keyvault.json#L13
[REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md#REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND "In operation "GetKey", parameter vaultBaseUrl is required in the swagger spec but is not present in the provided example parameter values.") In operation "GetKey", parameter vaultBaseUrl is required in the swagger spec but is not present in the provided example parameter values.
Url: Microsoft.KeyVault/stable/7.0/keyvault.json#L13
[REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md#REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND "In operation "GetKeyVersions", parameter vaultBaseUrl is required in the swagger spec but is not present in the provided example parameter values.") In operation "GetKeyVersions", parameter vaultBaseUrl is required in the swagger spec but is not present in the provided example parameter values.
Url: Microsoft.KeyVault/stable/7.0/keyvault.json#L13
[REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md#REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND "In operation "GetKeys", parameter vaultBaseUrl is required in the swagger spec but is not present in the provided example parameter values.") In operation "GetKeys", parameter vaultBaseUrl is required in the swagger spec but is not present in the provided example parameter values.
Url: Microsoft.KeyVault/stable/7.0/keyvault.json#L13
[REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md#REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND "In operation "BackupKey", parameter vaultBaseUrl is required in the swagger spec but is not present in the provided example parameter values.") In operation "BackupKey", parameter vaultBaseUrl is required in the swagger spec but is not present in the provided example parameter values.
Url: Microsoft.KeyVault/stable/7.0/keyvault.json#L13
[REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md#REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND "In operation "RestoreKey", parameter parameters is required in the swagger spec but is not present in the provided example parameter values.") In operation "RestoreKey", parameter parameters is required in the swagger spec but is not present in the provided example parameter values.
Url: Microsoft.KeyVault/stable/7.0/keyvault.json#L428
SemanticValidation: 1 Errors, 0 Warnings [Detail] [Expand]
Rule Message
OAV131 discriminator must be a required property.
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 21, 2020

azure-sdk-for-python

failed [Logs] [Expand Details]
  • Generate from 46af451 with merge commit 30bfff1000e86d4eeee39e2d4a04d7ae613b8134. SDK Automation 13.0.17.20200916.11
    [AutoRest] FATAL: swagger-document-override/md-override-loader - FAILED
    [AutoRest] FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/Microsoft.EventHub/preview/2018-01-01-preview/schemaregistry.json'.
    [AutoRest] FATAL: swagger-document/loader - FAILED
    [AutoRest] FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/Microsoft.EventHub/preview/2018-01-01-preview/schemaregistry.json'.
    [AutoRest]   Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/Microsoft.EventHub/preview/2018-01-01-preview/schemaregistry.json'.
    Failed to run autorest.
    Error: /z/node_modules/.bin/autorest --version=V2 --use=@microsoft.azure/autorest.python@~4.0.71 --python --python-mode=update --multiapi --keep-version-file --no-async --python-sdks-folder=/z/work/azure-sdk-for-python/sdk /z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/readme.md FATAL: swagger-document-override/md-override-loader - FAILED
    FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/Microsoft.EventHub/preview/2018-01-01-preview/schemaregistry.json'.
    FATAL: swagger-document/loader - FAILED
    FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/Microsoft.EventHub/preview/2018-01-01-preview/schemaregistry.json'.
      Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/Microsoft.EventHub/preview/2018-01-01-preview/schemaregistry.json'.
    , {} 
    Failed to find any diff after autorest so no changed packages was found.

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jul 21, 2020

Trenton Generation

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 21, 2020

azure-sdk-for-python-track2

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 21, 2020

Azure CLI Extension Generation

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 21, 2020

azure-sdk-for-js

failed [Logs] [Expand Details]
  • Generate from 46af451 with merge commit 30bfff1000e86d4eeee39e2d4a04d7ae613b8134. SDK Automation 13.0.17.20200916.11
    [AutoRest] FATAL: swagger-document-override/md-override-loader - FAILED
    [AutoRest] FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/Microsoft.EventHub/preview/2018-01-01-preview/schemaregistry.json'.
    [AutoRest] FATAL: swagger-document/loader - FAILED
    [AutoRest] FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/Microsoft.EventHub/preview/2018-01-01-preview/schemaregistry.json'.
    [AutoRest]   Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/Microsoft.EventHub/preview/2018-01-01-preview/schemaregistry.json'.
    Failed to run autorest.
    Error: /z/node_modules/.bin/autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.1 --typescript-sdks-folder=/z/work/azure-sdk-for-js /z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/readme.md FATAL: swagger-document-override/md-override-loader - FAILED
    FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/Microsoft.EventHub/preview/2018-01-01-preview/schemaregistry.json'.
    FATAL: swagger-document/loader - FAILED
    FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/Microsoft.EventHub/preview/2018-01-01-preview/schemaregistry.json'.
      Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/Microsoft.EventHub/preview/2018-01-01-preview/schemaregistry.json'.
    , {} 
    Failed to find any diff after autorest so no changed packages was found.

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jul 21, 2020

azure-sdk-for-go

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 21, 2020

azure-sdk-for-net

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 21, 2020

azure-sdk-for-java

failed [Logs] [Expand Details]
  • Generate from 46af451 with merge commit 30bfff1000e86d4eeee39e2d4a04d7ae613b8134. SDK Automation 13.0.17.20200916.11
    [AutoRest] FATAL: swagger-document-override/md-override-loader - FAILED
    [AutoRest] FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/Microsoft.EventHub/preview/2018-01-01-preview/schemaregistry.json'.
    [AutoRest] FATAL: swagger-document/loader - FAILED
    [AutoRest] FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/Microsoft.EventHub/preview/2018-01-01-preview/schemaregistry.json'.
    [AutoRest]   Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/Microsoft.EventHub/preview/2018-01-01-preview/schemaregistry.json'.
    Failed to run autorest.
    Error: /z/node_modules/.bin/autorest --version=V2 --java --verbose --multiapi --use=@microsoft.azure/autorest.java@preview --azure-libraries-for-java-folder=/z/work/azure-sdk-for-java /z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/readme.md FATAL: swagger-document-override/md-override-loader - FAILED
    FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/Microsoft.EventHub/preview/2018-01-01-preview/schemaregistry.json'.
    FATAL: swagger-document/loader - FAILED
    FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/Microsoft.EventHub/preview/2018-01-01-preview/schemaregistry.json'.
      Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/schemaregistry/data-plane/Microsoft.EventHub/preview/2018-01-01-preview/schemaregistry.json'.
    , {} 
    Failed to find any diff after autorest so no changed packages was found.

@azuresdkci
Copy link
Contributor

Can one of the admins verify this patch?

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

2 similar comments
@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

7 similar comments
@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Comment was made before the most recent commit for PR 10220 in repo Azure/azure-rest-api-specs

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@arerlend
Copy link
Author

Closing for consistency in PR branch name.

#10854

@arerlend arerlend closed this Sep 21, 2020
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.

None yet