From a1494696bc52bf2995ae60b317dcaa746213a40b Mon Sep 17 00:00:00 2001
From: Dimitry Vislov <dmitryvislov@microsoft.com>
Date: Wed, 10 Apr 2024 11:48:50 +0300
Subject: [PATCH] add docs to healthcare tsp

---
 .../models/healthcare.tsp                     | 35 ++++++++++---------
 1 file changed, 18 insertions(+), 17 deletions(-)

diff --git a/specification/cognitiveservices/Language.AnalyzeText/models/healthcare.tsp b/specification/cognitiveservices/Language.AnalyzeText/models/healthcare.tsp
index 5c423f413dfe..d2eac84c9a26 100644
--- a/specification/cognitiveservices/Language.AnalyzeText/models/healthcare.tsp
+++ b/specification/cognitiveservices/Language.AnalyzeText/models/healthcare.tsp
@@ -11,7 +11,7 @@ namespace Language.AnalyzeText;
 @doc("Supported parameters for a Healthcare task.")
 @clientName("HealthcareTaskContent", "csharp")
 model HealthcareTaskParameters is PreBuiltTaskParameters {
-  #suppress "@azure-tools/typespec-azure-core/documentation-required"
+  @doc("Specifies the method used to interpret string offsets.")
   stringIndexType?: StringIndexType = StringIndexType.TextElements_v8;
 
   #suppress "@azure-tools/typespec-azure-core/bad-record-type"
@@ -24,14 +24,14 @@ model HealthcareTaskParameters is PreBuiltTaskParameters {
   documentType?: healthcareDocumentType;
 }
 
-#suppress "@azure-tools/typespec-azure-core/documentation-required"
+@doc("The FHIR Spec version.")
 @added(Versions.v2023_04_15_preview)
 enum fhirVersion {
   #suppress "@azure-tools/typespec-azure-core/documentation-required"
   `4.0.1`,
 }
 
-#suppress "@azure-tools/typespec-azure-core/documentation-required"
+@doc("Document type.")
 @added(Versions.v2023_04_15_preview)
 enum healthcareDocumentType {
   #suppress "@azure-tools/typespec-azure-core/documentation-required"
@@ -54,26 +54,27 @@ enum healthcareDocumentType {
   ProcedureNote,
 }
 
-#suppress "@azure-tools/typespec-azure-core/documentation-required"
+@doc("The long running task to be performed by the service on the Healthcare input documents.")
 #suppress "@azure-tools/typespec-azure-core/casing-style"
 model HealthcareLROTask extends AnalyzeTextLROTask {
-  #suppress "@azure-tools/typespec-azure-core/documentation-required"
+  @doc("Healthcare kind of the long running task.")
   kind: AnalyzeTextLROTaskKind.Healthcare;
-  #suppress "@azure-tools/typespec-azure-core/documentation-required"
+
+  @doc("Parameters for the Healthcare task.")
   parameters?: HealthcareTaskParameters;
 }
 
-#suppress "@azure-tools/typespec-azure-core/documentation-required"
+@doc("Result object for the processed Healthcare task.")
 model HealthcareResult is PreBuiltResult {
-  #suppress "@azure-tools/typespec-azure-core/documentation-required"
   @typeChangedFrom(
     Versions.v2023_04_15_preview,
     Array<HealthcareEntitiesDocumentResult>
   )
+  @doc("List of result objects for the processed Healthcare documents.")
   documents: Array<HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage>;
 }
 
-#suppress "@azure-tools/typespec-azure-core/documentation-required"
+@doc("Result object for the processed Healthcare document.")
 model HealthcareEntitiesDocumentResult is DocumentResult {
   @doc("Healthcare entities.")
   entities: Array<HealthcareEntity>;
@@ -87,7 +88,7 @@ model HealthcareEntitiesDocumentResult is DocumentResult {
   fhirBundle?: Record<unknown>;
 }
 
-#suppress "@azure-tools/typespec-azure-core/documentation-required"
+@doc("Healthcare entity extracted from the document")
 model HealthcareEntity {
   @doc("Entity text as appears in the request.")
   text: string;
@@ -107,7 +108,7 @@ model HealthcareEntity {
   @doc("Confidence score between 0 and 1 of the extracted entity.")
   confidenceScore: float64;
 
-  #suppress "@azure-tools/typespec-azure-core/documentation-required"
+  @doc("Assertion of the entity.")
   assertion?: HealthcareAssertion;
 
   @doc("Preferred name for the entity. Example: 'histologically' would have a 'name' of 'histologic'.")
@@ -328,7 +329,7 @@ enum relationType {
   VariantOfGene,
 }
 
-#suppress "@azure-tools/typespec-azure-core/documentation-required"
+@doc("Assertion of the entity.")
 model HealthcareAssertion {
   @doc("Describes any conditionality on the entity.")
   conditionality?: Conditionality;
@@ -397,7 +398,7 @@ enum Association {
   other,
 }
 
-#suppress "@azure-tools/typespec-azure-core/documentation-required"
+@doc("Entity in the relation.")
 model HealthcareRelationEntity {
   @doc("Reference link object, using a JSON pointer RFC 6901 (URI Fragment Identifier Representation), pointing to the entity .")
   ref: string;
@@ -406,7 +407,7 @@ model HealthcareRelationEntity {
   role: string;
 }
 
-#suppress "@azure-tools/typespec-azure-core/documentation-required"
+@doc("Reference to an entity in known data sources.")
 model HealthcareEntityLink {
   @doc("Entity Catalog. Examples include: UMLS, CHV, MSH, etc.")
   dataSource: string;
@@ -415,18 +416,18 @@ model HealthcareEntityLink {
   id: string;
 }
 
-#suppress "@azure-tools/typespec-azure-core/documentation-required"
 #suppress "@azure-tools/typespec-azure-core/casing-style"
+@doc("Healthcare Analyze Text long tunning opertion result object.")
 model HealthcareLROResult extends AnalyzeTextLROResult {
   @doc("Kind of the task.")
   kind: AnalyzeTextLROResultsKind.HealthcareLROResults;
 
-  #suppress "@azure-tools/typespec-azure-core/documentation-required"
+  @doc("Results of the task.")
   results: HealthcareResult;
 }
 
-#suppress "@azure-tools/typespec-azure-core/documentation-required"
 @added(Versions.v2023_04_15_preview)
+@doc("Result object for the processed Healthcare document with detected language.")
 model HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage
   is HealthcareEntitiesDocumentResult {
   ...DocumentDetectedLanguage;