Skip to content

feat: Updated OpenAPI spec #65

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

Merged
HavenDV merged 1 commit into from
Sep 8, 2026
Merged

feat: Updated OpenAPI spec #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 15 additions & 2 deletions src/libs/Terra/Generated/Terra.Models.LabReportReferenceRange.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,17 @@ public sealed partial class LabReportReferenceRange
public double? Upper { get; set; }

/// <summary>
///
/// Coded range type (open enum: normal, low, high, borderline_low, borderline_high, critical_low, critical_high, abnormal, therapeutic, subtherapeutic, toxic). A lossy coding of `label`, judged from the report's wording and where the band sits among the result's ranges — a prediabetes band between the no-diabetes and diabetes bands is borderline_high. Omitted when nothing in the vocabulary fits.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("type")]
public string? Type { get; set; }

/// <summary>
/// The range's classification exactly as the report printed it — "Optimal", "Moderate", "Consistent with increased risk for diabetes (prediabetes)". When a result carries several ranges they are bands, not one normal interval; this is the field that says what each band means.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("label")]
public string? Label { get; set; }

/// <summary>
/// The patient dimensions a reference range is scoped by.
/// </summary>
Expand All @@ -43,7 +49,12 @@ public sealed partial class LabReportReferenceRange
/// </summary>
/// <param name="lower"></param>
/// <param name="upper"></param>
/// <param name="type"></param>
/// <param name="type">
/// Coded range type (open enum: normal, low, high, borderline_low, borderline_high, critical_low, critical_high, abnormal, therapeutic, subtherapeutic, toxic). A lossy coding of `label`, judged from the report's wording and where the band sits among the result's ranges — a prediabetes band between the no-diabetes and diabetes bands is borderline_high. Omitted when nothing in the vocabulary fits.
/// </param>
/// <param name="label">
/// The range's classification exactly as the report printed it — "Optimal", "Moderate", "Consistent with increased risk for diabetes (prediabetes)". When a result carries several ranges they are bands, not one normal interval; this is the field that says what each band means.
/// </param>
/// <param name="context">
/// The patient dimensions a reference range is scoped by.
/// </param>
Expand All @@ -54,11 +65,13 @@ public LabReportReferenceRange(
double? lower,
double? upper,
string? type,
string? label,
global::Terra.LabReportRangeContext? context)
{
this.Lower = lower;
this.Upper = upper;
this.Type = type;
this.Label = label;
this.Context = context;
}

Expand Down
9 changes: 8 additions & 1 deletion src/libs/Terra/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ openapi: 3.0.3
info:
description: The Terra API (v2 surface, served at access.tryterra.co/api/v2).
title: TerraAPI
version: 2026.09.08.1
version: 2026.09.08.2
license:
name: Apache-2.0
url: https://github.com/tryterra/openapi/blob/master/LICENSE
Expand Down Expand Up @@ -3457,6 +3457,13 @@ components:
type: number
type:
type: string
description: 'Coded range type (open enum: normal, low, high, borderline_low, borderline_high, critical_low, critical_high, abnormal, therapeutic, subtherapeutic, toxic). A lossy coding of `label`,
judged from the report''s wording and where the band sits among the result''s ranges — a prediabetes band between the no-diabetes and diabetes bands is borderline_high. Omitted when nothing
in the vocabulary fits.'
label:
type: string
description: The range's classification exactly as the report printed it — "Optimal", "Moderate", "Consistent with increased risk for diabetes (prediabetes)". When a result carries several ranges
they are bands, not one normal interval; this is the field that says what each band means.
context:
$ref: '#/components/schemas/LabReportRangeContext'
description: One reference range. type describes the range, not a verdict on the result.
Expand Down