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

Missing description #11772

Merged
merged 18 commits into from
Dec 14, 2020
Merged

Missing description #11772

merged 18 commits into from
Dec 14, 2020

Conversation

vasanthrajams
Copy link
Contributor

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

Changelog

Please ensure to add changelog with this PR by answering the following questions.

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No, no need to refresh for updates in this PR

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
  • Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • 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

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

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

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Nov 21, 2020

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.

️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.

️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Nov 21, 2020

Swagger Generation Artifacts

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from dcd3140. SDK Automation 14.0.0
    command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️preview/keyvault/v7.2-preview/keyvault [View full logs]  [Release SDK Changes]
    info	[Changelog] No exported changes
  • ️✔️keyvault/v7.1/keyvault [View full logs]  [Release SDK Changes]
    info	[Changelog] No exported changes
  • ️✔️keyvault/v7.0/keyvault [View full logs]  [Release SDK Changes]
    info	[Changelog] No exported changes
  • ️✔️keyvault/2016-10-01/keyvault [View full logs]  [Release SDK Changes]
    info	[Changelog] No exported changes
  • ️✔️keyvault/2015-06-01/keyvault [View full logs]  [Release SDK Changes]
    info	[Changelog] No exported changes
️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
Posted by Swagger Pipeline | How to fix these errors?

@@ -284,7 +284,8 @@
"RestoreOperationParameters": {
"properties": {
"sasTokenParameters": {
"$ref": "#/definitions/SASTokenParameter"
"$ref": "#/definitions/SASTokenParameter",
"description": "SAS token parameter object containing azure storage resourceUri and token"
Copy link
Member

Choose a reason for hiding this comment

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

Please capitalize product marketing names, e.g. "Azure". Same below.

@tjprescott
Copy link
Member

@heaths is the LintDiff failure expected (I have this vague notion that I've run into this before)? If so, is there a way to add an exclusion?

@heaths
Copy link
Member

heaths commented Nov 24, 2020

Not those particular errors, no - just the MISSING_REQUIRED_PARAMETER errors referring to the host name.

@tjprescott
Copy link
Member

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 2 pipeline(s).

@tjprescott tjprescott merged commit dcd3140 into master Dec 14, 2020
giromm2ms pushed a commit to giromm2ms/azure-rest-api-specs that referenced this pull request Dec 20, 2020
* Adding 7.2-preview version (Azure#8397)

* Adding 7.2-preview version

Signed-off-by: vasanthrajams <vasanthrajams@microsoft.com>

* Resolve PR feedback

* Fix output-folder for go code generation

Co-authored-by: Heath Stewart <heaths@outlook.com>

* Add missing description for SASTokenParameter

* Capitalize Azure

Co-authored-by: Heath Stewart <heaths@outlook.com>
Co-authored-by: vasanthrajams <vasanthrajams@microsoft.com>
@JackTn JackTn deleted the missing_description branch August 9, 2021 10:13
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.

3 participants