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

[TypeSpec] Suppress "documentation-required" lint rule #24297

Merged
merged 16 commits into from
Jun 6, 2023
Merged

[TypeSpec] Suppress "documentation-required" lint rule #24297

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
bed8749
Suppress "documentation-required" lint rule
mikeharder Jun 5, 2023
acaa890
Suppress more documentation-required
mikeharder Jun 5, 2023
8072349
Suppress more docs
mikeharder Jun 5, 2023
ba16d2d
Fix whitespace
mikeharder Jun 5, 2023
642dd82
Add suppression
mikeharder Jun 5, 2023
83c9ef4
Replace "legacy spec" message
mikeharder Jun 5, 2023
5b557f9
Remove redundant suppress
mikeharder Jun 5, 2023
73b8176
Replace "Legacy API"
mikeharder Jun 5, 2023
ce07717
Revert whitespace
mikeharder Jun 5, 2023
f07b422
Update suppress message
mikeharder Jun 5, 2023
ab27348
Replace "Existing API"
mikeharder Jun 5, 2023
06d0390
Replace "Legacy Service"
mikeharder Jun 5, 2023
e5e7765
Merge branch 'main' into suppress-documentation-required
mikeharder Jun 6, 2023
c6df40e
"Documentation Required" linting rule should not flag version enums
mikeharder Jun 6, 2023
bdbeeca
Add link to https://github.com/Azure/typespec-azure/issues/3107
mikeharder Jun 6, 2023
6454bad
More version suppressions
mikeharder Jun 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Replace "Legacy API"
  • Loading branch information
@mikeharder
mikeharder committed Jun 5, 2023
commit 73b8176af4718f08ef2ecb6e7295e5924b85c229
8 changes: 4 additions & 4 deletions ...ification/cognitiveservices/HealthInsights/healthinsights.common/model.common.request.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,15 @@ model PatientInfo {
clinicalInfo?: ClinicalCodedElement[];
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update"
@doc("The patient's sex.")
enum PatientInfoSex {
Female: "female",
Male: "male",
Unspecified: "unspecified",
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update"
@doc("The type of the patient document, such as 'note' (text document) or 'fhirBundle' (FHIR JSON document).")
enum DocumentType {
Note: "note",
Expand All @@ -63,7 +63,7 @@ enum DocumentType {
GenomicSequencing: "genomicSequencing",
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update"
@doc("The type of the clinical document.")
enum ClinicalDocumentType {
Consultation: "consultation",
Expand All @@ -76,7 +76,7 @@ enum ClinicalDocumentType {
Pathology: "pathology",
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update"
@doc("""
The type of the content's source.
In case the source type is 'inline', the content is given as a string (for instance, text).
Expand Down
2 changes: 1 addition & 1 deletion ...ion/cognitiveservices/HealthInsights/healthinsights.oncophenotype/model.oncophenotype.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ An indication whether to perform a preliminary step on the patient's documents t



#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update"
@doc("The type of the Onco Phenotype inference.")
enum OncoPhenotypeInferenceType {
TumorSite: "tumorSite",
Expand Down
22 changes: 11 additions & 11 deletions ...ation/cognitiveservices/HealthInsights/healthinsights.trialmatcher/model.trialmatcher.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,23 +330,23 @@ model ClinicalTrialResearchFacility {
...GeographicLocation;
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update"
@doc("Possible values for the Sex eligibility criterion as accepted by clinical trials, which indicates the sex of people who may participate in a clinical study.")
enum ClinicalTrialAcceptedSex {
All: "all",
Female: "female",
Male: "male"
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update"
@doc("Possible units for a person's age.")
enum AgeUnit {
Years: "years",
Months: "months",
Days: "days",
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update"
@doc("Possible phases of a clinical trial.")
enum ClinicalTrialPhase {
NotApplicable: "notApplicable",
Expand All @@ -357,7 +357,7 @@ enum ClinicalTrialPhase {
Phase4: "phase4",
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update"
@doc("Possible study types of a clinical trial.")
enum ClinicalTrialStudyType {
Interventional: "interventional",
Expand All @@ -366,15 +366,15 @@ enum ClinicalTrialStudyType {
PatientRegistries: "patientRegistries",
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update"
@doc("Possible recruitment status of a clinical trial.")
enum ClinicalTrialRecruitmentStatus {
UnknownStatus: "unknownStatus",
NotYetRecruiting: "notYetRecruiting",
Recruiting: "recruiting",
EnrollingByInvitation: "enrollingByInvitation",
}
#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update"
@doc("Possible purposes of a clinical trial.")
enum ClinicalTrialPurpose {
NotApplicable: "notApplicable",
Expand All @@ -389,32 +389,32 @@ enum ClinicalTrialPurpose {
Other: "other",
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update"
@doc("Possible sources of a clinical trial.")
enum ClinicalTrialSource {
Custom: "custom",
ClinicaltrialsGov: "clinicaltrials.gov",
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update"
@doc("`GeoJSON` type.")
enum GeoJsonType {
Feature: "Feature",
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update"
@doc("`GeoJSON` geometry type.")
enum GeoJsonGeometryType {
Point: "Point",
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update"
@doc("`GeoJSON` object sub-type.")
enum GeoJsonPropertiesSubType {
Circle: "Circle",
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
#suppress "@azure-tools/typespec-azure-core/documentation-required" "MUST fix in next update"
@doc("The type of the Trial Matcher inference.")
enum TrialMatcherInferenceType {
TrialEligibility: "trialEligibility",
Expand Down