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

Language.AnalyzeText and Language.Conversations migration to Typespec #27392

Conversation

quentinRobinson
Copy link
Member

@quentinRobinson quentinRobinson commented Jan 16, 2024

Data Plane API - Pull Request

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

  • Link to API Spec engagement record issue:

Is this review for (select one):

  • a private preview
  • a public preview
  • GA release

Change Scope

This Change is to migrate the Language.AnalyzeText and Language.Conversations APIs to typespec

This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.

  • Design Document:
  • Previous API Spec Doc:
  • Updated paths:

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

Checks stuck in `queued` state? If the PR CI checks appear to be stuck in `queued` state, please add a comment with contents `/azp run`. This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes.

fix #27554

Zach-King2 and others added 30 commits June 28, 2023 17:36
* setup

* modified CODEOWNERS

* new changes

* new changes

* new changes

* fixing validation errors
* setup

* modified CODEOWNERS

* new changes

* new changes

* new changes

* fixing validation errors

* adding models

* added models

* resolved comments

* added AADToken

* defined AADToken as model

* added common.tsp

* edited formatting

* fixed syntax

* resolved comments

* removed required property

* changed ErrorResponse to a model

* model updates
* added route

* added examples to path object

* fixed example file paths

* route changes

* removed union

* fixes

* fixes

* fixes

* fixes

* fixed example file paths

* removed example

* updated route

* rebase

* rebase

* rebase

* added examples to path object

* fixed example file paths

* rebase

* edited config

* added comment

* removed import

* added team as codeowners

* removed examples

* added version enum and edited tspconfig

* added doc decorators to enums

* added more doc decorators to enums

* validation fixes

* lint diff fix

* suppressed warnings

* supressed enum warnings and removed '/language' from hostTemplate
* added route

* added examples to path object

* fixed example file paths

* route changes

* removed union

* fixes

* fixes

* fixes

* fixes

* fixed example file paths

* removed example

* updated route

* rebase

* rebase

* rebase

* added examples to path object

* fixed example file paths

* rebase

* edited config

* added comment

* removed import

* added team as codeowners

* removed examples

* added version enum and edited tspconfig

* added doc decorators to enums

* added more doc decorators to enums

* validation fixes

* lint diff fix

* suppressed warnings

* supressed enum warnings and removed '/language' from hostTemplate

* added projectedname decorator to some properties

* edits to models in common.tsp

* edited model properties in main.tsp
* added route

* added examples to path object

* fixed example file paths

* route changes

* removed union

* fixes

* fixes

* fixes

* fixes

* fixed example file paths

* removed example

* updated route

* rebase

* rebase

* rebase

* added examples to path object

* fixed example file paths

* rebase

* edited config

* added comment

* removed import

* added team as codeowners

* removed examples

* added version enum and edited tspconfig

* added doc decorators to enums

* added more doc decorators to enums

* validation fixes

* lint diff fix

* suppressed warnings

* supressed enum warnings and removed '/language' from hostTemplate

* added projectedname decorator to some properties

* edits to models in common.tsp

* edited model properties in main.tsp

* fixed spacing

* updating config

* spacing fix

* modified service-dir path

* removed csharp

* tsp config changes

* removed autorest import

* LuisTargetIntentResult model update

* added csharp emitter

* model change

* removed autorest

* model property change

* modified model property

* useauth change

* capitalized endpoint

* changed endpoint to lowercase

* back to uppercase
* added route

* added examples to path object

* fixed example file paths

* route changes

* removed union

* fixes

* fixes

* fixes

* fixes

* fixed example file paths

* removed example

* updated route

* rebase

* rebase

* rebase

* added examples to path object

* fixed example file paths

* rebase

* edited config

* added comment

* removed import

* added team as codeowners

* removed examples

* added version enum and edited tspconfig

* added doc decorators to enums

* added more doc decorators to enums

* validation fixes

* lint diff fix

* suppressed warnings

* supressed enum warnings and removed '/language' from hostTemplate

* added projectedname decorator to some properties

* edits to models in common.tsp

* edited model properties in main.tsp

* fixed spacing

* updating config

* spacing fix

* modified service-dir path

* removed csharp

* tsp config changes

* removed autorest import

* LuisTargetIntentResult model update

* added csharp emitter

* model change

* removed autorest

* model property change

* modified model property

* useauth change

* capitalized endpoint

* changed endpoint to lowercase

* back to uppercase

