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

feat(api): OpenAPI spec update via Stainless API #199

Merged
merged 1 commit into from
Apr 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
__all__ = [
"DigitalExperienceMonitoringHTTPDetails",
"HTTPStats",
"HTTPStatsAvailabilityPct",
"HTTPStatsAvailabilityPctSlot",
"HTTPStatsDNSResponseTimeMs",
"HTTPStatsDNSResponseTimeMsSlot",
"HTTPStatsHTTPStatusCode",
Expand All @@ -18,16 +20,38 @@
"HTTPStatsServerResponseTimeMs",
"HTTPStatsServerResponseTimeMsSlot",
"HTTPStatsByColo",
"HTTPStatsByColoAvailabilityPct",
"HTTPStatsByColoAvailabilityPctSlot",
"HTTPStatsByColoDNSResponseTimeMs",
"HTTPStatsByColoDNSResponseTimeMsSlot",
"HTTPStatsByColoHTTPStatusCode",
"HTTPStatsByColoResourceFetchTimeMs",
"HTTPStatsByColoResourceFetchTimeMsSlot",
"HTTPStatsByColoServerResponseTimeMs",
"HTTPStatsByColoServerResponseTimeMsSlot",
"TargetPolicy",
]


class HTTPStatsAvailabilityPctSlot(BaseModel):
timestamp: str

value: float


class HTTPStatsAvailabilityPct(BaseModel):
slots: List[HTTPStatsAvailabilityPctSlot]

avg: Optional[float] = None
"""average observed in the time period"""

max: Optional[float] = None
"""highest observed in the time period"""

min: Optional[float] = None
"""lowest observed in the time period"""


class HTTPStatsDNSResponseTimeMsSlot(BaseModel):
timestamp: str

Expand Down Expand Up @@ -98,6 +122,8 @@ class HTTPStatsServerResponseTimeMs(BaseModel):


class HTTPStats(BaseModel):
availability_pct: HTTPStatsAvailabilityPct = FieldInfo(alias="availabilityPct")

dns_response_time_ms: HTTPStatsDNSResponseTimeMs = FieldInfo(alias="dnsResponseTimeMs")

http_status_code: List[HTTPStatsHTTPStatusCode] = FieldInfo(alias="httpStatusCode")
Expand All @@ -110,6 +136,25 @@ class HTTPStats(BaseModel):
"""Count of unique devices that have run this test in the given time period"""


class HTTPStatsByColoAvailabilityPctSlot(BaseModel):
timestamp: str

value: float


class HTTPStatsByColoAvailabilityPct(BaseModel):
slots: List[HTTPStatsByColoAvailabilityPctSlot]

avg: Optional[float] = None
"""average observed in the time period"""

max: Optional[float] = None
"""highest observed in the time period"""

min: Optional[float] = None
"""lowest observed in the time period"""


class HTTPStatsByColoDNSResponseTimeMsSlot(BaseModel):
timestamp: str

Expand Down Expand Up @@ -180,6 +225,8 @@ class HTTPStatsByColoServerResponseTimeMs(BaseModel):


class HTTPStatsByColo(BaseModel):
availability_pct: HTTPStatsByColoAvailabilityPct = FieldInfo(alias="availabilityPct")

colo: str

dns_response_time_ms: HTTPStatsByColoDNSResponseTimeMs = FieldInfo(alias="dnsResponseTimeMs")
Expand All @@ -194,6 +241,15 @@ class HTTPStatsByColo(BaseModel):
"""Count of unique devices that have run this test in the given time period"""


class TargetPolicy(BaseModel):
id: str

default: bool
"""Whether the policy is the default for the account"""

name: str


class DigitalExperienceMonitoringHTTPDetails(BaseModel):
host: Optional[str] = None
"""The url of the HTTP synthetic application test"""
Expand All @@ -212,3 +268,7 @@ class DigitalExperienceMonitoringHTTPDetails(BaseModel):

name: Optional[str] = None
"""The name of the HTTP synthetic application test"""

target_policies: Optional[List[TargetPolicy]] = None

targeted: Optional[bool] = None
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
"TestHTTPResultsByColoResourceFetchTimeOverTime",
"TestHTTPResultsByColoResourceFetchTimeOverTimeTimePeriod",
"TestHTTPResultsByColoResourceFetchTimeOverTimeValue",
"TestTargetPolicy",
"TestTracerouteResults",
"TestTracerouteResultsRoundTripTime",
"TestTracerouteResultsRoundTripTimeHistory",
Expand All @@ -46,6 +47,9 @@ class OverviewMetrics(BaseModel):
tests_total: int = FieldInfo(alias="testsTotal")
"""number of tests."""

avg_http_availability_pct: Optional[float] = FieldInfo(alias="avgHttpAvailabilityPct", default=None)
"""percentage availability for all HTTP test results in response"""

avg_traceroute_availability_pct: Optional[float] = FieldInfo(alias="avgTracerouteAvailabilityPct", default=None)
"""percentage availability for all traceroutes results in response"""

Expand Down Expand Up @@ -155,6 +159,16 @@ class TestHTTPResultsByColo(BaseModel):
resource_fetch_time: TestHTTPResultsByColoResourceFetchTime = FieldInfo(alias="resourceFetchTime")


class TestTargetPolicy(BaseModel):
__test__ = False
id: str

default: bool
"""Whether the policy is the default for the account"""

name: str


class TestTracerouteResultsRoundTripTimeHistoryTimePeriod(BaseModel):
__test__ = False
units: Literal["hours", "days", "testRuns"]
Expand Down Expand Up @@ -297,6 +311,10 @@ class Test(BaseModel):
method: Optional[str] = None
"""for HTTP, the method to use when running the test"""

target_policies: Optional[List[TestTargetPolicy]] = None

targeted: Optional[bool] = None

traceroute_results: Optional[TestTracerouteResults] = FieldInfo(alias="tracerouteResults", default=None)

traceroute_results_by_colo: Optional[List[TestTracerouteResultsByColo]] = FieldInfo(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

__all__ = [
"DigitalExperienceMonitoringTracerouteDetails",
"TargetPolicy",
"TracerouteStats",
"TracerouteStatsAvailabilityPct",
"TracerouteStatsAvailabilityPctSlot",
Expand All @@ -30,6 +31,15 @@
]


class TargetPolicy(BaseModel):
id: str

default: bool
"""Whether the policy is the default for the account"""

name: str


class TracerouteStatsAvailabilityPctSlot(BaseModel):
timestamp: str

Expand Down Expand Up @@ -222,6 +232,10 @@ class DigitalExperienceMonitoringTracerouteDetails(BaseModel):
name: str
"""The name of the Traceroute synthetic application test"""

target_policies: Optional[List[TargetPolicy]] = None

targeted: Optional[bool] = None

traceroute_stats: Optional[TracerouteStats] = FieldInfo(alias="tracerouteStats", default=None)

traceroute_stats_by_colo: Optional[List[TracerouteStatsByColo]] = FieldInfo(
Expand Down