Update api spec (#444)
* YOYO NEW API SPEC! * I have generated the latest API! --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
26cc03ef01
commit
cf383e2405
File diff suppressed because it is too large
Load Diff
@ -1,109 +0,0 @@
|
|||||||
from typing import Any, Dict, Optional, Union
|
|
||||||
|
|
||||||
import httpx
|
|
||||||
|
|
||||||
from ...client import Client
|
|
||||||
from ...models.error import Error
|
|
||||||
from ...models.metadata import Metadata
|
|
||||||
from ...types import Response
|
|
||||||
|
|
||||||
|
|
||||||
def _get_kwargs(
|
|
||||||
*,
|
|
||||||
client: Client,
|
|
||||||
) -> Dict[str, Any]:
|
|
||||||
url = "{}/_meta/info".format(
|
|
||||||
client.base_url,
|
|
||||||
) # noqa: E501
|
|
||||||
|
|
||||||
headers: Dict[str, Any] = client.get_headers()
|
|
||||||
cookies: Dict[str, Any] = client.get_cookies()
|
|
||||||
|
|
||||||
return {
|
|
||||||
"url": url,
|
|
||||||
"headers": headers,
|
|
||||||
"cookies": cookies,
|
|
||||||
"timeout": client.get_timeout(),
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
def _parse_response(*, response: httpx.Response) -> Optional[Union[Metadata, Error]]:
|
|
||||||
if response.status_code == 200:
|
|
||||||
response_200 = Metadata(**response.json())
|
|
||||||
return response_200
|
|
||||||
if response.status_code == 400:
|
|
||||||
response_4XX = Error(**response.json())
|
|
||||||
return response_4XX
|
|
||||||
if response.status_code == 500:
|
|
||||||
response_5XX = Error(**response.json())
|
|
||||||
return response_5XX
|
|
||||||
return Error(**response.json())
|
|
||||||
|
|
||||||
|
|
||||||
def _build_response(
|
|
||||||
*, response: httpx.Response
|
|
||||||
) -> Response[Optional[Union[Metadata, Error]]]:
|
|
||||||
return Response(
|
|
||||||
status_code=response.status_code,
|
|
||||||
content=response.content,
|
|
||||||
headers=response.headers,
|
|
||||||
parsed=_parse_response(response=response),
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def sync_detailed(
|
|
||||||
*,
|
|
||||||
client: Client,
|
|
||||||
) -> Response[Optional[Union[Metadata, Error]]]:
|
|
||||||
kwargs = _get_kwargs(
|
|
||||||
client=client,
|
|
||||||
)
|
|
||||||
|
|
||||||
response = httpx.get(
|
|
||||||
verify=client.verify_ssl,
|
|
||||||
**kwargs,
|
|
||||||
)
|
|
||||||
|
|
||||||
return _build_response(response=response)
|
|
||||||
|
|
||||||
|
|
||||||
def sync(
|
|
||||||
*,
|
|
||||||
client: Client,
|
|
||||||
) -> Optional[Union[Metadata, Error]]:
|
|
||||||
"""This includes information on any of our other distributed systems it is connected to.
|
|
||||||
|
|
||||||
You must be a Zoo employee to perform this request.""" # noqa: E501
|
|
||||||
|
|
||||||
return sync_detailed(
|
|
||||||
client=client,
|
|
||||||
).parsed
|
|
||||||
|
|
||||||
|
|
||||||
async def asyncio_detailed(
|
|
||||||
*,
|
|
||||||
client: Client,
|
|
||||||
) -> Response[Optional[Union[Metadata, Error]]]:
|
|
||||||
kwargs = _get_kwargs(
|
|
||||||
client=client,
|
|
||||||
)
|
|
||||||
|
|
||||||
async with httpx.AsyncClient(verify=client.verify_ssl) as _client:
|
|
||||||
response = await _client.get(**kwargs)
|
|
||||||
|
|
||||||
return _build_response(response=response)
|
|
||||||
|
|
||||||
|
|
||||||
async def asyncio(
|
|
||||||
*,
|
|
||||||
client: Client,
|
|
||||||
) -> Optional[Union[Metadata, Error]]:
|
|
||||||
"""This includes information on any of our other distributed systems it is connected to.
|
|
||||||
|
|
||||||
You must be a Zoo employee to perform this request.""" # noqa: E501
|
|
||||||
|
|
||||||
return (
|
|
||||||
await asyncio_detailed(
|
|
||||||
client=client,
|
|
||||||
)
|
|
||||||
).parsed
|
|
@ -78,7 +78,7 @@ def sync(
|
|||||||
) -> Optional[Union[ApiToken, Error]]:
|
) -> Optional[Union[ApiToken, Error]]:
|
||||||
"""This endpoint allows us to run API calls from our discord bot on behalf of a user. The user must have a discord account linked to their Zoo Account via oauth2 for this to work.
|
"""This endpoint allows us to run API calls from our discord bot on behalf of a user. The user must have a discord account linked to their Zoo Account via oauth2 for this to work.
|
||||||
|
|
||||||
You must be a Zoo employee to use this endpoint.""" # noqa: E501
|
You must be a Zoo admin to use this endpoint.""" # noqa: E501
|
||||||
|
|
||||||
return sync_detailed(
|
return sync_detailed(
|
||||||
discord_id=discord_id,
|
discord_id=discord_id,
|
||||||
@ -109,7 +109,7 @@ async def asyncio(
|
|||||||
) -> Optional[Union[ApiToken, Error]]:
|
) -> Optional[Union[ApiToken, Error]]:
|
||||||
"""This endpoint allows us to run API calls from our discord bot on behalf of a user. The user must have a discord account linked to their Zoo Account via oauth2 for this to work.
|
"""This endpoint allows us to run API calls from our discord bot on behalf of a user. The user must have a discord account linked to their Zoo Account via oauth2 for this to work.
|
||||||
|
|
||||||
You must be a Zoo employee to use this endpoint.""" # noqa: E501
|
You must be a Zoo admin to use this endpoint.""" # noqa: E501
|
||||||
|
|
||||||
return (
|
return (
|
||||||
await asyncio_detailed(
|
await asyncio_detailed(
|
||||||
|
@ -85,7 +85,7 @@ def sync(
|
|||||||
*,
|
*,
|
||||||
client: Client,
|
client: Client,
|
||||||
) -> Optional[Union[ZooProductSubscriptions, Error]]:
|
) -> Optional[Union[ZooProductSubscriptions, Error]]:
|
||||||
"""You must be a Zoo employee to perform this request.""" # noqa: E501
|
"""You must be a Zoo admin to perform this request.""" # noqa: E501
|
||||||
|
|
||||||
return sync_detailed(
|
return sync_detailed(
|
||||||
id=id,
|
id=id,
|
||||||
@ -118,7 +118,7 @@ async def asyncio(
|
|||||||
*,
|
*,
|
||||||
client: Client,
|
client: Client,
|
||||||
) -> Optional[Union[ZooProductSubscriptions, Error]]:
|
) -> Optional[Union[ZooProductSubscriptions, Error]]:
|
||||||
"""You must be a Zoo employee to perform this request.""" # noqa: E501
|
"""You must be a Zoo admin to perform this request.""" # noqa: E501
|
||||||
|
|
||||||
return (
|
return (
|
||||||
await asyncio_detailed(
|
await asyncio_detailed(
|
||||||
|
@ -79,9 +79,7 @@ def sync(
|
|||||||
) -> Optional[Union[User, Error]]:
|
) -> Optional[Union[User, Error]]:
|
||||||
"""To get information about yourself, use `/users/me` as the endpoint. By doing so you will get the user information for the authenticated user.
|
"""To get information about yourself, use `/users/me` as the endpoint. By doing so you will get the user information for the authenticated user.
|
||||||
|
|
||||||
Alternatively, to get information about the authenticated user, use `/user` endpoint.
|
Alternatively, to get information about the authenticated user, use `/user` endpoint.""" # noqa: E501
|
||||||
|
|
||||||
To get information about any Zoo user, you must be a Zoo employee.""" # noqa: E501
|
|
||||||
|
|
||||||
return sync_detailed(
|
return sync_detailed(
|
||||||
id=id,
|
id=id,
|
||||||
@ -112,9 +110,7 @@ async def asyncio(
|
|||||||
) -> Optional[Union[User, Error]]:
|
) -> Optional[Union[User, Error]]:
|
||||||
"""To get information about yourself, use `/users/me` as the endpoint. By doing so you will get the user information for the authenticated user.
|
"""To get information about yourself, use `/users/me` as the endpoint. By doing so you will get the user information for the authenticated user.
|
||||||
|
|
||||||
Alternatively, to get information about the authenticated user, use `/user` endpoint.
|
Alternatively, to get information about the authenticated user, use `/user` endpoint.""" # noqa: E501
|
||||||
|
|
||||||
To get information about any Zoo user, you must be a Zoo employee.""" # noqa: E501
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
await asyncio_detailed(
|
await asyncio_detailed(
|
||||||
|
@ -81,9 +81,7 @@ def sync(
|
|||||||
) -> Optional[Union[ExtendedUser, Error]]:
|
) -> Optional[Union[ExtendedUser, Error]]:
|
||||||
"""To get information about yourself, use `/users-extended/me` as the endpoint. By doing so you will get the user information for the authenticated user.
|
"""To get information about yourself, use `/users-extended/me` as the endpoint. By doing so you will get the user information for the authenticated user.
|
||||||
|
|
||||||
Alternatively, to get information about the authenticated user, use `/user/extended` endpoint.
|
Alternatively, to get information about the authenticated user, use `/user/extended` endpoint.""" # noqa: E501
|
||||||
|
|
||||||
To get information about any Zoo user, you must be a Zoo employee.""" # noqa: E501
|
|
||||||
|
|
||||||
return sync_detailed(
|
return sync_detailed(
|
||||||
id=id,
|
id=id,
|
||||||
@ -114,9 +112,7 @@ async def asyncio(
|
|||||||
) -> Optional[Union[ExtendedUser, Error]]:
|
) -> Optional[Union[ExtendedUser, Error]]:
|
||||||
"""To get information about yourself, use `/users-extended/me` as the endpoint. By doing so you will get the user information for the authenticated user.
|
"""To get information about yourself, use `/users-extended/me` as the endpoint. By doing so you will get the user information for the authenticated user.
|
||||||
|
|
||||||
Alternatively, to get information about the authenticated user, use `/user/extended` endpoint.
|
Alternatively, to get information about the authenticated user, use `/user/extended` endpoint.""" # noqa: E501
|
||||||
|
|
||||||
To get information about any Zoo user, you must be a Zoo employee.""" # noqa: E501
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
await asyncio_detailed(
|
await asyncio_detailed(
|
||||||
|
@ -48,7 +48,6 @@ from kittycad.api.meta import (
|
|||||||
create_debug_uploads,
|
create_debug_uploads,
|
||||||
create_event,
|
create_event,
|
||||||
get_ipinfo,
|
get_ipinfo,
|
||||||
get_metadata,
|
|
||||||
get_pricing_subscriptions,
|
get_pricing_subscriptions,
|
||||||
get_schema,
|
get_schema,
|
||||||
internal_get_api_token_for_discord_user,
|
internal_get_api_token_for_discord_user,
|
||||||
@ -194,7 +193,6 @@ from kittycad.models import (
|
|||||||
IpAddrInfo,
|
IpAddrInfo,
|
||||||
KclCodeCompletionResponse,
|
KclCodeCompletionResponse,
|
||||||
KclModel,
|
KclModel,
|
||||||
Metadata,
|
|
||||||
MlPrompt,
|
MlPrompt,
|
||||||
MlPromptResultsPage,
|
MlPromptResultsPage,
|
||||||
Onboarding,
|
Onboarding,
|
||||||
@ -351,47 +349,6 @@ async def test_get_schema_async():
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.skip
|
|
||||||
def test_get_metadata():
|
|
||||||
# Create our client.
|
|
||||||
client = ClientFromEnv()
|
|
||||||
|
|
||||||
result: Optional[Union[Metadata, Error]] = get_metadata.sync(
|
|
||||||
client=client,
|
|
||||||
)
|
|
||||||
|
|
||||||
if isinstance(result, Error) or result is None:
|
|
||||||
print(result)
|
|
||||||
raise Exception("Error in response")
|
|
||||||
|
|
||||||
body: Metadata = result
|
|
||||||
print(body)
|
|
||||||
|
|
||||||
# OR if you need more info (e.g. status_code)
|
|
||||||
response: Response[Optional[Union[Metadata, Error]]] = get_metadata.sync_detailed(
|
|
||||||
client=client,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
# OR run async
|
|
||||||
@pytest.mark.asyncio
|
|
||||||
@pytest.mark.skip
|
|
||||||
async def test_get_metadata_async():
|
|
||||||
# Create our client.
|
|
||||||
client = ClientFromEnv()
|
|
||||||
|
|
||||||
result: Optional[Union[Metadata, Error]] = await get_metadata.asyncio(
|
|
||||||
client=client,
|
|
||||||
)
|
|
||||||
|
|
||||||
# OR run async with more info
|
|
||||||
response: Response[
|
|
||||||
Optional[Union[Metadata, Error]]
|
|
||||||
] = await get_metadata.asyncio_detailed(
|
|
||||||
client=client,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.skip
|
@pytest.mark.skip
|
||||||
def test_get_ipinfo():
|
def test_get_ipinfo():
|
||||||
# Create our client.
|
# Create our client.
|
||||||
|
@ -37,7 +37,6 @@ from .block_reason import BlockReason
|
|||||||
from .boolean_intersection import BooleanIntersection
|
from .boolean_intersection import BooleanIntersection
|
||||||
from .boolean_subtract import BooleanSubtract
|
from .boolean_subtract import BooleanSubtract
|
||||||
from .boolean_union import BooleanUnion
|
from .boolean_union import BooleanUnion
|
||||||
from .cache_metadata import CacheMetadata
|
|
||||||
from .camera_drag_end import CameraDragEnd
|
from .camera_drag_end import CameraDragEnd
|
||||||
from .camera_drag_interaction_type import CameraDragInteractionType
|
from .camera_drag_interaction_type import CameraDragInteractionType
|
||||||
from .camera_drag_move import CameraDragMove
|
from .camera_drag_move import CameraDragMove
|
||||||
@ -49,14 +48,12 @@ from .card_details import CardDetails
|
|||||||
from .center_of_mass import CenterOfMass
|
from .center_of_mass import CenterOfMass
|
||||||
from .client_metrics import ClientMetrics
|
from .client_metrics import ClientMetrics
|
||||||
from .close_path import ClosePath
|
from .close_path import ClosePath
|
||||||
from .cluster import Cluster
|
|
||||||
from .code_language import CodeLanguage
|
from .code_language import CodeLanguage
|
||||||
from .code_option import CodeOption
|
from .code_option import CodeOption
|
||||||
from .code_output import CodeOutput
|
from .code_output import CodeOutput
|
||||||
from .color import Color
|
from .color import Color
|
||||||
from .complementary_edges import ComplementaryEdges
|
from .complementary_edges import ComplementaryEdges
|
||||||
from .component_transform import ComponentTransform
|
from .component_transform import ComponentTransform
|
||||||
from .connection import Connection
|
|
||||||
from .country_code import CountryCode
|
from .country_code import CountryCode
|
||||||
from .coupon import Coupon
|
from .coupon import Coupon
|
||||||
from .create_shortlink_request import CreateShortlinkRequest
|
from .create_shortlink_request import CreateShortlinkRequest
|
||||||
@ -122,7 +119,6 @@ from .entity_mirror import EntityMirror
|
|||||||
from .entity_mirror_across_edge import EntityMirrorAcrossEdge
|
from .entity_mirror_across_edge import EntityMirrorAcrossEdge
|
||||||
from .entity_set_opacity import EntitySetOpacity
|
from .entity_set_opacity import EntitySetOpacity
|
||||||
from .entity_type import EntityType
|
from .entity_type import EntityType
|
||||||
from .environment import Environment
|
|
||||||
from .error import Error
|
from .error import Error
|
||||||
from .error_code import ErrorCode
|
from .error_code import ErrorCode
|
||||||
from .event import Event
|
from .event import Event
|
||||||
@ -151,9 +147,7 @@ from .file_export_format import FileExportFormat
|
|||||||
from .file_import_format import FileImportFormat
|
from .file_import_format import FileImportFormat
|
||||||
from .file_mass import FileMass
|
from .file_mass import FileMass
|
||||||
from .file_surface_area import FileSurfaceArea
|
from .file_surface_area import FileSurfaceArea
|
||||||
from .file_system_metadata import FileSystemMetadata
|
|
||||||
from .file_volume import FileVolume
|
from .file_volume import FileVolume
|
||||||
from .gateway import Gateway
|
|
||||||
from .get_entity_type import GetEntityType
|
from .get_entity_type import GetEntityType
|
||||||
from .get_num_objects import GetNumObjects
|
from .get_num_objects import GetNumObjects
|
||||||
from .get_sketch_mode_plane import GetSketchModePlane
|
from .get_sketch_mode_plane import GetSketchModePlane
|
||||||
@ -178,23 +172,16 @@ from .invoice import Invoice
|
|||||||
from .invoice_line_item import InvoiceLineItem
|
from .invoice_line_item import InvoiceLineItem
|
||||||
from .invoice_status import InvoiceStatus
|
from .invoice_status import InvoiceStatus
|
||||||
from .ip_addr_info import IpAddrInfo
|
from .ip_addr_info import IpAddrInfo
|
||||||
from .jetstream import Jetstream
|
|
||||||
from .jetstream_api_stats import JetstreamApiStats
|
|
||||||
from .jetstream_config import JetstreamConfig
|
|
||||||
from .jetstream_stats import JetstreamStats
|
|
||||||
from .kcl_code_completion_params import KclCodeCompletionParams
|
from .kcl_code_completion_params import KclCodeCompletionParams
|
||||||
from .kcl_code_completion_request import KclCodeCompletionRequest
|
from .kcl_code_completion_request import KclCodeCompletionRequest
|
||||||
from .kcl_code_completion_response import KclCodeCompletionResponse
|
from .kcl_code_completion_response import KclCodeCompletionResponse
|
||||||
from .kcl_model import KclModel
|
from .kcl_model import KclModel
|
||||||
from .leaf_node import LeafNode
|
|
||||||
from .length_unit import LengthUnit
|
from .length_unit import LengthUnit
|
||||||
from .loft import Loft
|
from .loft import Loft
|
||||||
from .make_axes_gizmo import MakeAxesGizmo
|
from .make_axes_gizmo import MakeAxesGizmo
|
||||||
from .make_offset_path import MakeOffsetPath
|
from .make_offset_path import MakeOffsetPath
|
||||||
from .make_plane import MakePlane
|
from .make_plane import MakePlane
|
||||||
from .mass import Mass
|
from .mass import Mass
|
||||||
from .meta_cluster_info import MetaClusterInfo
|
|
||||||
from .metadata import Metadata
|
|
||||||
from .method import Method
|
from .method import Method
|
||||||
from .ml_feedback import MlFeedback
|
from .ml_feedback import MlFeedback
|
||||||
from .ml_prompt import MlPrompt
|
from .ml_prompt import MlPrompt
|
||||||
|
@ -1,11 +0,0 @@
|
|||||||
from pydantic import BaseModel, ConfigDict
|
|
||||||
|
|
||||||
|
|
||||||
class CacheMetadata(BaseModel):
|
|
||||||
"""Metadata about our cache.
|
|
||||||
|
|
||||||
This is mostly used for internal purposes and debugging."""
|
|
||||||
|
|
||||||
ok: bool
|
|
||||||
|
|
||||||
model_config = ConfigDict(protected_namespaces=())
|
|
@ -1,21 +0,0 @@
|
|||||||
from typing import List, Optional
|
|
||||||
|
|
||||||
from pydantic import BaseModel, ConfigDict
|
|
||||||
|
|
||||||
|
|
||||||
class Cluster(BaseModel):
|
|
||||||
"""Cluster information."""
|
|
||||||
|
|
||||||
addr: Optional[str] = None
|
|
||||||
|
|
||||||
auth_timeout: int = 0
|
|
||||||
|
|
||||||
cluster_port: int = 0
|
|
||||||
|
|
||||||
name: str = ""
|
|
||||||
|
|
||||||
tls_timeout: int = 0
|
|
||||||
|
|
||||||
urls: List[str] = []
|
|
||||||
|
|
||||||
model_config = ConfigDict(protected_namespaces=())
|
|
@ -1,134 +0,0 @@
|
|||||||
import datetime
|
|
||||||
from typing import Dict
|
|
||||||
|
|
||||||
from pydantic import BaseModel, ConfigDict
|
|
||||||
|
|
||||||
from ..models.cluster import Cluster
|
|
||||||
from ..models.gateway import Gateway
|
|
||||||
from ..models.jetstream import Jetstream
|
|
||||||
from ..models.leaf_node import LeafNode
|
|
||||||
|
|
||||||
|
|
||||||
class Connection(BaseModel):
|
|
||||||
"""Metadata about a pub-sub connection.
|
|
||||||
|
|
||||||
This is mostly used for internal purposes and debugging."""
|
|
||||||
|
|
||||||
auth_timeout: int = 0
|
|
||||||
|
|
||||||
cluster: Cluster = {
|
|
||||||
"addr": None,
|
|
||||||
"auth_timeout": 0,
|
|
||||||
"cluster_port": 0,
|
|
||||||
"name": "",
|
|
||||||
"tls_timeout": 0,
|
|
||||||
"urls": [],
|
|
||||||
} # type: ignore
|
|
||||||
|
|
||||||
config_load_time: datetime.datetime
|
|
||||||
|
|
||||||
connections: int = 0
|
|
||||||
|
|
||||||
cores: int = 0
|
|
||||||
|
|
||||||
cpu: float = 0.0
|
|
||||||
|
|
||||||
gateway: Gateway = {
|
|
||||||
"auth_timeout": 0,
|
|
||||||
"host": "",
|
|
||||||
"name": "",
|
|
||||||
"port": 0,
|
|
||||||
"tls_timeout": 0,
|
|
||||||
} # type: ignore
|
|
||||||
|
|
||||||
git_commit: str = ""
|
|
||||||
|
|
||||||
go: str = ""
|
|
||||||
|
|
||||||
gomaxprocs: int = 0
|
|
||||||
|
|
||||||
host: str
|
|
||||||
|
|
||||||
http_base_path: str = ""
|
|
||||||
|
|
||||||
http_host: str = ""
|
|
||||||
|
|
||||||
http_port: int = 0
|
|
||||||
|
|
||||||
http_req_stats: Dict[str, int]
|
|
||||||
|
|
||||||
https_port: int = 0
|
|
||||||
|
|
||||||
in_bytes: int = 0
|
|
||||||
|
|
||||||
in_msgs: int = 0
|
|
||||||
|
|
||||||
jetstream: Jetstream = {
|
|
||||||
"config": {"domain": "", "max_memory": 0, "max_storage": 0, "store_dir": ""},
|
|
||||||
"meta": {"cluster_size": 0, "leader": "", "name": ""},
|
|
||||||
"stats": {
|
|
||||||
"accounts": 0,
|
|
||||||
"api": {"errors": 0, "inflight": 0, "total": 0},
|
|
||||||
"ha_assets": 0,
|
|
||||||
"memory": 0,
|
|
||||||
"reserved_memory": 0,
|
|
||||||
"reserved_store": 0,
|
|
||||||
"store": 0,
|
|
||||||
},
|
|
||||||
} # type: ignore
|
|
||||||
|
|
||||||
leaf: LeafNode = {"auth_timeout": 0, "host": "", "port": 0, "tls_timeout": 0} # type: ignore
|
|
||||||
|
|
||||||
leafnodes: int = 0
|
|
||||||
|
|
||||||
max_connections: int = 0
|
|
||||||
|
|
||||||
max_control_line: int = 0
|
|
||||||
|
|
||||||
max_payload: int = 0
|
|
||||||
|
|
||||||
max_pending: int = 0
|
|
||||||
|
|
||||||
mem: int = 0
|
|
||||||
|
|
||||||
now: datetime.datetime
|
|
||||||
|
|
||||||
out_bytes: int = 0
|
|
||||||
|
|
||||||
out_msgs: int = 0
|
|
||||||
|
|
||||||
ping_interval: int = 0
|
|
||||||
|
|
||||||
ping_max: int = 0
|
|
||||||
|
|
||||||
port: int = 0
|
|
||||||
|
|
||||||
proto: int = 0
|
|
||||||
|
|
||||||
remotes: int = 0
|
|
||||||
|
|
||||||
routes: int = 0
|
|
||||||
|
|
||||||
server_id: str = ""
|
|
||||||
|
|
||||||
server_name: str = ""
|
|
||||||
|
|
||||||
slow_consumers: int = 0
|
|
||||||
|
|
||||||
start: datetime.datetime
|
|
||||||
|
|
||||||
subscriptions: int = 0
|
|
||||||
|
|
||||||
system_account: str = ""
|
|
||||||
|
|
||||||
tls_timeout: int = 0
|
|
||||||
|
|
||||||
total_connections: int = 0
|
|
||||||
|
|
||||||
uptime: str = ""
|
|
||||||
|
|
||||||
version: str = ""
|
|
||||||
|
|
||||||
write_deadline: int = 0
|
|
||||||
|
|
||||||
model_config = ConfigDict(protected_namespaces=())
|
|
@ -1,15 +0,0 @@
|
|||||||
from enum import Enum
|
|
||||||
|
|
||||||
|
|
||||||
class Environment(str, Enum):
|
|
||||||
"""The environment the server is running in.""" # noqa: E501
|
|
||||||
|
|
||||||
"""# The development environment. This is for running locally. """ # noqa: E501
|
|
||||||
DEVELOPMENT = "DEVELOPMENT"
|
|
||||||
"""# The preview environment. This is deployed to api.dev.zoo.dev. """ # noqa: E501
|
|
||||||
PREVIEW = "PREVIEW"
|
|
||||||
"""# The production environment. """ # noqa: E501
|
|
||||||
PRODUCTION = "PRODUCTION"
|
|
||||||
|
|
||||||
def __str__(self) -> str:
|
|
||||||
return str(self.value)
|
|
@ -1,11 +0,0 @@
|
|||||||
from pydantic import BaseModel, ConfigDict
|
|
||||||
|
|
||||||
|
|
||||||
class FileSystemMetadata(BaseModel):
|
|
||||||
"""Metadata about our file system.
|
|
||||||
|
|
||||||
This is mostly used for internal purposes and debugging."""
|
|
||||||
|
|
||||||
ok: bool
|
|
||||||
|
|
||||||
model_config = ConfigDict(protected_namespaces=())
|
|
@ -1,17 +0,0 @@
|
|||||||
from pydantic import BaseModel, ConfigDict
|
|
||||||
|
|
||||||
|
|
||||||
class Gateway(BaseModel):
|
|
||||||
"""Gateway information."""
|
|
||||||
|
|
||||||
auth_timeout: int = 0
|
|
||||||
|
|
||||||
host: str = ""
|
|
||||||
|
|
||||||
name: str = ""
|
|
||||||
|
|
||||||
port: int = 0
|
|
||||||
|
|
||||||
tls_timeout: int = 0
|
|
||||||
|
|
||||||
model_config = ConfigDict(protected_namespaces=())
|
|
@ -1,30 +0,0 @@
|
|||||||
from pydantic import BaseModel, ConfigDict
|
|
||||||
|
|
||||||
from ..models.jetstream_config import JetstreamConfig
|
|
||||||
from ..models.jetstream_stats import JetstreamStats
|
|
||||||
from ..models.meta_cluster_info import MetaClusterInfo
|
|
||||||
|
|
||||||
|
|
||||||
class Jetstream(BaseModel):
|
|
||||||
"""Jetstream information."""
|
|
||||||
|
|
||||||
config: JetstreamConfig = {
|
|
||||||
"domain": "",
|
|
||||||
"max_memory": 0,
|
|
||||||
"max_storage": 0,
|
|
||||||
"store_dir": "",
|
|
||||||
} # type: ignore
|
|
||||||
|
|
||||||
meta: MetaClusterInfo = {"cluster_size": 0, "leader": "", "name": ""} # type: ignore
|
|
||||||
|
|
||||||
stats: JetstreamStats = {
|
|
||||||
"accounts": 0,
|
|
||||||
"api": {"errors": 0, "inflight": 0, "total": 0},
|
|
||||||
"ha_assets": 0,
|
|
||||||
"memory": 0,
|
|
||||||
"reserved_memory": 0,
|
|
||||||
"reserved_store": 0,
|
|
||||||
"store": 0,
|
|
||||||
} # type: ignore
|
|
||||||
|
|
||||||
model_config = ConfigDict(protected_namespaces=())
|
|
@ -1,13 +0,0 @@
|
|||||||
from pydantic import BaseModel, ConfigDict
|
|
||||||
|
|
||||||
|
|
||||||
class JetstreamApiStats(BaseModel):
|
|
||||||
"""Jetstream API statistics."""
|
|
||||||
|
|
||||||
errors: int = 0
|
|
||||||
|
|
||||||
inflight: int = 0
|
|
||||||
|
|
||||||
total: int = 0
|
|
||||||
|
|
||||||
model_config = ConfigDict(protected_namespaces=())
|
|
@ -1,15 +0,0 @@
|
|||||||
from pydantic import BaseModel, ConfigDict
|
|
||||||
|
|
||||||
|
|
||||||
class JetstreamConfig(BaseModel):
|
|
||||||
"""Jetstream configuration."""
|
|
||||||
|
|
||||||
domain: str = ""
|
|
||||||
|
|
||||||
max_memory: int = 0
|
|
||||||
|
|
||||||
max_storage: int = 0
|
|
||||||
|
|
||||||
store_dir: str = ""
|
|
||||||
|
|
||||||
model_config = ConfigDict(protected_namespaces=())
|
|
@ -1,23 +0,0 @@
|
|||||||
from pydantic import BaseModel, ConfigDict
|
|
||||||
|
|
||||||
from ..models.jetstream_api_stats import JetstreamApiStats
|
|
||||||
|
|
||||||
|
|
||||||
class JetstreamStats(BaseModel):
|
|
||||||
"""Jetstream statistics."""
|
|
||||||
|
|
||||||
accounts: int = 0
|
|
||||||
|
|
||||||
api: JetstreamApiStats = {"errors": 0, "inflight": 0, "total": 0} # type: ignore
|
|
||||||
|
|
||||||
ha_assets: int = 0
|
|
||||||
|
|
||||||
memory: int = 0
|
|
||||||
|
|
||||||
reserved_memory: int = 0
|
|
||||||
|
|
||||||
reserved_store: int = 0
|
|
||||||
|
|
||||||
store: int = 0
|
|
||||||
|
|
||||||
model_config = ConfigDict(protected_namespaces=())
|
|
@ -1,15 +0,0 @@
|
|||||||
from pydantic import BaseModel, ConfigDict
|
|
||||||
|
|
||||||
|
|
||||||
class LeafNode(BaseModel):
|
|
||||||
"""Leaf node information."""
|
|
||||||
|
|
||||||
auth_timeout: int = 0
|
|
||||||
|
|
||||||
host: str = ""
|
|
||||||
|
|
||||||
port: int = 0
|
|
||||||
|
|
||||||
tls_timeout: int = 0
|
|
||||||
|
|
||||||
model_config = ConfigDict(protected_namespaces=())
|
|
@ -1,13 +0,0 @@
|
|||||||
from pydantic import BaseModel, ConfigDict
|
|
||||||
|
|
||||||
|
|
||||||
class MetaClusterInfo(BaseModel):
|
|
||||||
"""Jetstream statistics."""
|
|
||||||
|
|
||||||
cluster_size: int = 0
|
|
||||||
|
|
||||||
leader: str = ""
|
|
||||||
|
|
||||||
name: str = ""
|
|
||||||
|
|
||||||
model_config = ConfigDict(protected_namespaces=())
|
|
@ -1,24 +0,0 @@
|
|||||||
from pydantic import BaseModel, ConfigDict
|
|
||||||
|
|
||||||
from ..models.cache_metadata import CacheMetadata
|
|
||||||
from ..models.connection import Connection
|
|
||||||
from ..models.environment import Environment
|
|
||||||
from ..models.file_system_metadata import FileSystemMetadata
|
|
||||||
|
|
||||||
|
|
||||||
class Metadata(BaseModel):
|
|
||||||
"""Metadata about our currently running server.
|
|
||||||
|
|
||||||
This is mostly used for internal purposes and debugging."""
|
|
||||||
|
|
||||||
cache: CacheMetadata
|
|
||||||
|
|
||||||
environment: Environment
|
|
||||||
|
|
||||||
fs: FileSystemMetadata
|
|
||||||
|
|
||||||
git_hash: str
|
|
||||||
|
|
||||||
pubsub: Connection
|
|
||||||
|
|
||||||
model_config = ConfigDict(protected_namespaces=())
|
|
809
spec.json
809
spec.json
@ -85,85 +85,6 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"/_meta/info": {
|
|
||||||
"get": {
|
|
||||||
"tags": [
|
|
||||||
"meta",
|
|
||||||
"hidden"
|
|
||||||
],
|
|
||||||
"summary": "Get the metadata about our currently running server.",
|
|
||||||
"description": "This includes information on any of our other distributed systems it is connected to.\n\nYou must be a Zoo employee to perform this request.",
|
|
||||||
"operationId": "get_metadata",
|
|
||||||
"responses": {
|
|
||||||
"200": {
|
|
||||||
"description": "successful operation",
|
|
||||||
"headers": {
|
|
||||||
"Access-Control-Allow-Credentials": {
|
|
||||||
"description": "Access-Control-Allow-Credentials header.",
|
|
||||||
"style": "simple",
|
|
||||||
"schema": {
|
|
||||||
"nullable": true,
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Access-Control-Allow-Headers": {
|
|
||||||
"description": "Access-Control-Allow-Headers header. This is a comma-separated list of headers.",
|
|
||||||
"style": "simple",
|
|
||||||
"schema": {
|
|
||||||
"nullable": true,
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Access-Control-Allow-Methods": {
|
|
||||||
"description": "Access-Control-Allow-Methods header.",
|
|
||||||
"style": "simple",
|
|
||||||
"schema": {
|
|
||||||
"nullable": true,
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Access-Control-Allow-Origin": {
|
|
||||||
"description": "Access-Control-Allow-Origin header.",
|
|
||||||
"style": "simple",
|
|
||||||
"schema": {
|
|
||||||
"nullable": true,
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Set-Cookie": {
|
|
||||||
"description": "Set-Cookie header.",
|
|
||||||
"style": "simple",
|
|
||||||
"schema": {
|
|
||||||
"nullable": true,
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"X-Api-Call-Id": {
|
|
||||||
"description": "ID for this request. We return it so that users can report this to us and help us debug their problems.",
|
|
||||||
"style": "simple",
|
|
||||||
"required": true,
|
|
||||||
"schema": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/Metadata"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"4XX": {
|
|
||||||
"$ref": "#/components/responses/Error"
|
|
||||||
},
|
|
||||||
"5XX": {
|
|
||||||
"$ref": "#/components/responses/Error"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"/_meta/ipinfo": {
|
"/_meta/ipinfo": {
|
||||||
"get": {
|
"get": {
|
||||||
"tags": [
|
"tags": [
|
||||||
@ -3487,7 +3408,7 @@
|
|||||||
"hidden"
|
"hidden"
|
||||||
],
|
],
|
||||||
"summary": "Get an API token for a user by their discord id.",
|
"summary": "Get an API token for a user by their discord id.",
|
||||||
"description": "This endpoint allows us to run API calls from our discord bot on behalf of a user. The user must have a discord account linked to their Zoo Account via oauth2 for this to work.\n\nYou must be a Zoo employee to use this endpoint.",
|
"description": "This endpoint allows us to run API calls from our discord bot on behalf of a user. The user must have a discord account linked to their Zoo Account via oauth2 for this to work.\n\nYou must be a Zoo admin to use this endpoint.",
|
||||||
"operationId": "internal_get_api_token_for_discord_user",
|
"operationId": "internal_get_api_token_for_discord_user",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
@ -9487,7 +9408,7 @@
|
|||||||
"hidden"
|
"hidden"
|
||||||
],
|
],
|
||||||
"summary": "Set the enterprise price for an organization.",
|
"summary": "Set the enterprise price for an organization.",
|
||||||
"description": "You must be a Zoo employee to perform this request.",
|
"description": "You must be a Zoo admin to perform this request.",
|
||||||
"operationId": "update_enterprise_pricing_for_org",
|
"operationId": "update_enterprise_pricing_for_org",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
@ -16181,7 +16102,7 @@
|
|||||||
"hidden"
|
"hidden"
|
||||||
],
|
],
|
||||||
"summary": "Get extended information about a user.",
|
"summary": "Get extended information about a user.",
|
||||||
"description": "To get information about yourself, use `/users-extended/me` as the endpoint. By doing so you will get the user information for the authenticated user.\n\nAlternatively, to get information about the authenticated user, use `/user/extended` endpoint.\n\nTo get information about any Zoo user, you must be a Zoo employee.",
|
"description": "To get information about yourself, use `/users-extended/me` as the endpoint. By doing so you will get the user information for the authenticated user.\n\nAlternatively, to get information about the authenticated user, use `/user/extended` endpoint.",
|
||||||
"operationId": "get_user_extended",
|
"operationId": "get_user_extended",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
@ -16271,7 +16192,7 @@
|
|||||||
"hidden"
|
"hidden"
|
||||||
],
|
],
|
||||||
"summary": "Get a user.",
|
"summary": "Get a user.",
|
||||||
"description": "To get information about yourself, use `/users/me` as the endpoint. By doing so you will get the user information for the authenticated user.\n\nAlternatively, to get information about the authenticated user, use `/user` endpoint.\n\nTo get information about any Zoo user, you must be a Zoo employee.",
|
"description": "To get information about yourself, use `/users/me` as the endpoint. By doing so you will get the user information for the authenticated user.\n\nAlternatively, to get information about the authenticated user, use `/user` endpoint.",
|
||||||
"operationId": "get_user",
|
"operationId": "get_user",
|
||||||
"parameters": [
|
"parameters": [
|
||||||
{
|
{
|
||||||
@ -19381,19 +19302,6 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"CacheMetadata": {
|
|
||||||
"description": "Metadata about our cache.\n\nThis is mostly used for internal purposes and debugging.",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"ok": {
|
|
||||||
"description": "If the cache returned an ok response from ping.",
|
|
||||||
"type": "boolean"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"required": [
|
|
||||||
"ok"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"CameraDragEnd": {
|
"CameraDragEnd": {
|
||||||
"description": "The response from the `CameraDragEnd` command.",
|
"description": "The response from the `CameraDragEnd` command.",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -19781,48 +19689,6 @@
|
|||||||
"face_id"
|
"face_id"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"Cluster": {
|
|
||||||
"description": "Cluster information.",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"addr": {
|
|
||||||
"nullable": true,
|
|
||||||
"description": "The IP address of the cluster.",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"auth_timeout": {
|
|
||||||
"description": "The auth timeout of the cluster.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"cluster_port": {
|
|
||||||
"description": "The port of the cluster.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"name": {
|
|
||||||
"description": "The name of the cluster.",
|
|
||||||
"default": "",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"tls_timeout": {
|
|
||||||
"description": "The TLS timeout for the cluster.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"urls": {
|
|
||||||
"description": "The urls of the cluster.",
|
|
||||||
"default": [],
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"CodeLanguage": {
|
"CodeLanguage": {
|
||||||
"description": "The language code is written in.\n\n<details><summary>JSON schema</summary>\n\n```json { \"description\": \"The language code is written in.\", \"oneOf\": [ { \"description\": \"The `go` programming language.\", \"type\": \"string\", \"enum\": [ \"go\" ] }, { \"description\": \"The `python` programming language.\", \"type\": \"string\", \"enum\": [ \"python\" ] }, { \"description\": \"The `node` programming language.\", \"type\": \"string\", \"enum\": [ \"node\" ] } ] } ``` </details>",
|
"description": "The language code is written in.\n\n<details><summary>JSON schema</summary>\n\n```json { \"description\": \"The language code is written in.\", \"oneOf\": [ { \"description\": \"The `go` programming language.\", \"type\": \"string\", \"enum\": [ \"go\" ] }, { \"description\": \"The `python` programming language.\", \"type\": \"string\", \"enum\": [ \"python\" ] }, { \"description\": \"The `node` programming language.\", \"type\": \"string\", \"enum\": [ \"node\" ] } ] } ``` </details>",
|
||||||
"oneOf": [
|
"oneOf": [
|
||||||
@ -19979,339 +19845,6 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"Connection": {
|
|
||||||
"description": "Metadata about a pub-sub connection.\n\nThis is mostly used for internal purposes and debugging.",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"auth_timeout": {
|
|
||||||
"description": "The auth timeout of the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"cluster": {
|
|
||||||
"description": "Information about the cluster.",
|
|
||||||
"default": {
|
|
||||||
"addr": null,
|
|
||||||
"auth_timeout": 0,
|
|
||||||
"cluster_port": 0,
|
|
||||||
"name": "",
|
|
||||||
"tls_timeout": 0,
|
|
||||||
"urls": []
|
|
||||||
},
|
|
||||||
"allOf": [
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/Cluster"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"config_load_time": {
|
|
||||||
"description": "The time the configuration was loaded.",
|
|
||||||
"type": "string",
|
|
||||||
"format": "date-time"
|
|
||||||
},
|
|
||||||
"connections": {
|
|
||||||
"description": "The number of connections to the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"cores": {
|
|
||||||
"description": "The CPU core usage of the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"cpu": {
|
|
||||||
"description": "The CPU usage of the server.",
|
|
||||||
"default": 0.0,
|
|
||||||
"type": "number",
|
|
||||||
"format": "double"
|
|
||||||
},
|
|
||||||
"gateway": {
|
|
||||||
"description": "Information about the gateway.",
|
|
||||||
"default": {
|
|
||||||
"auth_timeout": 0,
|
|
||||||
"host": "",
|
|
||||||
"name": "",
|
|
||||||
"port": 0,
|
|
||||||
"tls_timeout": 0
|
|
||||||
},
|
|
||||||
"allOf": [
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/Gateway"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"git_commit": {
|
|
||||||
"description": "The git commit.",
|
|
||||||
"default": "",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"go": {
|
|
||||||
"description": "The go version.",
|
|
||||||
"default": "",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"gomaxprocs": {
|
|
||||||
"description": "`GOMAXPROCS` of the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"host": {
|
|
||||||
"description": "The host of the server.",
|
|
||||||
"type": "string",
|
|
||||||
"format": "ip"
|
|
||||||
},
|
|
||||||
"http_base_path": {
|
|
||||||
"description": "The http base path of the server.",
|
|
||||||
"default": "",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"http_host": {
|
|
||||||
"description": "The http host of the server.",
|
|
||||||
"default": "",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"http_port": {
|
|
||||||
"description": "The http port of the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"http_req_stats": {
|
|
||||||
"description": "HTTP request statistics.",
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": {
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"https_port": {
|
|
||||||
"description": "The https port of the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"in_bytes": {
|
|
||||||
"description": "The count of inbound bytes for the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"in_msgs": {
|
|
||||||
"description": "The number of inbound messages for the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"jetstream": {
|
|
||||||
"description": "Jetstream information.",
|
|
||||||
"default": {
|
|
||||||
"config": {
|
|
||||||
"domain": "",
|
|
||||||
"max_memory": 0,
|
|
||||||
"max_storage": 0,
|
|
||||||
"store_dir": ""
|
|
||||||
},
|
|
||||||
"meta": {
|
|
||||||
"cluster_size": 0,
|
|
||||||
"leader": "",
|
|
||||||
"name": ""
|
|
||||||
},
|
|
||||||
"stats": {
|
|
||||||
"accounts": 0,
|
|
||||||
"api": {
|
|
||||||
"errors": 0,
|
|
||||||
"inflight": 0,
|
|
||||||
"total": 0
|
|
||||||
},
|
|
||||||
"ha_assets": 0,
|
|
||||||
"memory": 0,
|
|
||||||
"reserved_memory": 0,
|
|
||||||
"reserved_store": 0,
|
|
||||||
"store": 0
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"allOf": [
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/Jetstream"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"leaf": {
|
|
||||||
"description": "Information about leaf nodes.",
|
|
||||||
"default": {
|
|
||||||
"auth_timeout": 0,
|
|
||||||
"host": "",
|
|
||||||
"port": 0,
|
|
||||||
"tls_timeout": 0
|
|
||||||
},
|
|
||||||
"allOf": [
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/LeafNode"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"leafnodes": {
|
|
||||||
"description": "The number of leaf nodes for the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"max_connections": {
|
|
||||||
"description": "The max connections of the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"max_control_line": {
|
|
||||||
"description": "The max control line of the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"max_payload": {
|
|
||||||
"description": "The max payload of the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"max_pending": {
|
|
||||||
"description": "The max pending of the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"mem": {
|
|
||||||
"description": "The memory usage of the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"now": {
|
|
||||||
"description": "The time now.",
|
|
||||||
"type": "string",
|
|
||||||
"format": "date-time"
|
|
||||||
},
|
|
||||||
"out_bytes": {
|
|
||||||
"description": "The count of outbound bytes for the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"out_msgs": {
|
|
||||||
"description": "The number of outbound messages for the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"ping_interval": {
|
|
||||||
"description": "The ping interval of the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"ping_max": {
|
|
||||||
"description": "The ping max of the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"port": {
|
|
||||||
"description": "The port of the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"proto": {
|
|
||||||
"description": "The protocol version.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"remotes": {
|
|
||||||
"description": "The number of remotes for the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"routes": {
|
|
||||||
"description": "The number of routes for the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"server_id": {
|
|
||||||
"description": "The server ID.",
|
|
||||||
"default": "",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"server_name": {
|
|
||||||
"description": "The server name.",
|
|
||||||
"default": "",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"slow_consumers": {
|
|
||||||
"description": "The number of slow consumers for the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"start": {
|
|
||||||
"description": "When the server was started.",
|
|
||||||
"type": "string",
|
|
||||||
"format": "date-time"
|
|
||||||
},
|
|
||||||
"subscriptions": {
|
|
||||||
"description": "The number of subscriptions for the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"system_account": {
|
|
||||||
"description": "The system account.",
|
|
||||||
"default": "",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"tls_timeout": {
|
|
||||||
"description": "The TLS timeout of the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"total_connections": {
|
|
||||||
"description": "The total number of connections to the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"uptime": {
|
|
||||||
"description": "The uptime of the server.",
|
|
||||||
"default": "",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"version": {
|
|
||||||
"description": "The version of the service.",
|
|
||||||
"default": "",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"write_deadline": {
|
|
||||||
"description": "The write deadline of the server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"required": [
|
|
||||||
"config_load_time",
|
|
||||||
"host",
|
|
||||||
"http_req_stats",
|
|
||||||
"now",
|
|
||||||
"start"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"CountryCode": {
|
"CountryCode": {
|
||||||
"description": "An ISO-3166 alpha-2 country code. Always uppercase.",
|
"description": "An ISO-3166 alpha-2 country code. Always uppercase.",
|
||||||
"type": "string"
|
"type": "string"
|
||||||
@ -21452,32 +20985,6 @@
|
|||||||
"vertex"
|
"vertex"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"Environment": {
|
|
||||||
"description": "The environment the server is running in.",
|
|
||||||
"oneOf": [
|
|
||||||
{
|
|
||||||
"description": "The development environment. This is for running locally.",
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"DEVELOPMENT"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"description": "The preview environment. This is deployed to api.dev.zoo.dev.",
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"PREVIEW"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"description": "The production environment.",
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"PRODUCTION"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"Error": {
|
"Error": {
|
||||||
"description": "Error information from a response.",
|
"description": "Error information from a response.",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -22764,19 +22271,6 @@
|
|||||||
"user_id"
|
"user_id"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"FileSystemMetadata": {
|
|
||||||
"description": "Metadata about our file system.\n\nThis is mostly used for internal purposes and debugging.",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"ok": {
|
|
||||||
"description": "If the file system passed a sanity check.",
|
|
||||||
"type": "boolean"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"required": [
|
|
||||||
"ok"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"FileVolume": {
|
"FileVolume": {
|
||||||
"description": "A file volume result.",
|
"description": "A file volume result.",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -22869,40 +22363,6 @@
|
|||||||
"user_id"
|
"user_id"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"Gateway": {
|
|
||||||
"description": "Gateway information.",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"auth_timeout": {
|
|
||||||
"description": "The auth timeout of the gateway.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"host": {
|
|
||||||
"description": "The host of the gateway.",
|
|
||||||
"default": "",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"name": {
|
|
||||||
"description": "The name of the gateway.",
|
|
||||||
"default": "",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"port": {
|
|
||||||
"description": "The port of the gateway.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"tls_timeout": {
|
|
||||||
"description": "The TLS timeout for the gateway.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"GetEntityType": {
|
"GetEntityType": {
|
||||||
"description": "The response from the `GetEntityType` command.",
|
"description": "The response from the `GetEntityType` command.",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -23862,167 +23322,6 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"Jetstream": {
|
|
||||||
"description": "Jetstream information.",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"config": {
|
|
||||||
"description": "The Jetstream config.",
|
|
||||||
"default": {
|
|
||||||
"domain": "",
|
|
||||||
"max_memory": 0,
|
|
||||||
"max_storage": 0,
|
|
||||||
"store_dir": ""
|
|
||||||
},
|
|
||||||
"allOf": [
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/JetstreamConfig"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"meta": {
|
|
||||||
"description": "Meta information about the cluster.",
|
|
||||||
"default": {
|
|
||||||
"cluster_size": 0,
|
|
||||||
"leader": "",
|
|
||||||
"name": ""
|
|
||||||
},
|
|
||||||
"allOf": [
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/MetaClusterInfo"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"stats": {
|
|
||||||
"description": "Jetstream statistics.",
|
|
||||||
"default": {
|
|
||||||
"accounts": 0,
|
|
||||||
"api": {
|
|
||||||
"errors": 0,
|
|
||||||
"inflight": 0,
|
|
||||||
"total": 0
|
|
||||||
},
|
|
||||||
"ha_assets": 0,
|
|
||||||
"memory": 0,
|
|
||||||
"reserved_memory": 0,
|
|
||||||
"reserved_store": 0,
|
|
||||||
"store": 0
|
|
||||||
},
|
|
||||||
"allOf": [
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/JetstreamStats"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"JetstreamApiStats": {
|
|
||||||
"description": "Jetstream API statistics.",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"errors": {
|
|
||||||
"description": "The number of errors.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"inflight": {
|
|
||||||
"description": "The number of inflight requests.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"total": {
|
|
||||||
"description": "The number of requests.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"JetstreamConfig": {
|
|
||||||
"description": "Jetstream configuration.",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"domain": {
|
|
||||||
"description": "The domain.",
|
|
||||||
"default": "",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"max_memory": {
|
|
||||||
"description": "The max memory.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"max_storage": {
|
|
||||||
"description": "The max storage.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"store_dir": {
|
|
||||||
"description": "The store directory.",
|
|
||||||
"default": "",
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"JetstreamStats": {
|
|
||||||
"description": "Jetstream statistics.",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"accounts": {
|
|
||||||
"description": "The number of accounts.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"api": {
|
|
||||||
"description": "API stats.",
|
|
||||||
"default": {
|
|
||||||
"errors": 0,
|
|
||||||
"inflight": 0,
|
|
||||||
"total": 0
|
|
||||||
},
|
|
||||||
"allOf": [
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/JetstreamApiStats"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"ha_assets": {
|
|
||||||
"description": "The number of HA assets.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"memory": {
|
|
||||||
"description": "The memory used by the Jetstream server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"reserved_memory": {
|
|
||||||
"description": "The reserved memory for the Jetstream server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"reserved_store": {
|
|
||||||
"description": "The reserved storage for the Jetstream server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"store": {
|
|
||||||
"description": "The storage used by the Jetstream server.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"KclCodeCompletionParams": {
|
"KclCodeCompletionParams": {
|
||||||
"description": "Extra params for the completions.",
|
"description": "Extra params for the completions.",
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@ -24160,35 +23459,6 @@
|
|||||||
"code"
|
"code"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"LeafNode": {
|
|
||||||
"description": "Leaf node information.",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"auth_timeout": {
|
|
||||||
"description": "The auth timeout of the leaf node.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"host": {
|
|
||||||
"description": "The host of the leaf node.",
|
|
||||||
"default": "",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"port": {
|
|
||||||
"description": "The port of the leaf node.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"tls_timeout": {
|
|
||||||
"description": "The TLS timeout for the leaf node.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"LengthUnit": {
|
"LengthUnit": {
|
||||||
"type": "number",
|
"type": "number",
|
||||||
"format": "double"
|
"format": "double"
|
||||||
@ -24255,77 +23525,6 @@
|
|||||||
"output_unit"
|
"output_unit"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"MetaClusterInfo": {
|
|
||||||
"description": "Jetstream statistics.",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"cluster_size": {
|
|
||||||
"description": "The size of the cluster.",
|
|
||||||
"default": 0,
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int64"
|
|
||||||
},
|
|
||||||
"leader": {
|
|
||||||
"description": "The leader of the cluster.",
|
|
||||||
"default": "",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"name": {
|
|
||||||
"description": "The name of the cluster.",
|
|
||||||
"default": "",
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"Metadata": {
|
|
||||||
"description": "Metadata about our currently running server.\n\nThis is mostly used for internal purposes and debugging.",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"cache": {
|
|
||||||
"description": "Metadata about our cache.",
|
|
||||||
"allOf": [
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/CacheMetadata"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"environment": {
|
|
||||||
"description": "The environment we are running in.",
|
|
||||||
"allOf": [
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/Environment"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"fs": {
|
|
||||||
"description": "Metadata about our file system.",
|
|
||||||
"allOf": [
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/FileSystemMetadata"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"git_hash": {
|
|
||||||
"description": "The git hash of the server.",
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"pubsub": {
|
|
||||||
"description": "Metadata about our pub-sub connection.",
|
|
||||||
"allOf": [
|
|
||||||
{
|
|
||||||
"$ref": "#/components/schemas/Connection"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"required": [
|
|
||||||
"cache",
|
|
||||||
"environment",
|
|
||||||
"fs",
|
|
||||||
"git_hash",
|
|
||||||
"pubsub"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"Method": {
|
"Method": {
|
||||||
"description": "The Request Method (VERB)\n\nThis type also contains constants for a number of common HTTP methods such as GET, POST, etc.\n\nCurrently includes 8 variants representing the 8 methods defined in [RFC 7230](https://tools.ietf.org/html/rfc7231#section-4.1), plus PATCH, and an Extension variant for all extensions.",
|
"description": "The Request Method (VERB)\n\nThis type also contains constants for a number of common HTTP methods such as GET, POST, etc.\n\nCurrently includes 8 variants representing the 8 methods defined in [RFC 7230](https://tools.ietf.org/html/rfc7231#section-4.1), plus PATCH, and an Extension variant for all extensions.",
|
||||||
"oneOf": [
|
"oneOf": [
|
||||||
|
Reference in New Issue
Block a user