diff --git a/contract/shapes.json b/contract/shapes.json index f76cdc46..7f939389 100644 --- a/contract/shapes.json +++ b/contract/shapes.json @@ -1,6 +1,6 @@ { "source": "https://www.onlyworlds.com/api/v2/openapi.json: components.schemas, the routes' JSON bodies and their query parameters, reduced to the targets the API pages' shape markers name", - "read_at": "2026-11-12", + "read_at": "2026-11-16", "schemas": ["Error","Ability","AbilityWrite","AbilityPatch","AbilityList","Collective","CollectiveWrite","CollectivePatch","CollectiveList","Character","CharacterWrite","CharacterPatch","CharacterList","Construct","ConstructWrite","ConstructPatch","ConstructList","Creature","CreatureWrite","CreaturePatch","CreatureList","Event","EventWrite","EventPatch","EventList","Family","FamilyWrite","FamilyPatch","FamilyList","Institution","InstitutionWrite","InstitutionPatch","InstitutionList","Language","LanguageWrite","LanguagePatch","LanguageList","Law","LawWrite","LawPatch","LawList","Location","LocationWrite","LocationPatch","LocationList","Map","MapWrite","MapPatch","MapList","Marker","MarkerWrite","MarkerPatch","MarkerList","Narrative","NarrativeWrite","NarrativePatch","NarrativeList","Object","ObjectWrite","ObjectPatch","ObjectList","Phenomenon","PhenomenonWrite","PhenomenonPatch","PhenomenonList","Pin","PinWrite","PinPatch","PinList","Relation","RelationWrite","RelationPatch","RelationList","Species","SpeciesWrite","SpeciesPatch","SpeciesList","Title","TitleWrite","TitlePatch","TitleList","Trait","TraitWrite","TraitPatch","TraitList","Zone","ZoneWrite","ZonePatch","ZoneList","ElementStub","LinkOperation","SearchResults","Draught","ChangesPage","World","WorldPatch","BulkResult","SeatMade","SeatWorld","SeatCreated","SeatRow","SeatList","AccountInvite","AccountMember","AccountMembers","AccountWorldKey","AccountWorldCreated","AccountWorldRow","MemberLenses","Proposal","Proposed","ProposalList"], "elements": {"ability":"Ability","character":"Character","collective":"Collective","construct":"Construct","creature":"Creature","event":"Event","family":"Family","institution":"Institution","language":"Language","law":"Law","location":"Location","map":"Map","marker":"Marker","narrative":"Narrative","object":"Object","phenomenon":"Phenomenon","pin":"Pin","relation":"Relation","species":"Species","title":"Title","trait":"Trait","zone":"Zone"}, "partial_list_params": {"actor":["relation"],"antagonist":["narrative"],"anti_trait":["trait"],"author":["law"],"birthplace":["character"],"body":["title"],"characters":["collective","construct","event","narrative","relation","title"],"classification":["language"],"conservator":["narrative"],"custodian":["construct"],"element":["pin"],"founder":["construct"],"governing_title":["location"],"issuer":["title"],"language":["object"],"location":["character","creature","map","object"],"locus":["ability"],"map":["marker","pin"],"narrator":["narrative"],"operator":["collective"],"parent_institution":["institution"],"parent_law":["law"],"parent_location":["location"],"parent_map":["map"],"parent_narrative":["narrative"],"parent_object":["object"],"parent_species":["species"],"partner":["location"],"primary_power":["location"],"protagonist":["narrative"],"rival":["location"],"source":["ability"],"superior_title":["title"],"system":["phenomenon"],"tradition":["ability"],"vehicle":["location"],"zone":["creature","location","marker"]}, @@ -31,13 +31,13 @@ "PATCH /api/v2/character/{id} 412": {"props":{"error":{"props":{"type":{},"code":{},"message":{},"param":{},"doc_url":{},"refusals":{"items":{"props":{"word":{},"stop_reason":{},"output_tokens":{}},"required":["word","stop_reason","output_tokens"]}},"reason":{}},"required":["type","code","message","param","doc_url"]},"current":{"$":"Character"}},"required":["error","current"]}, "PATCH /api/v2/world request": {"$":"WorldPatch"}, "POST /api/v2/account/worlds/{world_id}/seats request": {"props":{"name":{},"role":{},"character":{}},"required":["name"]}, - "POST /api/v2/auth/token": {"title":"SigninToken","props":{"token":{},"token_id":{},"token_type":{"const":"bearer"},"expires_at":{},"account":{"props":{"id":{},"username":{}},"required":["id","username"]},"ai_token":{"props":{"token":{},"token_id":{},"token_type":{"const":"bearer"},"audience":{"const":"ai"},"ai_uses":{"items":{}},"expires_at":{}},"required":["token","token_id","token_type","audience","ai_uses","expires_at"]}},"required":["token","token_id","token_type","expires_at","account"]}, + "POST /api/v2/auth/token": {"title":"SigninToken","props":{"token":{},"token_id":{},"token_type":{"const":"bearer"},"scope":{"const":"world:read"},"expires_at":{},"account":{"props":{"id":{},"username":{}},"required":["id","username"]},"ai_token":{"props":{"token":{},"token_id":{},"token_type":{"const":"bearer"},"audience":{"const":"ai"},"ai_uses":{"items":{}},"expires_at":{}},"required":["token","token_id","token_type","audience","ai_uses","expires_at"]}},"required":["token","token_id","token_type","expires_at","account"]}, "POST /api/v2/auth/token request": {"props":{"grant_type":{"const":"authorization_code"},"code":{},"code_verifier":{},"client_id":{},"redirect_uri":{},"ai_uses":{"items":{}},"ai_lifetime_minutes":{}},"required":["grant_type","code","code_verifier","client_id","redirect_uri"]}, "POST /api/v2/bulk": {"$":"BulkResult"}, "POST /api/v2/bulk request": {"props":{"items":{"items":{"props":{"type":{},"element":{"unsaid":true}},"required":["type","element"]}},"atomic":{}},"required":["items"]}, "POST /api/v2/character/{id}/files": {"props":{"ticket":{},"upload_url":{},"prefix":{},"key":{},"max_bytes":{},"exp":{},"uses":{"const":1},"issued_to":{"props":{"account":{},"membership":{}},"required":["account","membership"]},"kind":{"const":"file"},"file_id":{}},"required":["ticket","upload_url","prefix","key","max_bytes","exp","uses","issued_to","kind","file_id"]}, "POST /api/v2/character/{id}/files request": {"props":{"name":{},"kind":{},"size":{},"label":{}},"required":["name","kind","size"]}, - "POST /api/v2/join": {"oneOf":[{"title":"AgentJoined","props":{"kind":{"const":"agent"},"world":{"props":{"id":{},"name":{},"description":{}},"required":["id","name","description"]},"seat":{"props":{"id":{},"role":{},"agent_name":{}},"required":["id","role","agent_name"]},"with_character":{},"character":{"props":{"id":{},"name":{}},"required":["id","name"]},"key":{},"pin":{},"base_url":{},"env":{},"next":{"items":{}},"members":{"items":{"props":{"id":{},"kind":{},"role":{},"character":{},"status":{},"name":{},"lenses":{"items":{}},"lenses_from":{},"sponsor_member":{},"x_served_trimmed":{"items":{"const":"lenses"}}},"required":["id","kind","role","character","status","lenses","lenses_from"]}},"front_door":{"props":{"sponsor":{"props":{"id":{},"kind":{},"name":{}},"required":["id","kind","name"]},"sponsor_character":{},"my_character":{},"my_seats":{"items":{"props":{"id":{},"kind":{},"name":{},"character":{}},"required":["id","kind","name","character"]}},"charter":{},"charter_skill":{"items":{}}},"required":["sponsor","sponsor_character","my_character","my_seats","charter","charter_skill"]},"reading_aids":{"props":{"charter":{"props":{"id":{},"name":{},"rules":{"items":{}},"skill":{"items":{}}},"required":["id","name","rules","skill"]},"guide":{"props":{"id":{},"name":{}},"required":["id","name"]},"domains":{"items":{"props":{"id":{},"name":{},"sentence":{},"hubs":{"items":{"props":{"type":{},"id":{}},"required":["type","id"]}}},"required":["id","name","sentence","hubs"]}},"strand":{"props":{"narrative":{"props":{"id":{},"name":{}},"required":["id","name"]},"event":{"props":{"id":{},"name":{}},"required":["id","name"]},"location":{"props":{"id":{},"name":{}},"required":["id","name"]},"character":{"props":{"id":{},"name":{}},"required":["id","name"]},"now":{"props":{"id":{},"name":{}},"required":["id","name"]},"same":{}},"required":["narrative","event","location","character","now","same"]}},"required":["charter","guide","domains","strand"]}},"required":["kind","world","seat","with_character","character","key","pin","base_url","env","next","members","front_door","reading_aids"]},{"title":"PlayerJoined","props":{"kind":{"const":"player"},"key":{},"world":{"props":{"id":{},"name":{},"description":{}},"required":["id","name","description"]},"character":{"props":{"id":{},"name":{}},"required":["id","name"]},"role":{"const":"guest"}},"required":["kind","key","world","character","role"]}]}, + "POST /api/v2/join": {"oneOf":[{"title":"AgentJoined","props":{"kind":{"const":"agent"},"world":{"props":{"id":{},"name":{},"description":{}},"required":["id","name","description"]},"seat":{"props":{"id":{},"agent_name":{},"role":{}},"required":["id","role","agent_name"]},"with_character":{},"character":{"props":{"id":{},"name":{}},"required":["id","name"]},"key":{},"pin":{},"base_url":{},"env":{},"next":{"items":{}},"members":{"items":{"props":{"id":{},"kind":{},"role":{},"character":{},"status":{},"name":{},"lenses":{"items":{}},"lenses_from":{},"sponsor_member":{},"x_served_trimmed":{"items":{"const":"lenses"}}},"required":["id","kind","role","character","status","lenses","lenses_from"]}},"front_door":{"props":{"sponsor":{"props":{"id":{},"kind":{},"name":{}},"required":["id","kind","name"]},"sponsor_character":{},"my_character":{},"my_seats":{"items":{"props":{"id":{},"kind":{},"name":{},"character":{}},"required":["id","kind","name","character"]}},"charter":{},"charter_skill":{"items":{}}},"required":["sponsor","sponsor_character","my_character","my_seats","charter","charter_skill"]},"reading_aids":{"props":{"charter":{"props":{"id":{},"name":{},"rules":{"items":{}},"skill":{"items":{}}},"required":["id","name","rules","skill"]},"guide":{"props":{"id":{},"name":{}},"required":["id","name"]},"domains":{"items":{"props":{"id":{},"name":{},"sentence":{},"hubs":{"items":{"props":{"type":{},"id":{}},"required":["type","id"]}}},"required":["id","name","sentence","hubs"]}},"strand":{"props":{"narrative":{"props":{"id":{},"name":{}},"required":["id","name"]},"event":{"props":{"id":{},"name":{}},"required":["id","name"]},"location":{"props":{"id":{},"name":{}},"required":["id","name"]},"character":{"props":{"id":{},"name":{}},"required":["id","name"]},"now":{"props":{"id":{},"name":{}},"required":["id","name"]},"same":{}},"required":["narrative","event","location","character","now","same"]}},"required":["charter","guide","domains","strand"]}},"required":["kind","world","seat","with_character","character","key","pin","base_url","env","next","members","front_door","reading_aids"]},{"title":"PlayerJoined","props":{"kind":{"const":"player"},"key":{},"world":{"props":{"id":{},"name":{},"description":{}},"required":["id","name","description"]},"character":{"props":{"id":{},"name":{}},"required":["id","name"]},"role":{"const":"guest"}},"required":["kind","key","world","character","role"]}]}, "POST /api/v2/join/preview": {"props":{"reader":{},"world":{"props":{"name":{},"description":{}},"required":["name","description"]},"invited_by":{},"owner_character":{},"role":{},"with_character":{},"expires_at":{},"max_uses":{},"uses_left":{},"name_required":{},"characters":{"items":{"props":{"id":{},"name":{},"image_url":{},"taken":{}},"required":["id","name","image_url","taken"]}}},"required":["reader","world","invited_by","owner_character","role","with_character","expires_at"]}, "POST /api/v2/media/ticket": {"props":{"ticket":{},"upload_url":{},"prefix":{},"max_bytes":{},"exp":{},"uses":{"const":1},"issued_to":{"props":{"account":{},"membership":{}},"required":["account","membership"]}},"required":["ticket","upload_url","prefix","max_bytes","exp","uses","issued_to"]} },