azure-rest-api-specs
azure-rest-api-specs copied to clipboard
[Cognitive Services Text Analytics API] API Review
New API Review meeting has been requested.
Service Name: Cognitive Services Text Analytics API Review Created By: Kareem Yousef Review Date: 1/11/2023 9:00 AM PT PR: Hero Scenarios Link: Not Provided Core Concepts Doc Link: Not Provided
Description: A new task to Language's Text Analyze API for Custom Health model as an extension to current prebuilt health model (TA4H)
Detailed meeting information and documents provided can be accessed here For more information that will help prepare you for this review, the requirements, and office hours, visit the documentation here
PR Link here: https://github.com/Azure/azure-rest-api-specs/pull/22051
Spec doc here: https://microsofteur-my.sharepoint.com/:w:/g/personal/yelsehrawy_microsoft_com/EbkytZgpyDJJrysEEn5pr_sBgYCOOejOfctnHfo3Qrks5g?e=pLjBxH
API Stewardship Board Review: 11-Jan-2023
- Make sure that it is well documented that new
kind
of components may come back in the future. This should be documented in the OpenAPI document - Is there a way to avoid using polymorphism. A recommended way to approach this is to author code that a customer would write.
-
kind
is our preferred discriminator name. see: api-guidelines/Guidelines.md at vNext · microsoft/api-guidelines (github.com)
-
- Recommendation: write the user code to see if that seems like it will be easy for users to figure out
- Can the descriptions for the component information be improved?
- "entityComponentKind" vs "componentKind"? Either seem to be fine, as long as x-ms-enum.name is explicit.
Changes moved to development branch. Closing.