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

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

Merged
merged 16 commits into from
Jun 6, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Suppress more documentation-required
  • Loading branch information
mikeharder committed Jun 5, 2023
commit acaa890f290d3292304bbe07b228ea24a1fbf2e1
1 change: 1 addition & 0 deletions specification/cognitiveservices/ContentSafety/main.tsp
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ https://<resource-name>.cognitiveservices.azure.com).
@doc("Analyze harmful content")
namespace ContentSafety;

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy spec"
enum Versions {
@useDependency(Azure.Core.Versions.v1_0_Preview_2)
v2023_04_30_Preview: "2023-04-30-preview",
Expand Down
2 changes: 2 additions & 0 deletions specification/cognitiveservices/ContentSafety/models.tsp
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ using TypeSpec.Rest;

namespace ContentSafety;

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy spec"
@doc("Text analyze category")
enum TextCategory {
Hate,
Expand All @@ -14,6 +15,7 @@ enum TextCategory {
Violence,
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy spec"
@doc("Image analyze category")
enum ImageCategory {
Hate,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,15 @@ model PatientInfo {
clinicalInfo?: ClinicalCodedElement[];
}

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

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

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

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
@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
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ model TrialMatcherInferenceEvidence {
...InferenceEvidence;
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Existing API"
@doc("The status of the processing job.")
enum JobStatus {
NotStarted: "notStarted",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,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"
@doc("The type of the Onco Phenotype inference.")
enum OncoPhenotypeInferenceType {
TumorSite: "tumorSite",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ using TypeSpec.Versioning;

namespace AzureHealthInsights;

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Existing API"
enum ApiVersion {
@useDependency(Azure.Core.Versions.v1_0_Preview_1)
v2023_03_01_preview: "2023-03-01-preview"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -330,20 +330,23 @@ model ClinicalTrialResearchFacility {
...GeographicLocation;
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
@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"
@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"
@doc("Possible phases of a clinical trial.")
enum ClinicalTrialPhase {
NotApplicable: "notApplicable",
Expand All @@ -354,6 +357,7 @@ enum ClinicalTrialPhase {
Phase4: "phase4",
}

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

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
@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"
@doc("Possible purposes of a clinical trial.")
enum ClinicalTrialPurpose {
NotApplicable: "notApplicable",
Expand All @@ -384,27 +389,32 @@ enum ClinicalTrialPurpose {
Other: "other",
}

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

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

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

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

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy API"
@doc("The type of the Trial Matcher inference.")
enum TrialMatcherInferenceType {
TrialEligibility: "trialEligibility",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ model FleetHubProfile {
kubernetesVersion?: string;
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy Spec"
@lroStatus
@doc("The provisioning state of the last accepted operation.")
enum FleetProvisioningState {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ model FleetMemberProperties {
provisioningState?: FleetMemberProvisioningState;
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy Spec"
@lroStatus
@doc("The provisioning state of the last accepted operation.")
enum FleetMemberProvisioningState {
Expand Down
1 change: 1 addition & 0 deletions specification/containerservice/Fleet.Management/main.tsp
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ namespace Microsoft.ContainerService;

interface Operations extends Azure.ResourceManager.Operations {}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Version does not need documentation"
enum Versions {
@useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1)
v2022_09_02_preview: "2022-09-02-preview",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ enum ManagedClusterUpgradeType{
NodeImageOnly
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy Spec"
@doc("The state of the UpdateRun, UpdateStage, UpdateGroup, or MemberUpdate.")
enum UpdateState {
NotStarted,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ model AssociationProperties {

}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy Spec"
enum AssociationType {
"subnets",
}
Expand Down Expand Up @@ -108,6 +109,7 @@ model TrafficControllerProperties {
provisioningState?: ProvisioningState;
}

#suppress "@azure-tools/typespec-azure-core/documentation-required" "Legacy Spec"
@lroStatus
enum ProvisioningState{
Provisioning,
Expand Down