Cognitive Services Language GA API 2022-05-01 Swagger #18402
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @nourhaanfarid Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
|
[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. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The default tag does not contain all APIs in this RP. Please make sure the missing API swaggers are in the default tag. readme: cognitiveservices/data-plane/Language/readme.md json: Language/stable/2021-10-01/questionanswering-authoring.json |
|
The default tag does not contain all APIs in this RP. Please make sure the missing API swaggers are in the default tag. readme: cognitiveservices/data-plane/Language/readme.md json: Language/stable/2021-10-01/questionanswering.json |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 1 Errors, 31 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.3)
- current:stable/2022-05-01/common.json compared with base:stable/2021-10-01/common.json
- current:stable/2022-05-01/common.json compared with base:preview/2022-03-01-preview/common.json
- current:stable/2022-05-01/textanalytics.json compared with base:preview/2022-03-01-preview/textanalytics.json
| Rule | Message |
|---|---|
|
The new version has new required property 'error' that was not found in the old version. New: Language/stable/2022-05-01/common.json#L10:5 Old: Language/stable/2021-10-01/common.json#L10:5 |
The following breaking changes are detected by comparison with latest preview version:
Only 30 items are listed, please refer to log for more details.
️🔄SDK Track2 Validation inProgress [Detail]
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
ghost
added
the
customer-reported
Swagger Generation Artifacts
|
|
Thank you for your contribution nourhaanfarid! We will review the pull request and get back to you soon. |
|
|
nourhaanfarid
changed the title
|
Hi @nourhaanfarid, Your PR has some issues. Please fix the CI sequentially by following the order of
|
heaths
requested changes
Mar 25, 2022
There was a problem hiding this comment.
- This is missing examples and a readme.md file change. To create a new version, you should:
- Checkout, if necessary, the source branch.
- Copy all files from the source version recursively i.e., including samples, to the new directory e.g., "stable/2022-05-01".
- Change the api-version in all copied files accordingly.
- Add the tagged package in readme.md and update the top-level
tag: {new api-version}accordingly.
- From what api-version is this based so I can do a semantic diff?
- Please be sure to look through the validation errors before I can fully review. Many of these are likely due to missing examples and missing readme.md changes.
/cc @abhahn
…anguage-2022-03-01-preview
heaths
requested changes
Mar 28, 2022
...s/data-plane/Language/stable/2022-05-01/examples/SuccessfulAnalyzeTextJobsCancelRequest.json
Outdated
Show resolved
Hide resolved
specification/cognitiveservices/data-plane/Language/stable/2022-05-01/textanalytics.json
Show resolved
Hide resolved
|
/azp run SDK Track2 Validation |
|
No pipelines are associated with this pull request. |
|
/azu run Swagger LintDiff |
|
@johanste @JeffreyRichter, @nourhaanfarid will verify that these changes I found in a comment are expected, but this is based on 2022-02-01-preview and should be against 2022-03-01-preview which merged to main this morning. This PR, however, targets a release branch that shouldn't rebase on main, and merging main would pull in dozens or hundreds of commits and untold numbers of files. |
All missing and chaged objects based on 2022-03-01-preview are reviewed and expected. @johanste @JeffreyRichter please bypass validation to proceed further with them |
JeffreyRichter
added
the
Approved-BreakingChange
heaths
approved these changes
Apr 11, 2022
|
@johanste @mayurid @lmazuel can you merge? The SDK issue is known and we'll look at it separately, and the specific Avocado error is going to keep being a problem with this pseudo-RP we're using for Language since we don't ship every service with every API published. We either need to revisit this problem or find a way to exempt it in the readme.md or something, which I currently seem unable to do with this class of error. /cc @akning-ms if there's a way. |
lmazuel
merged commit 9b0c1db
into
Azure:release-cognitiveservices-Language-2022-05-01-GA
nourhaanfarid
added a commit
to nourhaanfarid/azure-rest-api-specs
that referenced
this pull request
May 23, 2022
* adding Swagger for GA API * remove extractive summerization changes * run .\Copy-AzSpecifications.ps1 -SourceBranch dev-cognitiveservices-Language-2022-03-01-preview * removing extractive summerization from results * removing analyze conversation APIs auto generated from March APIs * single classification with array of class as multi classification * update readme * update the read me * update read.me * code review # Conflicts: # specification/cognitiveservices/data-plane/Language/readme.md
lmazuel
pushed a commit
that referenced
this pull request
May 23, 2022
* Cognitive Services Language GA API 2022-05-01 Swagger (#18402) * adding Swagger for GA API * remove extractive summerization changes * run .\Copy-AzSpecifications.ps1 -SourceBranch dev-cognitiveservices-Language-2022-03-01-preview * removing extractive summerization from results * removing analyze conversation APIs auto generated from March APIs * single classification with array of class as multi classification * update readme * update the read me * update read.me * code review # Conflicts: # specification/cognitiveservices/data-plane/Language/readme.md * Use azure-sdk-for-net-track2 for validation (#18756) * Add Language authoring 2022-05-01 APIs (#18694) * Add Language authoring 2022-05-01 APIs * Some build fixes * Add polymerphism for CLU exported project * Rename the api-version property in the import body * Retrigger CI * Update the hostTemplate and the operation Ids * Use the common error objects * Remove redundant definitions * Update the stringIndexType * Revert "Update the stringIndexType" This reverts commit 455762d. * Fix import/export object in CT * Rename actual to predicted * Add the APIs examples * Fix the examples validations * Fix prettier * Fix autorest issues * Fix nextLink examples regression * Retrigger CI * Renaming the swagger files * Apply PR feedback - part 1 * Add the documentation for the schemas * Fix spelling errors * Update the descriptions for the analyzetext-authoring * Rename project-file-version to projectFileVersion * Add CLU 2022-05-01 GA version (#18759) * Add CLU 2022-05-01 GA version * Remove role * Update modality to inputModality * Do not update property name to inputModality, only the enum name. * Resolve comments * Rename CustomConversation Co-authored-by: Chong Tang <[email protected]> * Update Language authoring and runtime APIs to follow the same convention (2022-05-01) (#18836) * Update authoring and runtime APIs to follow the same convention * Update the examples * Remove other references to "named" in "named entity recognition" * Remove more 'named' from the swagger * Adding the missing 'required' attribute present in preview APIs and not in the GA version (#18946) * Adding the missing 'required' attribute present in preview APIs and not in the GA version * Updates * Add api-version parameter to cancel job endpoint (#18985) * Use PascalCase for enum values (#18840) * rename LUIS to Luis * use camel case for enum values * Revert "use camel case for enum values" This reverts commit 8db93fb. Co-authored-by: Chong Tang <[email protected]> * Copy QuestionAnswering definitions to common.json and refer them in analyzeconversations.json (#19030) Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Heath Stewart <[email protected]> Co-authored-by: Mohamed Abbas <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Bidisha Chakraborty <[email protected]>
heaths
added a commit
that referenced
this pull request
May 24, 2022
* Cognitive Services Language GA API 2022-05-01 Swagger (#18402) * adding Swagger for GA API * remove extractive summerization changes * run .\Copy-AzSpecifications.ps1 -SourceBranch dev-cognitiveservices-Language-2022-03-01-preview * removing extractive summerization from results * removing analyze conversation APIs auto generated from March APIs * single classification with array of class as multi classification * update readme * update the read me * update read.me * code review * Use azure-sdk-for-net-track2 for validation (#18756) * Add Language authoring 2022-05-01 APIs (#18694) * Add Language authoring 2022-05-01 APIs * Some build fixes * Add polymerphism for CLU exported project * Rename the api-version property in the import body * Retrigger CI * Update the hostTemplate and the operation Ids * Use the common error objects * Remove redundant definitions * Update the stringIndexType * Revert "Update the stringIndexType" This reverts commit 455762d. * Fix import/export object in CT * Rename actual to predicted * Add the APIs examples * Fix the examples validations * Fix prettier * Fix autorest issues * Fix nextLink examples regression * Retrigger CI * Renaming the swagger files * Apply PR feedback - part 1 * Add the documentation for the schemas * Fix spelling errors * Update the descriptions for the analyzetext-authoring * Rename project-file-version to projectFileVersion * Add CLU 2022-05-01 GA version (#18759) * Add CLU 2022-05-01 GA version * Remove role * Update modality to inputModality * Do not update property name to inputModality, only the enum name. * Resolve comments * Rename CustomConversation Co-authored-by: Chong Tang <[email protected]> * Update Language authoring and runtime APIs to follow the same convention (2022-05-01) (#18836) * Update authoring and runtime APIs to follow the same convention * Update the examples * Remove other references to "named" in "named entity recognition" * Remove more 'named' from the swagger * Adding the missing 'required' attribute present in preview APIs and not in the GA version (#18946) * Adding the missing 'required' attribute present in preview APIs and not in the GA version * Updates * Add api-version parameter to cancel job endpoint (#18985) * Use PascalCase for enum values (#18840) * rename LUIS to Luis * use camel case for enum values * Revert "use camel case for enum values" This reverts commit 8db93fb. Co-authored-by: Chong Tang <[email protected]> * Copy QuestionAnswering definitions to common.json and refer them in analyzeconversations.json (#19030) Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Heath Stewart <[email protected]> Co-authored-by: Mohamed Abbas <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Bidisha Chakraborty <[email protected]>
25 tasks
lmazuel
pushed a commit
that referenced
this pull request
May 24, 2022
* Cognitive Services Language GA API 2022-05-01 Swagger (#18402) * adding Swagger for GA API * remove extractive summerization changes * run .\Copy-AzSpecifications.ps1 -SourceBranch dev-cognitiveservices-Language-2022-03-01-preview * removing extractive summerization from results * removing analyze conversation APIs auto generated from March APIs * single classification with array of class as multi classification * update readme * update the read me * update read.me * code review * Use azure-sdk-for-net-track2 for validation (#18756) * Add Language authoring 2022-05-01 APIs (#18694) * Add Language authoring 2022-05-01 APIs * Some build fixes * Add polymerphism for CLU exported project * Rename the api-version property in the import body * Retrigger CI * Update the hostTemplate and the operation Ids * Use the common error objects * Remove redundant definitions * Update the stringIndexType * Revert "Update the stringIndexType" This reverts commit 455762d. * Fix import/export object in CT * Rename actual to predicted * Add the APIs examples * Fix the examples validations * Fix prettier * Fix autorest issues * Fix nextLink examples regression * Retrigger CI * Renaming the swagger files * Apply PR feedback - part 1 * Add the documentation for the schemas * Fix spelling errors * Update the descriptions for the analyzetext-authoring * Rename project-file-version to projectFileVersion * Add CLU 2022-05-01 GA version (#18759) * Add CLU 2022-05-01 GA version * Remove role * Update modality to inputModality * Do not update property name to inputModality, only the enum name. * Resolve comments * Rename CustomConversation Co-authored-by: Chong Tang <[email protected]> * Update Language authoring and runtime APIs to follow the same convention (2022-05-01) (#18836) * Update authoring and runtime APIs to follow the same convention * Update the examples * Remove other references to "named" in "named entity recognition" * Remove more 'named' from the swagger * Adding the missing 'required' attribute present in preview APIs and not in the GA version (#18946) * Adding the missing 'required' attribute present in preview APIs and not in the GA version * Updates * Add api-version parameter to cancel job endpoint (#18985) * Use PascalCase for enum values (#18840) * rename LUIS to Luis * use camel case for enum values * Revert "use camel case for enum values" This reverts commit 8db93fb. Co-authored-by: Chong Tang <[email protected]> * Copy QuestionAnswering definitions to common.json and refer them in analyzeconversations.json (#19030) Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Heath Stewart <[email protected]> Co-authored-by: Mohamed Abbas <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Bidisha Chakraborty <[email protected]> Co-authored-by: Nourhan <[email protected]> Co-authored-by: Mohamed Abbas <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Bidisha Chakraborty <[email protected]>
gargankit-microsoft
pushed a commit
that referenced
this pull request
May 26, 2022
* Cognitive Services Language GA API 2022-05-01 Swagger (#18402) * adding Swagger for GA API * remove extractive summerization changes * run .\Copy-AzSpecifications.ps1 -SourceBranch dev-cognitiveservices-Language-2022-03-01-preview * removing extractive summerization from results * removing analyze conversation APIs auto generated from March APIs * single classification with array of class as multi classification * update readme * update the read me * update read.me * code review * Use azure-sdk-for-net-track2 for validation (#18756) * Add Language authoring 2022-05-01 APIs (#18694) * Add Language authoring 2022-05-01 APIs * Some build fixes * Add polymerphism for CLU exported project * Rename the api-version property in the import body * Retrigger CI * Update the hostTemplate and the operation Ids * Use the common error objects * Remove redundant definitions * Update the stringIndexType * Revert "Update the stringIndexType" This reverts commit 455762d. * Fix import/export object in CT * Rename actual to predicted * Add the APIs examples * Fix the examples validations * Fix prettier * Fix autorest issues * Fix nextLink examples regression * Retrigger CI * Renaming the swagger files * Apply PR feedback - part 1 * Add the documentation for the schemas * Fix spelling errors * Update the descriptions for the analyzetext-authoring * Rename project-file-version to projectFileVersion * Add CLU 2022-05-01 GA version (#18759) * Add CLU 2022-05-01 GA version * Remove role * Update modality to inputModality * Do not update property name to inputModality, only the enum name. * Resolve comments * Rename CustomConversation Co-authored-by: Chong Tang <[email protected]> * Update Language authoring and runtime APIs to follow the same convention (2022-05-01) (#18836) * Update authoring and runtime APIs to follow the same convention * Update the examples * Remove other references to "named" in "named entity recognition" * Remove more 'named' from the swagger * Adding the missing 'required' attribute present in preview APIs and not in the GA version (#18946) * Adding the missing 'required' attribute present in preview APIs and not in the GA version * Updates * Add api-version parameter to cancel job endpoint (#18985) * Use PascalCase for enum values (#18840) * rename LUIS to Luis * use camel case for enum values * Revert "use camel case for enum values" This reverts commit 8db93fb. Co-authored-by: Chong Tang <[email protected]> * Copy QuestionAnswering definitions to common.json and refer them in analyzeconversations.json (#19030) Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Heath Stewart <[email protected]> Co-authored-by: Mohamed Abbas <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Bidisha Chakraborty <[email protected]> Co-authored-by: Nourhan <[email protected]> Co-authored-by: Mohamed Abbas <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Bidisha Chakraborty <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
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.