Skip to content

Commit ab2771a

Browse files
committed
Add swagger and improve documentation on models
1 parent 88116cc commit ab2771a

File tree

2 files changed

+1357
-7
lines changed

2 files changed

+1357
-7
lines changed

src/sandbox_api_mcp_server/sandbox/models.py

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,17 @@
22
from pydantic import BaseModel, Field
33

44

5+
USECASE_DESCRIPTION = (
6+
"The name of the use case for the sandbox, possible values are: "
7+
"blank-sandbox,bloom,citations,contact-tracing,cybersecurity,entity-resolution,fincen,"
8+
"fraud-detection,graph-data-science,graph-data-science-blank-sandbox,healthcare-analytics,"
9+
"icij-offshoreleaks,icij-paradise-papers,legis-graph,movies,network-management,"
10+
"openstreetmap,pole,recommendations,twitch,twitter-trolls,wwc2019,yelp,twitter-v2"
11+
)
12+
13+
514
class StartSandboxBody(BaseModel):
6-
usecase: Annotated[str, Field(description="The name of the use case for the sandbox (e.g., 'movies', 'blank').")]
15+
usecase: Annotated[str, Field(description=USECASE_DESCRIPTION)]
716

817

918
class StopSandboxBody(BaseModel):
@@ -14,12 +23,6 @@ class ExtendSandboxBody(BaseModel):
1423
sandbox_hash_key: Annotated[Optional[str], Field(description="Specific sandbox to extend. If None, all user's sandboxes are extended.")] = None
1524

1625

17-
class InviteCollaboratorsBody(BaseModel):
18-
sandbox_hash_key: Annotated[str, Field(description="The unique hash key identifying the sandbox to share.")]
19-
email: Annotated[str, Field(description="Email address of the user to invite.")]
20-
message: Annotated[str, Field(description="A personal message to include in the invitation.")]
21-
22-
2326
class AuraUploadBody(BaseModel):
2427
sandbox_hash_key: Annotated[str, Field(description="The unique hash key identifying the sandbox backup to upload.")]
2528
aura_uri: Annotated[str, Field(description="The Aura instance URI (e.g., neo4j+s://xxxx.databases.neo4j.io).")]

0 commit comments

Comments
 (0)