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.

Sign up for GitHub

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

Jump to bottom

Changing API version and renaming to Messages #22450

Merged
merged 1 commit into from
Feb 3, 2023
Merged

Changing API version and renaming to Messages #22450

merged 1 commit into from
Feb 3, 2023

Conversation

ajpeacock0
Copy link
Contributor

Choose a PR Template

We gained SDK feedback that:

  1. Our API version should be as close to possible to our release date. Our initial API versions was 7 months behind our Private Preview release of Feb 2023.
  2. We should rename messaging to messages. We have already done this rename on our SDK; this change updates our swagger to be consistant

Switch to "Preview" on this description then select one of the choices below.

Click here to open a PR for a Data Plane API.

Click here to open a PR for a Control Plane (ARM) API.

@ajpeacock0 ajpeacock0 requested a review from a team as a code owner February 3, 2023 19:09
@ajpeacock0 ajpeacock0 requested review from JeffreyRichter and MushMal and removed request for a team February 3, 2023 19:09
@openapi-workflow-bot
Copy link

Hi, @ajpeacock0 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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 3, 2023 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️❌LintDiff: 2 Errors, 13 Warnings failed [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2023-02-01-preview package-2023-02-01-preview(06ca30c) default(gelli/addMessagingApiSpec)
    default default(06ca30c) default(gelli/addMessagingApiSpec)

    [must fix]The following errors/warnings are introduced by current PR:

    Rule Message Related RPC [For API reviewers]
    ❌ XmsParameterLocation The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
    Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L228
    ❌ HostParametersValidation The host parameter must be typed 'type 'string', format 'url''.
    Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L250
    ⚠️ LroExtension Operations with a 202 response should specify x-ms-long-running-operation: true.
    Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L10
    ⚠️ OperationSummaryOrDescription Operation should have a summary or description.
    Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L10
    ⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
    Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L10
    ⚠️ ParameterDescription Parameter should have a description.
    Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L25
    ⚠️ LroHeaders A 202 response should include an Operation-Location response header.
    Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L35
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L41
    ⚠️ OperationSummaryOrDescription Operation should have a summary or description.
    Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L57
    ⚠️ GetInOperationName 'GET' operation 'Stream_DownloadMedia' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L61
    ⚠️ OperationId OperationId for get method should contain 'Get' or 'list'
    Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L61
    ⚠️ ParameterDescription Parameter should have a description.
    Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L66
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L66
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L83
    ⚠️ SecurityDefinitionDescription Security definition should have a description.
    Location: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L237
    ️❌Avocado: 3 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: data-plane/Messaging/preview/2022-06-30-preview
    ❌ MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: Messaging/preview/2022-06-30-preview/examples
    ❌ MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: specification/communication/data-plane/Messaging
    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ RESPONSE_BODY_NOT_IN_EXAMPLE Response statusCode 200 for operation Stream_DownloadMedia has no response body provided in the example, however the response does have a "schema" defined in the swagger spec.
    Url: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L76:22
    ExampleUrl: preview/2023-02-01-preview/examples/DownloadMedia.json#L8:16
    ❌ RESPONSE_BODY_NOT_IN_EXAMPLE Response statusCode 200 for operation Stream_DownloadMedia has no response body provided in the example, however the response does have a "schema" defined in the swagger spec.
    Url: Messages/preview/2023-02-01-preview/CommunicationServicesMessages.json#L76:22
    ExampleUrl: preview/2023-02-01-preview/examples/DownloadMedia.json#L8:16
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    ️️✔️CadlValidation succeeded [Detail] [Expand] 
    Validation passes for CadlValidation.
    ️❌PR Summary: 0 Errors, 0 Warnings failed [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 3, 2023 •
    edited
    Loading

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 3, 2023 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    swagger communication-data-plane-Messages https://apiview.dev/Assemblies/Review/6d021a8c93854278a52dff7bdfd01311

    @ajpeacock0 ajpeacock0 merged commit a6a0b7b into Azure:gelli/addMessagingApiSpec Feb 3, 2023
    glorialimicrosoft pushed a commit that referenced this pull request Aug 24, 2023
    @ajpeacock0 @glorialimicrosoft
    Changing API version and renaming to Messages (#22450)
    d15531d
    glorialimicrosoft added a commit that referenced this pull request Oct 9, 2023
    @glorialimicrosoft @ajpeacock0
    Add azure communication messages service (#26139)
    e21e27e 
    * add api spec for cross-platform messaging service

* remove external from swagger

* Update communicationservicesmessaging.json

* Update communicationservicesmessaging.json

* address comments from internal review

* use only one recipient as example

* Address Azure Review feedback

Add To field in SendMessageResult and change examples used in SendMessageRequest

* address azure sdk review comments

* Update communicationservicesmessaging.json

* Adding Media Stream Endpoint (#21763)

**Additional Changes**
- Adding successful response info
- Adding Examples

* Changing API version and renaming to Messages (#22450)

* Add ACS-CPM's template APIs with examples

* Merge template API into our public version

* New iteration

- Take comments into account
- Big changes in the API due to spec and scope changes

* Update CommunicationServicesMessages.json to latest

* Changing API version to 2023-08-24-preview

* add "x-ms-examples"

* attempt to fix RESPONSE_BODY_NOT_IN_EXAMPLE error

* fix lint

* fix Swagger LintDiff

* fix more Swagger LintDiff

* fix Swagger ModelValidation: Long running operation should return Operation-Id

* fix prettier

* fix prettier

* fix Swagger ModelValidation

* remove operation-id header for now until we get answer from azure board

* Delete readme.csharp.md

---------

Co-authored-by: Andrew Peacock <ajpeacock0@outlook.com>
Co-authored-by: Samuel <SAVIN>
    jnlycklama pushed a commit that referenced this pull request Nov 8, 2023
    @glorialimicrosoft @ajpeacock0 @jnlycklama
    Add azure communication messages service (#26139)
    170af27 
    * add api spec for cross-platform messaging service

* remove external from swagger

* Update communicationservicesmessaging.json

* Update communicationservicesmessaging.json

* address comments from internal review

* use only one recipient as example

* Address Azure Review feedback

Add To field in SendMessageResult and change examples used in SendMessageRequest

* address azure sdk review comments

* Update communicationservicesmessaging.json

* Adding Media Stream Endpoint (#21763)

**Additional Changes**
- Adding successful response info
- Adding Examples

* Changing API version and renaming to Messages (#22450)

* Add ACS-CPM's template APIs with examples

* Merge template API into our public version

* New iteration

- Take comments into account
- Big changes in the API due to spec and scope changes

* Update CommunicationServicesMessages.json to latest

* Changing API version to 2023-08-24-preview

* add "x-ms-examples"

* attempt to fix RESPONSE_BODY_NOT_IN_EXAMPLE error

* fix lint

* fix Swagger LintDiff

* fix more Swagger LintDiff

* fix Swagger ModelValidation: Long running operation should return Operation-Id

* fix prettier

* fix prettier

* fix Swagger ModelValidation

* remove operation-id header for now until we get answer from azure board

* Delete readme.csharp.md

---------

Co-authored-by: Andrew Peacock <ajpeacock0@outlook.com>
Co-authored-by: Samuel <SAVIN>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @JeffreyRichter JeffreyRichter JeffreyRichter approved these changes

    @MushMal MushMal Awaiting requested review from MushMal MushMal was automatically assigned from Azure/api-stewardship-board

    Assignees
    No one assigned
    Labels
    None yet
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @ajpeacock0 @JeffreyRichter