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

Updating Swagger spec and samples for GA #8727

Closed

Conversation

riserrad
Copy link
Contributor

@riserrad riserrad commented Mar 17, 2020

Latest improvements:

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

Contribution checklist:

  • I have reviewed the documentation for the workflow.
  • Validation tools were run on swagger spec(s) and have all been fixed in this PR.
  • The OpenAPI Hub was used for checking validation status and next steps.

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.

Summary of changes

  • Added GA Api-Version 2020-05-15
  • Switched samples to mention L1 instead of S1.
  • Updated $expand parameter to just expand

sandshadow and others added 30 commits January 9, 2018 17:03
Fix R2016 by making PATCH body properties optional. Suppress the remaining 4 violations that are confirmed as false positives.
…Prop

Added dataStringComparisonBehavior parameter to reference data put/update spec
…onKeyProperty

Adding partitionKeyProperty to EnvironmentCreate and EnvironmentGet request.
…lingAsString

changing modelAsString for partitionKeyPRoperties
Introduce longterm environment to TSI resource hierarchy
@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azuresdkci
Copy link
Contributor

Can one of the admins verify this patch?

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Mar 17, 2020

azure-sdk-for-go

failed [Logs] [Expand Details]
  • Generate from 423bd8b with merge commit a1afe563a80d5119651c7e7048aa06ed243a3c21. SDK Automation 13.0.17.20200311.2
    [AutoRest] Failure during batch task - {"tag":"package-2020-05-15"} -- Error: [Exception] No input files provided.
    [AutoRest] 
    [AutoRest] Use --help to get help information..
    Failed to run autorest.
    Error: /z/node_modules/.bin/autorest --use=@microsoft.azure/autorest.go@~2.1.142 --go --verbose --multiapi --use-onever --preview-chk --version=2.0.4413 --go-sdk-folder=/z/work/src/github.com/Azure/azure-sdk-for-go /z/work/azure-rest-api-specs/specification/timeseriesinsights/resource-manager/readme.md Failure during batch task - {"tag":"package-2020-05-15"} -- Error: [Exception] No input files provided.
    

    Use --help to get help information..
    , {}

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Mar 17, 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 Mar 17, 2020

azure-sdk-for-java

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 Mar 17, 2020

azure-cli-extensions

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 Mar 17, 2020

azure-sdk-for-js

failed [Logs] [Expand Details]
  • Generate from 423bd8b with merge commit a1afe563a80d5119651c7e7048aa06ed243a3c21. SDK Automation 13.0.17.20200311.2
    [AutoRest] FATAL: swagger-document-override/md-override-loader - FAILED
    [AutoRest] FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2020-05-15/timeseriesinsights.json'.
    [AutoRest] FATAL: swagger-document/loader - FAILED
    [AutoRest] FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2020-05-15/timeseriesinsights.json'.
    [AutoRest]   Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2020-05-15/timeseriesinsights.json'.
    Failed to run autorest.
    Error: /z/node_modules/.bin/autorest --version=2.0.4413 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.2.2 --typescript-sdks-folder=/z/work/azure-sdk-for-js /z/work/azure-rest-api-specs/specification/timeseriesinsights/resource-manager/readme.md FATAL: swagger-document-override/md-override-loader - FAILED
    FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2020-05-15/timeseriesinsights.json'.
    FATAL: swagger-document/loader - FAILED
    FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2020-05-15/timeseriesinsights.json'.
      Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2020-05-15/timeseriesinsights.json'.
    , {} 

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Mar 17, 2020

azure-sdk-for-python

failed [Logs] [Expand Details]
  • Generate from 423bd8b with merge commit a1afe563a80d5119651c7e7048aa06ed243a3c21. SDK Automation 13.0.17.20200311.2
    [AutoRest] FATAL: swagger-document-override/md-override-loader - FAILED
    [AutoRest] FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2020-05-15/timeseriesinsights.json'.
    [AutoRest] FATAL: swagger-document/loader - FAILED
    [AutoRest] FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2020-05-15/timeseriesinsights.json'.
    [AutoRest]   Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2020-05-15/timeseriesinsights.json'.
    Failed to run autorest.
    Error: /z/node_modules/.bin/autorest --version=2.0.4413 --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/timeseriesinsights/resource-manager/readme.md FATAL: swagger-document-override/md-override-loader - FAILED
    FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2020-05-15/timeseriesinsights.json'.
    FATAL: swagger-document/loader - FAILED
    FATAL: Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2020-05-15/timeseriesinsights.json'.
      Error: Could not read 'file:///z/work/azure-rest-api-specs/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2020-05-15/timeseriesinsights.json'.
    , {} 

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@@ -197,11 +197,11 @@
"$ref": "#/parameters/EnvironmentNameParameter"
},
{
"name": "standardEnvironmentUpdateParameters",
"name": "longTermEnvironmentUpdateParameters",
Copy link
Member

Choose a reason for hiding this comment

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

if this fixing a Swagger bug? Otherwise it will be a breaking change

"pattern": "^[-\\w\\._\\(\\)]+$",
"minLength": 1,
"maxLength": 90,
"description": "Name of the environment"
Copy link
Member

Choose a reason for hiding this comment

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

it will be great for user to add constraint in description also.

"$ref": "#/definitions/EnvironmentResource"
}
},
"404": {
Copy link
Member

Choose a reason for hiding this comment

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

normally no error response in Swagger. COuld you pls share some context of adding 404? thanks.

"pattern": "^[A-Za-z0-9]",
"minLength": 3,
"maxLength": 63,
"description": "Name of the reference data set."
Copy link
Member

Choose a reason for hiding this comment

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

pls add constraint in description for better user experience.

"kind": {
"type": "string",
"description": "The kind of the environment.",
"enum": [
Copy link
Member

Choose a reason for hiding this comment

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

modelAsString?

"maxCount": {
"format": "int32",
"type": "integer",
"description": "A value that represents the maximum number of properties used allowed by the environment for S1/S2 SKU and maximum number of properties allowed by Warm Store for PAYG SKU.",
Copy link
Member

Choose a reason for hiding this comment

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

add constraint in description

@yungezz
Copy link
Member

yungezz commented Mar 17, 2020

will involve ARM review when PR ready for reviewing.

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@riserrad riserrad closed this Mar 18, 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.

8 participants