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

Latest version taken from INT on 2020-12-16 #12147

Closed

Conversation

juancamilor
Copy link
Member

@juancamilor juancamilor commented Dec 17, 2020

Added latest API for chat + sample files
Previous version review
#11716

FYI @amrElroumy @DominikMe lets continue the WIP on this one.
This one should address all the azure board final comments.

@openapi-workflow-bot
Copy link

Hi, @juancamilor 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 cross api-version diff. See OpenAPI Hub Diff
  • 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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 17, 2020

    Swagger Validation Report

    ️❌BreakingChange: 7 Errors, 0 Warnings failed [Detail]

    Rule Message
    1011 - AddingResponseCode The new version adds a response code '200'.
    New: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L125:11
    1012 - RemovedResponseCode The new version removes the response code '201'
    New: azure-rest-api-specs/blob/7eb9f7b548bbb217c160999fade40e6320d185c7/
    Old: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L125:11
    1019 - RemovedEnumValue The new version is removing enum value(s) 'Normal, High' from the old version.
    New: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1289:9
    Old: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1287:9
    1019 - RemovedEnumValue The new version is removing enum value(s) 'Normal, High' from the old version.
    New: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1468:9
    Old: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1402:9
    1026 - TypeChanged The new version has a different type 'object' than the previous one 'string'.
    New: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1405:9
    Old: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L1337:9
    1035 - RemovedOperation The new version is missing an operation that was found in the old version. Was operationId 'ChatThread_AddChatParticipants' removed or restructured?
    New: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L602:5
    Old: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L602:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L754:5
    ️⚠️LintDiff: 1 Warnings warning [Detail]

    Rule Message
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ChatThreadModel'. Consider using the plural form of 'ChatThread' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    New: Microsoft.CommunicationServicesChat/preview/2020-11-01-preview3/communicationserviceschat.json#L760
    ️️✔️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 Dec 17, 2020

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @juancamilor, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ma/swaggerfeedback.

    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @juancamilor
    Copy link
    Member Author

    @amrElroumy closing this one.

    @juancamilor juancamilor closed this Jan 5, 2021
    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.

    2 participants