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

add endpoint to webpubsub swaggers #16001

Merged
merged 4 commits into from
Sep 15, 2021

Conversation

iscai-msft
Copy link
Contributor

No description provided.

@openapi-workflow-bot
Copy link

Hi, @iscai-msft Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 10, 2021

    Swagger Validation Report

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

    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'WebPubSub_SendToAll' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: WebPubSub/preview/2021-08-01-preview/webpubsub.json#L113
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'WebPubSub_SendToConnection' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: WebPubSub/preview/2021-08-01-preview/webpubsub.json#L266
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'WebPubSub_SendToGroup' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: WebPubSub/preview/2021-08-01-preview/webpubsub.json#L371
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'WebPubSub_SendToUser' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: WebPubSub/preview/2021-08-01-preview/webpubsub.json#L591
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'WebPubSub_SendToAll' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: WebPubSub/preview/2021-05-01-preview/webpubsub.json#L45
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'WebPubSub_SendToConnection' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: WebPubSub/preview/2021-05-01-preview/webpubsub.json#L198
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'WebPubSub_SendToGroup' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: WebPubSub/preview/2021-05-01-preview/webpubsub.json#L303
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'WebPubSub_SendToUser' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: WebPubSub/preview/2021-05-01-preview/webpubsub.json#L523
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️🔄CredScan inProgress [Detail]
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 10, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from eb774d5. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.3.0 requires azure-core<2.0.0,>=1.15.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.3.0 requires azure-core<2.0.0,>=1.15.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️azure-messaging-webpubsubservice [View full logs]  [Release SDK Changes]
      info	[Changelog] data-plan skip changelog generation temporarily
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from eb774d5. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/webpubsub/data-plane/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Azure.Messaging.WebPubSub [View full logs]  [Release SDK Changes]
      warn	Skip artifact folder because it doesn't exist: artifacts/packages
    ️❌ azure-sdk-for-net-track2 failed [Detail]
    • Failed [Logs]Release - Generate from eb774d5. SDK Automation 14.0.0
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
      warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
      command	pwsh ./eng/scripts/Automation-Sdk-Generate.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
      cmderr	[Automation-Sdk-Generate.ps1] �[91mWrite-Error: �[91mError occurred while generating artifacts for Azure.Messaging.WebPubSub
      cmderr	[Automation-Sdk-Generate.ps1] �[0m
    • Azure.Messaging.WebPubSub [View full logs]  [Release SDK Changes]
      info	[Changelog]
    Posted by Swagger Pipeline | How to fix these errors?

    @vicancy
    Copy link
    Member

    vicancy commented Sep 13, 2021

    Add @Mohit-Chakraborty @bterlson and @srnagar for awareness

    "parameters": {
    "Endpoint": {
    "name": "Endpoint",
    "description": "HTTP or HTTPS endpoint for the WebPubSub service instance.",
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    I don't see the term 'WebPubSub' used in the documentation.
    Should it be 'Web PubSub'? Or we can drop the word altogether and say 'for the service instance'.

    Copy link
    Member

    Choose a reason for hiding this comment

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

    I just made the change

    Copy link
    Contributor

    @Mohit-Chakraborty Mohit-Chakraborty left a comment

    Choose a reason for hiding this comment

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

    Left one small comment.

    @lmazuel lmazuel merged commit eb774d5 into Azure:main Sep 15, 2021
    LeiWang3 pushed a commit to LeiWang3/azure-rest-api-specs that referenced this pull request Mar 31, 2022
    * add endpoint to webpubsub swaggers
    
    * have endpoint not include connection string in swagger
    
    * Update webpubsub.json
    
    * Update webpubsub.json
    
    Co-authored-by: Laurent Mazuel <[email protected]>
    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.

    6 participants