* sdk generation fix
…r Analyze Conversations (Azure#24899)

Added 2023-04-01 and 2023-04-15-preview version models to TypeSpec for Analyze Conversations
---------

Co-authored-by: Quentin Robinson <[email protected]>
…ions-typespec.2' into qrobinson/feature-cognitiveserviecs-langueage.AnalyzeText-typespec.1
…ecs-language.conversations-typespec.3' into qrobinson/feature-cognitiveserviecs-langueage.AnalyzeText-typespec.1
* setup

* modified CODEOWNERS

* new changes

* new changes

* new changes

* fixing validation errors
* setup

* modified CODEOWNERS

* new changes

* new changes

* new changes

* fixing validation errors

* adding models

* added models

* resolved comments

* added AADToken

* defined AADToken as model

* added common.tsp

* edited formatting

* fixed syntax

* resolved comments

* removed required property

* changed ErrorResponse to a model

* model updates
* added route

* added examples to path object

* fixed example file paths

* route changes

* removed union

* fixes

* fixes

* fixes

* fixes

* fixed example file paths

* removed example

* updated route

* rebase

* rebase

* rebase

* added examples to path object

* fixed example file paths

* rebase

* edited config

* added comment

* removed import

* added team as codeowners

* removed examples

* added version enum and edited tspconfig

* added doc decorators to enums

* added more doc decorators to enums

* validation fixes

* lint diff fix

* suppressed warnings

* supressed enum warnings and removed '/language' from hostTemplate
* added route

* added examples to path object

* fixed example file paths

* route changes

* removed union

* fixes

* fixes

* fixes

* fixes

* fixed example file paths

* removed example

* updated route

* rebase

* rebase

* rebase

* added examples to path object

* fixed example file paths

* rebase

* edited config

* added comment

* removed import

* added team as codeowners

* removed examples

* added version enum and edited tspconfig

* added doc decorators to enums

* added more doc decorators to enums

* validation fixes

* lint diff fix

* suppressed warnings

* supressed enum warnings and removed '/language' from hostTemplate

* added projectedname decorator to some properties

* edits to models in common.tsp

* edited model properties in main.tsp
* added route

* added examples to path object

* fixed example file paths

* route changes

* removed union

* fixes

* fixes

* fixes

* fixes

* fixed example file paths

* removed example

* updated route

* rebase

* rebase

* rebase

* added examples to path object

* fixed example file paths

* rebase

* edited config

* added comment

* removed import

* added team as codeowners

* removed examples

* added version enum and edited tspconfig

* added doc decorators to enums

* added more doc decorators to enums

* validation fixes

* lint diff fix

* suppressed warnings

* supressed enum warnings and removed '/language' from hostTemplate

* added projectedname decorator to some properties

* edits to models in common.tsp

* edited model properties in main.tsp

* fixed spacing

* updating config

* spacing fix

* modified service-dir path

* removed csharp

* tsp config changes

* removed autorest import

* LuisTargetIntentResult model update

* added csharp emitter

* model change

* removed autorest

* model property change

* modified model property

* useauth change

* capitalized endpoint

* changed endpoint to lowercase

* back to uppercase
* added route

* added examples to path object

* fixed example file paths

* route changes

* removed union

* fixes

* fixes

* fixes

* fixes

* fixed example file paths

* removed example

* updated route

* rebase

* rebase

* rebase

* added examples to path object

* fixed example file paths

* rebase

* edited config

* added comment

* removed import

* added team as codeowners

* removed examples

* added version enum and edited tspconfig

* added doc decorators to enums

* added more doc decorators to enums

* validation fixes

* lint diff fix

* suppressed warnings

* supressed enum warnings and removed '/language' from hostTemplate

* added projectedname decorator to some properties

* edits to models in common.tsp

* edited model properties in main.tsp

* fixed spacing

* updating config

* spacing fix

* modified service-dir path

* removed csharp

* tsp config changes

* removed autorest import

* LuisTargetIntentResult model update

* added csharp emitter

* model change

* removed autorest

* model property change

* modified model property

* useauth change

* capitalized endpoint

* changed endpoint to lowercase

* back to uppercase

* sdk generation fix
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Apr 17, 2024
@catalinaperalta catalinaperalta removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required ARMReview resource-manager labels Apr 17, 2024
Copy link
Member

@tjprescott tjprescott left a comment

Choose a reason for hiding this comment

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

Github won't let me dismiss the review, so hopefully this works.

@tjprescott tjprescott self-requested a review April 17, 2024 15:48
@lmazuel lmazuel dismissed tjprescott’s stale review April 17, 2024 19:54

Because it asked me to

Copy link
Member

@catalinaperalta catalinaperalta left a comment

Choose a reason for hiding this comment

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

Looks like we need to run tsp format for typespec validation to pass. DONE

The .net SDK is currently swagger based and has hand written conveniences. Patching will be necessary to update the SDK with DPG.

@catalinaperalta catalinaperalta merged commit 72d10f1 into Azure:main Apr 17, 2024
31 of 32 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required data-plane ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test TypeSpec Authored with TypeSpec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Azure Cognitive service for language ] API Review