{"openapi":"3.1.0","info":{"title":"World Builder","description":"Controls the creation and management of World Builder content and mods. It interfaces with the Unreal Engine editor to customize cooking, packaging, and deployment for both game clients and servers.","version":"0.1.0"},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"},"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"HttpError":{"type":"object","properties":{"statusCode":{"type":"number"},"code":{"type":"string"},"error":{"type":"string"},"message":{"type":"string"}}},"apiError":{"description":"The error object returned by the API when an error occurs","type":"object","properties":{"error":{"description":"HTTP error message","type":"string"},"code":{"description":"Fastify error code","type":"string"},"message":{"description":"User error message","type":"string"},"statusCode":{"description":"HTTP status code","type":"number"}},"required":["error","message","statusCode"]},"httpError":{"description":"HTTP error message","type":"string"},"errorCode":{"description":"Fastify error code","type":"string"},"errorMessage":{"description":"User error message","type":"string"},"errorStatusCode":{"description":"HTTP status code","type":"number"},"statusMessage":{"description":"Provides information about the service status.","type":"string"},"PaginationQueryParamsSchema":{"type":"object","properties":{"limit":{"description":"Number of documents to return per page","type":"number"},"startAfter":{"description":"Unique id of the returned value object that the query should start after","type":"string"},"endBefore":{"description":"Unique id of the returned value object that the query should end before","type":"string"},"orderBy":{"type":"array","items":{"type":"object","properties":{"field":{"description":"Field to order by. Allows nesting with dot notation, e.g. if a field is nested in an object, use 'object.field'","type":"string"},"direction":{"description":"Direction to order by, either 'asc' (Ascending) or 'desc' (Descending)","anyOf":[{"type":"string","enum":["asc"]},{"type":"string","enum":["desc"]}]}},"required":["field","direction"]}},"searchBy":{"type":"object","properties":{"field":{"description":"Field to search by. Allows nesting with dot notation, e.g. if a field is nested in an object, use 'object.field'","type":"string"},"prefix":{"description":"Prefix to search for. NOTE: Prefix searching is case sensitive.","type":"string"}},"required":["field","prefix"]},"filterBy":{"description":"Filter by field and values.","type":"object","additionalProperties":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]}}}},"description":"Query parameters for paginated endpoints"},"getManifestsResponse":{"description":"Response containing the relevant manifests.","type":"object","properties":{"manifests":{"type":"array","items":{"type":"object","properties":{"url":{"description":"Download URL for the manifest file","type":"string"},"cookie":{"description":"Authentication cookie for secure download","type":"string"},"platform":{"description":"Target platform for the manifest (e.g., 'Windows', 'MacOS', 'iOS', 'Linux')","type":"string"},"contentId":{"description":"Unique identifier for the content associated with this manifest","type":"string"},"name":{"description":"Name of the manifest file","type":"string"},"readOrder":{"description":"Order in which the manifest should be read or processed","type":"number"},"sizeBytes":{"description":"Size of the manifest file in bytes","type":"number"},"md5Hash":{"description":"MD5 hash of the manifest file for integrity verification","type":"string"}},"required":["url","cookie","platform","contentId","name","readOrder","sizeBytes","md5Hash"]}}},"required":["manifests"]},"getManifestsQuery":{"description":"Query parameters for requesting manifests","type":"object","properties":{"modId":{"description":"Unique identifier for the mod","type":"string"},"assetsId":{"type":"string"},"assetsVersionId":{"type":"string"},"buildId":{"description":"Unique identifier for the build version of the mod","type":"string"},"platform":{"type":"string"},"configuration":{"type":"string"}}},"organizationHeader":{"description":"Organization header automatically added by the load balancer","type":"object","properties":{"x-m2-organization-id":{"description":"The ID of an organization","type":"string"}},"required":["x-m2-organization-id"]},"organizationId":{"description":"The ID of an organization","type":"string"},"organizationAndProjectHeader":{"description":"Organization and project headers","type":"object","properties":{"x-m2-organization-id":{"description":"The ID of an organization","type":"string"},"x-m2-project-id":{"description":"The ID of a project","type":"string"}},"required":["x-m2-organization-id","x-m2-project-id"]},"projectId":{"description":"The ID of a project","type":"string"},"organizationAndOptionalProjectHeadersSchema":{"description":"Organization and optional project headers","type":"object","properties":{"x-m2-organization-id":{"description":"The ID of an organization","type":"string"},"x-m2-project-id":{"description":"The ID of a project","type":"string"}},"required":["x-m2-organization-id"]},"organizationAndProjectAndLaunchContextHeader":{"description":"Organization, Project and Launch Context headers","type":"object","properties":{"x-m2-organization-id":{"description":"The ID of an organization","type":"string"},"x-m2-project-id":{"description":"The ID of a project","type":"string"},"x-m2-launch-context-id":{"description":"The ID of a launch context","type":"string"}},"required":["x-m2-organization-id","x-m2-project-id","x-m2-launch-context-id"]},"launchContextId":{"description":"The ID of a launch context","type":"string"},"organizationAndProjectAndWorldHeader":{"description":"Organization, Project and World headers","type":"object","properties":{"x-m2-organization-id":{"description":"The ID of an organization","type":"string"},"x-m2-project-id":{"description":"The ID of a project","type":"string"},"x-m2-world-id":{"description":"The ID of a world","type":"string"}},"required":["x-m2-organization-id","x-m2-project-id","x-m2-world-id"]},"organizationAndProjectHeadersOptional":{"description":"Schema allowing optional organization and project headers","type":"object","properties":{"x-m2-organization-id":{"description":"The ID of an organization","type":"string"},"x-m2-project-id":{"description":"The ID of a project","type":"string"}}},"modIdParams":{"description":"Params which specify a mod id to operate on","type":"object","properties":{"modId":{"type":"string"}},"required":["modId"]},"DeleteWorldBuilderContentResponse":{"description":"Empty response indicating successful content deletion","type":"null"},"GetModsResponseSchema":{"description":"The relevant mods associated with the organization.","anyOf":[{"type":"object","properties":{"mods":{"type":"array","items":{"type":"object","properties":{"modId":{"description":"Unique identifier for the mod","type":"string"},"name":{"description":"Name of the mod","type":"string"},"description":{"description":"Description of the mod","type":"string"},"pictureUrl":{"description":"URL of the mod's picture","type":"string"},"liveContentId":{"description":"The live content ID associated with the mod","type":"string"},"projectId":{"$ref":"#/components/schemas/projectId"},"canUserWrite":{"type":"boolean"},"lastUploadTime":{"type":"number"}},"required":["modId","name","description","liveContentId","projectId","canUserWrite","lastUploadTime"]}},"hasMore":{"type":"string"}},"required":["mods"]},{"type":"array","items":{"type":"object","properties":{"modId":{"description":"Unique identifier for the mod","type":"string"},"name":{"description":"Name of the mod","type":"string"},"description":{"description":"Description of the mod","type":"string"},"pictureUrl":{"description":"URL of the mod's picture","type":"string"},"liveContentId":{"description":"The live content ID associated with the mod","type":"string"},"projectId":{"$ref":"#/components/schemas/projectId"},"canUserWrite":{"type":"boolean"},"lastUploadTime":{"type":"number"}},"required":["modId","name","description","liveContentId","projectId","canUserWrite","lastUploadTime"]}}]},"GetProjectModsResponseSchema":{"description":"The relevant mods associated with the project.","type":"object","properties":{"mods":{"type":"object","additionalProperties":{"type":"string"}}},"required":["mods"]},"GetModParamsSchema":{"description":"Params for requesting a mod","type":"object","properties":{"modId":{"type":"string"}},"required":["modId"]},"GetModResponseSchema":{"description":"The response when getting a mod","type":"object","properties":{"mod":{"type":"object","properties":{"modId":{"description":"Unique identifier for the mod","type":"string"},"name":{"description":"Name of the mod","type":"string"},"description":{"description":"Description of the mod","type":"string"},"pictureUrl":{"description":"URL of the mod's picture","type":"string"},"liveContentId":{"description":"The live content ID associated with the mod","type":"string"},"canUserWrite":{"type":"boolean"},"lastUploadTime":{"type":"number"},"modContentCount":{"type":"number"}},"required":["modId","name","description","liveContentId","canUserWrite","lastUploadTime","modContentCount"]},"content":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string"},"description":{"type":"string"},"status":{"anyOf":[{"type":"number","enum":[0]},{"type":"number","enum":[1]}]},"buildId":{"type":"string"},"creatorId":{"type":"string"},"pluginName":{"type":"string"},"maps":{"type":"array","items":{"type":"object","properties":{"name":{"description":"Name of the map","type":"string"},"longPackageName":{"description":"Long package name of the map","type":"string"},"description":{"description":"Description of the map","type":"string"},"pictureUrl":{"description":"URL of the map's picture","type":"string"},"roles":{"type":"array","items":{"description":"Roles associated with the map","type":"string"}}},"required":["name","longPackageName","description","pictureUrl"]}},"files":{"type":"array","items":{"type":"object","properties":{"name":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"platform":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"configuration":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"sizeBytes":{"type":"number"},"md5hash":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"type":{"anyOf":[{"type":"string","enum":["Pak"]},{"type":"string","enum":["Manifest"]},{"type":"string","enum":["LatestOnlyPak"]},{"type":"string","enum":["PakDependency"]}]}},"required":["name","platform","sizeBytes","md5hash","metadata"]}},"patchType":{"anyOf":[{"type":"string","enum":["None"]},{"type":"string","enum":["BasePatch"]},{"type":"string","enum":["Patch"]}]},"createTimeMillis":{"type":"number"}},"required":["documentId","description","status","buildId","creatorId","pluginName","maps","files","createTimeMillis"]}}},"required":["mod","content"]},"GetWorldBuilderContentsResponse":{"description":"List of content IDs available in World Builder, representing unique identifiers for various content items","type":"array","items":{"type":"string"}},"GetWorldBuilderContentResponse":{"description":"Detailed information about a specific World Builder content","allOf":[{"$ref":"#/components/schemas/WorldBuilderContent"},{"type":"object","properties":{"organizationId":{"type":"string"},"projectId":{"type":"string"},"modId":{"type":"string"},"contentVersionCount":{"type":"number"}},"required":["organizationId","projectId"]}]},"GetWorldBuilderContentEmbedRunsResponse":{"description":"List of embedded content runs","type":"array","items":{"type":"object","properties":{"organizationId":{"description":"The ID of an organization","type":"string"},"projectId":{"description":"The ID of a project","type":"string"},"contentId":{"type":"string"},"status":{"type":"object","properties":{"phase":{"anyOf":[{"type":"string","enum":["Queued"]},{"type":"string","enum":["Pending"]},{"type":"string","enum":["Running"]},{"type":"string","enum":["Cancelling"]},{"type":"string","enum":["Completed"]},{"type":"string","enum":["Failed"]}]},"message":{"type":"string"}},"required":["phase"]},"gfnTitleId":{"description":"GFN Title ID of the variant into which we want to embed the content","type":"string"},"createdBy":{"description":"The ID of the user who created the Fast Play build","type":"string"},"buildkiteRunId":{"description":"A unique identifier for the Buildkite run used to embed the content. It is populated when Fast Play moves from the 'queued' to the 'pending' phase.","type":"string"},"buildkiteRunNumber":{"description":"The number of the Buildkite run used to embed the content. It is populated when Fast Play moves from the 'queued' to the 'pending' phase. We use this as a query parameter when cancelling a Buildkite run.","type":"number"},"startTimeMs":{"description":"The time the Fast Play Buildkite run started, in ms. It coincides with the embed run being moved to the 'pending' phase.","type":"number"},"endTimeMs":{"description":"The time the Fast Play Buildkite run ended (successfully or not), in ms. It coincides with the embed run being moved to the 'completed' or 'failed' phase.","type":"number"},"resolvedIds":{"description":"The build ID, and the parent mod ID for the content that is being embedded.","type":"object","properties":{"modId":{"type":"string"},"buildId":{"type":"string"}},"required":["modId","buildId"]},"createdContentIds":{"description":"The ID of the newly created content, and its build ID. Populated if the Buildkite command completes successfully.","type":"object","properties":{"buildId":{"type":"string"},"contentId":{"type":"string"}},"required":["buildId","contentId"]},"id":{"type":"string"}},"required":["organizationId","projectId","contentId","status","gfnTitleId","createdBy","resolvedIds","id"]}},"PostWorldBuilderContentEmbedRunRequest":{"description":"The request body for embedding content","type":"object","properties":{"gfnTitleId":{"description":"The title ID of the variant to use for embedding","type":"string"}},"required":["gfnTitleId"]},"PostWorldBuilderContentEmbedRunParams":{"description":"The ID of the content to embed","type":"object","properties":{"contentId":{"type":"string"}},"required":["contentId"]},"PostWorldBuilderContentEmbedRunResponse":{"description":"The data of the created Fast Play build","type":"object","properties":{"organizationId":{"description":"The ID of an organization","type":"string"},"projectId":{"description":"The ID of a project","type":"string"},"contentId":{"type":"string"},"status":{"type":"object","properties":{"phase":{"anyOf":[{"type":"string","enum":["Queued"]},{"type":"string","enum":["Pending"]},{"type":"string","enum":["Running"]},{"type":"string","enum":["Cancelling"]},{"type":"string","enum":["Completed"]},{"type":"string","enum":["Failed"]}]},"message":{"type":"string"}},"required":["phase"]},"gfnTitleId":{"description":"GFN Title ID of the variant into which we want to embed the content","type":"string"},"createdBy":{"description":"The ID of the user who created the Fast Play build","type":"string"},"buildkiteRunId":{"description":"A unique identifier for the Buildkite run used to embed the content. It is populated when Fast Play moves from the 'queued' to the 'pending' phase.","type":"string"},"buildkiteRunNumber":{"description":"The number of the Buildkite run used to embed the content. It is populated when Fast Play moves from the 'queued' to the 'pending' phase. We use this as a query parameter when cancelling a Buildkite run.","type":"number"},"startTimeMs":{"description":"The time the Fast Play Buildkite run started, in ms. It coincides with the embed run being moved to the 'pending' phase.","type":"number"},"endTimeMs":{"description":"The time the Fast Play Buildkite run ended (successfully or not), in ms. It coincides with the embed run being moved to the 'completed' or 'failed' phase.","type":"number"},"resolvedIds":{"description":"The build ID, and the parent mod ID for the content that is being embedded.","type":"object","properties":{"modId":{"type":"string"},"buildId":{"type":"string"}},"required":["modId","buildId"]},"createdContentIds":{"description":"The ID of the newly created content, and its build ID. Populated if the Buildkite command completes successfully.","type":"object","properties":{"buildId":{"type":"string"},"contentId":{"type":"string"}},"required":["buildId","contentId"]},"id":{"type":"string"}},"required":["organizationId","projectId","contentId","status","gfnTitleId","createdBy","resolvedIds","id"]},"GetModContentsResponseSchema":{"description":"A list of contents for the requested Mod.","type":"object","properties":{"contents":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"status":{"anyOf":[{"type":"number","enum":[0]},{"type":"number","enum":[1]}]},"buildId":{"type":"string"},"creatorId":{"type":"string"},"pluginName":{"type":"string"},"maps":{"type":"array","items":{"type":"object","properties":{"name":{"description":"Name of the map","type":"string"},"longPackageName":{"description":"Long package name of the map","type":"string"},"description":{"description":"Description of the map","type":"string"},"pictureUrl":{"description":"URL of the map's picture","type":"string"},"roles":{"type":"array","items":{"description":"Roles associated with the map","type":"string"}}},"required":["name","longPackageName","description","pictureUrl"]}},"files":{"type":"array","items":{"type":"object","properties":{"name":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"platform":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"configuration":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"sizeBytes":{"type":"number"},"md5hash":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"type":{"anyOf":[{"type":"string","enum":["Pak"]},{"type":"string","enum":["Manifest"]},{"type":"string","enum":["LatestOnlyPak"]},{"type":"string","enum":["PakDependency"]}]}},"required":["name","platform","sizeBytes","md5hash","metadata"]}},"patchType":{"anyOf":[{"type":"string","enum":["None"]},{"type":"string","enum":["BasePatch"]},{"type":"string","enum":["Patch"]}]},"createTimeMillis":{"type":"number"},"contentId":{"type":"string"},"contentNumber":{"type":"number"}},"required":["description","status","buildId","creatorId","pluginName","maps","files","createTimeMillis","contentId"]}},"hasMore":{"type":"string"}},"required":["contents"]},"GetWorldBuilderDeploymentContentParams":{"description":"Parameters for retrieving content from a specific deployment","type":"object","properties":{"deploymentId":{"description":"Unique identifier of the deployment","type":"string"}},"required":["deploymentId"]},"GetWorldBuilderDeploymentContentQuery":{"description":"Query parameters for retrieving specific deployment content","type":"object","properties":{"configuration":{"description":"Configuration identifier for the deployment content","type":"string"},"platform":{"description":"Target platform for the deployment content","type":"string"}},"required":["configuration","platform"]},"GetWorldBuilderDeploymentContentResponse":{"description":"Response containing deployment content information and download details","type":"object","properties":{"files":{"description":"Array of downloadable files for the deployment","type":"array","items":{"type":"object","properties":{"name":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"platform":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"configuration":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"sizeBytes":{"type":"number"},"md5hash":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"type":{"anyOf":[{"type":"string","enum":["Pak"]},{"type":"string","enum":["Manifest"]},{"type":"string","enum":["LatestOnlyPak"]},{"type":"string","enum":["PakDependency"]}]},"downloadOptions":{"type":"string"},"readOrder":{"type":"number"},"downloadUrl":{"type":"string"},"cookie":{"type":"string"},"contentId":{"type":"string"}},"required":["name","platform","sizeBytes","md5hash","metadata"]}},"pluginName":{"description":"Name of the plugin associated with the deployment","type":"string"},"usePatching":{"description":"Indicates if patching should be used for this deployment","type":"boolean"},"modId":{"description":"Optional ID of the mod associated with the deployment","type":"string"},"contentId":{"description":"Identifier for the deployment content","type":"string"}},"required":["files","pluginName","usePatching","contentId"]},"GetWorldBuilderWorldContentQuery":{"description":"The query parameters required for retrieving specific world content","type":"object","properties":{"configuration":{"description":"The specific configuration identifier for the world content","type":"string"},"platform":{"description":"The target platform for the world content (e.g., 'Windows', 'MacOS', 'iOS', 'Linux')","type":"string"}},"required":["configuration","platform"]},"GetWorldBuilderWorldContentResponse":{"description":"The response from the get world content endpoint, containing file information and download details","type":"object","properties":{"files":{"description":"Array of downloadable files associated with the world content","type":"array","items":{"type":"object","properties":{"name":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"platform":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"configuration":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"sizeBytes":{"type":"number"},"md5hash":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"type":{"anyOf":[{"type":"string","enum":["Pak"]},{"type":"string","enum":["Manifest"]},{"type":"string","enum":["LatestOnlyPak"]},{"type":"string","enum":["PakDependency"]}]},"downloadOptions":{"type":"string"},"readOrder":{"type":"number"},"downloadUrl":{"type":"string"},"cookie":{"type":"string"},"contentId":{"type":"string"}},"required":["name","platform","sizeBytes","md5hash","metadata"]}},"pluginName":{"description":"Name of the plugin associated with this world content","type":"string"},"usePatching":{"description":"Indicates whether patching should be used for this content","type":"boolean"},"modId":{"description":"Optional identifier for the mod associated with this world content","type":"string"},"contentId":{"description":"Identifier for the world content","type":"string"}},"required":["files","pluginName","usePatching","contentId"]},"PatchWorldBuilderContentBody":{"description":"Data for updating maps in specific World Builder content, allowing partial updates","type":"object","properties":{"maps":{"type":"array","items":{"type":"object","properties":{"name":{"description":"Name of the map","type":"string"},"longPackageName":{"description":"Long package name of the map","type":"string"},"description":{"description":"Description of the map","type":"string"},"pictureUrl":{"description":"URL of the map's picture","type":"string"},"roles":{"type":"array","items":{"description":"Roles associated with the map","type":"string"}}},"required":["name","longPackageName","description","pictureUrl"]}}},"required":["maps"]},"PatchWorldBuilderContentResponse":{"description":"Updated World Builder content after modification, including organization, project, and mod IDs","$ref":"#/components/schemas/WorldBuilderContent"},"PostWorldBuilderContentsBody":{"description":"Data required to create new World Builder content, excluding system-generated fields. This includes content details such as description, buildId, pluginName, and maps.","type":"object","properties":{"description":{"type":"string"},"buildId":{"type":"string"},"pluginName":{"type":"string"},"maps":{"type":"array","items":{"type":"object","properties":{"name":{"description":"Name of the map","type":"string"},"longPackageName":{"description":"Long package name of the map","type":"string"},"description":{"description":"Description of the map","type":"string"},"pictureUrl":{"description":"URL of the map's picture","type":"string"},"roles":{"type":"array","items":{"description":"Roles associated with the map","type":"string"}}},"required":["name","longPackageName","description","pictureUrl"]}},"patchType":{"anyOf":[{"type":"string","enum":["None"]},{"type":"string","enum":["BasePatch"]},{"type":"string","enum":["Patch"]}]},"files":{"type":"array","items":{"type":"object","properties":{"name":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"platform":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"configuration":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"sizeBytes":{"type":"number"},"md5hash":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"type":{"anyOf":[{"type":"string","enum":["Pak"]},{"type":"string","enum":["Manifest"]},{"type":"string","enum":["LatestOnlyPak"]},{"type":"string","enum":["PakDependency"]}]}},"required":["name","platform","sizeBytes","md5hash","metadata"]}}},"required":["description","buildId","pluginName","maps"]},"PostWorldBuilderContentsResponse":{"description":"Response containing the ID of the newly created content in World Builder","type":"object","properties":{"contentId":{"description":"Unique identifier for the created content, used for future references and operations","type":"string"}},"required":["contentId"]},"PostConfirmUploadsBody":{"description":"Data to confirm completed file uploads in World Builder","anyOf":[{"type":"object","properties":{"modId":{"description":"ID of the mod being uploaded","type":"string"},"assetsId":{"description":"ID of the assets of the template this project being uploaded originates from","type":"string"},"assetsVersionId":{"description":"ID of the version of the assets of the template this project being uploaded originates from","type":"string"}},"required":["modId"]},{"type":"object","properties":{"modName":{"description":"Name of the mod being uploaded","type":"string"},"assetsId":{"description":"ID of the assets of the template this project being uploaded originates from","type":"string"},"assetsVersionId":{"description":"ID of the version of the assets of the template this project being uploaded originates from","type":"string"}},"required":["modName"]}]},"PostConfirmUploadsResponse":{"description":"Response confirming successful upload completion","type":"object","properties":{"modId":{"description":"Unique identifier of the created or updated mod","type":"string"}},"required":["modId"]},"PostRequestUploadsQuery":{"description":"Query parameters for requesting file uploads in World Builder","type":"object","properties":{"resumable":{"description":"Flag to enable resumable uploads for large files","type":"boolean"}}},"PostRequestUploadsBody":{"description":"Request body for initiating file uploads","type":"object","properties":{"files":{"minItems":1,"description":"List of files to be uploaded","type":"array","items":{"type":"object","properties":{"name":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"platform":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"configuration":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"sizeBytes":{"type":"number"},"md5hash":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"type":{"anyOf":[{"type":"string","enum":["Pak"]},{"type":"string","enum":["Manifest"]},{"type":"string","enum":["LatestOnlyPak"]},{"type":"string","enum":["PakDependency"]}]}},"required":["name","platform","sizeBytes","md5hash","metadata"]}}},"required":["files"]},"PostRequestUploadsResponse":{"description":"Response containing signed URLs for file uploads","type":"object","properties":{"uploadFiles":{"type":"array","items":{"type":"object","properties":{"uploadUrl":{"description":"Signed URL for file upload","type":"string"},"fileIdentifier":{"type":"object","properties":{"name":{"description":"Name of the file","type":"string"},"platform":{"description":"Platform the file is for","type":"string"},"configuration":{"description":"Configuration the file is for","type":"string"}},"required":["name","platform"]}},"required":["uploadUrl","fileIdentifier"]}}},"required":["uploadFiles"]},"WorldBuilderContentParams":{"description":"Parameters for World Builder content-related operations, including retrieval, updates, and deletions","type":"object","properties":{"contentId":{"description":"Unique identifier of the World Builder content to operate on, used in various content-related API endpoints","type":"string"}},"required":["contentId"]},"WorldBuilderContent":{"description":"The world builder content data","type":"object","properties":{"documentId":{"type":"string"},"description":{"type":"string"},"status":{"anyOf":[{"type":"number","enum":[0]},{"type":"number","enum":[1]}]},"buildId":{"type":"string"},"creatorId":{"type":"string"},"pluginName":{"type":"string"},"maps":{"type":"array","items":{"type":"object","properties":{"name":{"description":"Name of the map","type":"string"},"longPackageName":{"description":"Long package name of the map","type":"string"},"description":{"description":"Description of the map","type":"string"},"pictureUrl":{"description":"URL of the map's picture","type":"string"},"roles":{"type":"array","items":{"description":"Roles associated with the map","type":"string"}}},"required":["name","longPackageName","description","pictureUrl"]}},"files":{"type":"array","items":{"type":"object","properties":{"name":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"platform":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"configuration":{"pattern":"^(?:(?!\\.\\.).)+$","type":"string"},"sizeBytes":{"type":"number"},"md5hash":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"type":{"anyOf":[{"type":"string","enum":["Pak"]},{"type":"string","enum":["Manifest"]},{"type":"string","enum":["LatestOnlyPak"]},{"type":"string","enum":["PakDependency"]}]}},"required":["name","platform","sizeBytes","md5hash","metadata"]}},"patchType":{"anyOf":[{"type":"string","enum":["None"]},{"type":"string","enum":["BasePatch"]},{"type":"string","enum":["Patch"]}]}},"required":["documentId","description","status","buildId","creatorId","pluginName","maps","files"]},"DeleteWorldBuilderContentEmbedRunParams":{"description":"The ID of the content being embedded and the ID of the Fast Play build to delete","type":"object","properties":{"contentId":{"type":"string"},"contentEmbedRunId":{"type":"string"}},"required":["contentId","contentEmbedRunId"]},"assets":{"description":"Assets upload information","type":"object","properties":{"documentId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"pictureUrl":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["Plugin"]},{"type":"string","enum":["Template"]}]},"tags":{"type":"array","items":{"type":"string"}},"extraMedia":{"type":"array","items":{"$ref":"#/components/schemas/assetsExtraMedia"}}},"required":["documentId","name","description","pictureUrl","type"]},"assetsExtraMedia":{"description":"Assets extra media information","type":"object","properties":{"filename":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["Image"]},{"type":"string","enum":["Video"]}]},"url":{"type":"string"},"order":{"type":"number"}},"required":["filename","type","url","order"]},"GetAssetsListResponseSchema":{"description":"List of assets with detailed information","type":"array","items":{"$ref":"#/components/schemas/AssetResponseDataSchema"}},"GetAssetsResponseSchema":{"description":"Detailed information about a specific asset","$ref":"#/components/schemas/assets"},"AssetResponseDataSchema":{"description":"Detailed asset information including user permissions","type":"object","properties":{"documentId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"pictureUrl":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["Plugin"]},{"type":"string","enum":["Template"]}]},"tags":{"type":"array","items":{"type":"string"}},"extraMedia":{"type":"array","items":{"$ref":"#/components/schemas/assetsExtraMedia"}},"projectId":{"description":"ID of the project associated with the asset","$ref":"#/components/schemas/projectId"},"canUserWrite":{"description":"Indicates if the user has write permissions for this asset","type":"boolean"}},"required":["documentId","name","description","pictureUrl","type","projectId","canUserWrite"]},"PostAssetsBody":{"description":"Data required to create a new asset","type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"type":{"anyOf":[{"type":"string","enum":["Plugin"]},{"type":"string","enum":["Template"]}]},"tags":{"type":"array","items":{"type":"string"}}},"required":["name","description","type"]},"PostAssetsResponseSchema":{"description":"Response containing the ID of the newly created asset","type":"object","properties":{"assetsId":{"description":"Unique identifier of the newly created asset","type":"string"}},"required":["assetsId"]},"AssetsParamsSchema":{"description":"Parameters for asset-related operations","type":"object","properties":{"assetsId":{"description":"Unique identifier of the asset","type":"string"}},"required":["assetsId"]},"PatchAssetsSchema":{"description":"Data for updating an asset's name and description","type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"required":["name","description"]},"PatchAssetsResponseSchema":{"description":"Updated asset information after modification","$ref":"#/components/schemas/assets"},"PatchAssetsExtraMediaRequestSchema":{"description":"Data for updating an asset's extra media","type":"object","properties":{"extraMedia":{"type":"object","properties":{"value":{"type":"string"}},"required":["value"]},"file":{"anyOf":[{"type":"object","properties":{"filename":{"type":"string"},"mimetype":{"type":"string"},"file":{}},"required":["filename","mimetype","file"]},{"type":"array","items":{"type":"object","properties":{"filename":{"type":"string"},"mimetype":{"type":"string"},"file":{}},"required":["filename","mimetype","file"]}}]}},"required":["extraMedia"]},"GetAssetsVersionsResponseSchema":{"description":"List of asset versions with creation timestamps","type":"array","items":{"$ref":"#/components/schemas/assetsVersionWithTime"}},"PostAssetsVersion":{"description":"Data required to create a new asset version","type":"object","properties":{"description":{"type":"string"},"buildId":{"type":"string"},"release":{"description":"Release version information","type":"object","properties":{"name":{"type":"string"},"semanticVersion":{"description":"Semantic versioning following https://semver.org/ specification","type":"string"},"metadata":{"description":"e.g. description, release notes, breaking changes","type":"object","additionalProperties":{"type":"string"}}},"required":["name","semanticVersion","metadata"]},"dependencies":{"type":"array","items":{"type":"object","properties":{"assetsId":{"type":"string"},"versionId":{"type":"string"}},"required":["assetsId","versionId"]}},"contentId":{"type":"string"},"publish":{"$ref":"#/components/schemas/assetsVersionPublishInformation"}},"required":["description","buildId"]},"PostAssetsVersionResponseSchema":{"description":"Response containing the ID of the newly created asset version","type":"object","properties":{"versionId":{"description":"Unique identifier of the newly created asset version","type":"string"}},"required":["versionId"]},"assetsVersion":{"description":"Assets version information","type":"object","properties":{"documentId":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["Pending"]},{"type":"string","enum":["Ready"]}]},"description":{"type":"string"},"buildId":{"type":"string"},"files":{"type":"array","items":{"$ref":"#/components/schemas/assetsVersionFile"}},"release":{"description":"Release version information","type":"object","properties":{"name":{"type":"string"},"semanticVersion":{"description":"Semantic versioning following https://semver.org/ specification","type":"string"},"metadata":{"description":"e.g. description, release notes, breaking changes","type":"object","additionalProperties":{"type":"string"}}},"required":["name","semanticVersion","metadata"]},"dependencies":{"type":"array","items":{"type":"object","properties":{"assetsId":{"type":"string"},"versionId":{"type":"string"}},"required":["assetsId","versionId"]}},"contentId":{"type":"string"},"publish":{"$ref":"#/components/schemas/assetsVersionPublishInformation"}},"required":["documentId","status","description","buildId","files"]},"assetsVersionFile":{"description":"Assets version file information","type":"object","properties":{"name":{"type":"string"},"sizeBytes":{"type":"number"},"md5hash":{"type":"string"}},"required":["name","sizeBytes","md5hash"]},"AssetsVersionParamsSchema":{"description":"Parameters for asset version-related operations","type":"object","properties":{"assetsId":{"description":"Unique identifier of the asset","type":"string"},"versionId":{"description":"Unique identifier of the asset version","type":"string"}},"required":["assetsId","versionId"]},"PatchAssetsVersion":{"description":"Data for updating an asset version","type":"object","properties":{"status":{"anyOf":[{"type":"string","enum":["Pending"]},{"type":"string","enum":["Ready"]}]},"description":{"type":"string"},"release":{"description":"Release version information","type":"object","properties":{"name":{"type":"string"},"semanticVersion":{"description":"Semantic versioning following https://semver.org/ specification","type":"string"},"metadata":{"description":"e.g. description, release notes, breaking changes","type":"object","additionalProperties":{"type":"string"}}},"required":["name","semanticVersion","metadata"]},"dependencies":{"type":"array","items":{"type":"object","properties":{"assetsId":{"type":"string"},"versionId":{"type":"string"}},"required":["assetsId","versionId"]}},"contentId":{"type":"string"},"publish":{"$ref":"#/components/schemas/assetsVersionPublishInformation"}}},"PatchAssetsVersionResponseSchema":{"description":"Updated asset version information after modification","$ref":"#/components/schemas/assetsVersion"},"PostAssetsVersionUpload":{"description":"Data for uploading a new asset version file","$ref":"#/components/schemas/assetsVersionFile"},"PostAssetsVersionUploadResponse":{"description":"Response containing the signed URL for file upload","type":"object","properties":{"uploadUrl":{"description":"Signed URL for uploading the asset version file","type":"string"}},"required":["uploadUrl"]},"GetAssetsVersionDownloadResponse":{"description":"Information required to download all files for an asset version","type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"sizeBytes":{"type":"number"},"md5hash":{"type":"string"},"downloadUrl":{"description":"URL for downloading the asset version file","type":"string"}},"required":["name","sizeBytes","md5hash","downloadUrl"]}}},"required":["files"]},"assetsVersionWithTime":{"description":"Assets version information with creation time","type":"object","properties":{"documentId":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["Pending"]},{"type":"string","enum":["Ready"]}]},"description":{"type":"string"},"buildId":{"type":"string"},"files":{"type":"array","items":{"$ref":"#/components/schemas/assetsVersionFile"}},"release":{"description":"Release version information","type":"object","properties":{"name":{"type":"string"},"semanticVersion":{"description":"Semantic versioning following https://semver.org/ specification","type":"string"},"metadata":{"description":"e.g. description, release notes, breaking changes","type":"object","additionalProperties":{"type":"string"}}},"required":["name","semanticVersion","metadata"]},"dependencies":{"type":"array","items":{"type":"object","properties":{"assetsId":{"type":"string"},"versionId":{"type":"string"}},"required":["assetsId","versionId"]}},"contentId":{"type":"string"},"publish":{"$ref":"#/components/schemas/assetsVersionPublishInformation"},"createTimeMillis":{"type":"number"}},"required":["documentId","status","description","buildId","files","createTimeMillis"]},"assetsVersionPublishInformation":{"description":"Publish information for an assets version","type":"object","properties":{"semanticVersion":{"type":"string"},"metadata":{"description":"e.g. description, release notes, breaking changes","type":"object","additionalProperties":{"type":"string"}},"compatibleReleases":{"type":"array","items":{"type":"string"}},"experimental":{"type":"boolean"}},"required":["semanticVersion","metadata","compatibleReleases","experimental"]},"PublishAssetsVersionRequest":{"description":"Data for publishing an assets version","type":"object","properties":{"publishInformation":{"$ref":"#/components/schemas/assetsVersionPublishInformation"}},"required":["publishInformation"]},"PublishAssetsVersionResponse":{"description":"Response containing the full description of the published assets version","type":"object","properties":{"assetsVersion":{"$ref":"#/components/schemas/assetsVersion"}},"required":["assetsVersion"]},"GfnContentEmbeddingConfiguration":{"description":"General configuration for Fast Play on GFN titles. If present, it shows that Fast Play is enabled for the organization. If absent, Fast Play is disabled. It is a mapping of variant title ID to a list of properties, such as a user-friendly name and CMS ID.","type":"object","additionalProperties":{"type":"object","properties":{"name":{"type":"string"},"cmsId":{"type":"string"}},"required":["name","cmsId"]}},"getWorldBuilderAccessQuery":{"description":"Query parameters for checking World Builder access","type":"object","properties":{"assetsId":{"description":"The asset ID to check access for","type":"string"},"modId":{"description":"The mod ID to check access for","type":"string"}}},"getWorldBuilderAccessResponse":{"description":"User's access permissions for World Builder functionalities","type":"object","properties":{"canUploadAssets":{"description":"Indicates if the user can upload assets","type":"boolean"},"canUploadContent":{"description":"Indicates if the user can upload content","type":"boolean"},"canUploadToAssetsId":{"description":"Indicates if the user can upload to the specified asset ID","type":"boolean"},"canUploadToModId":{"description":"Indicates if the user can upload to the specified mod ID","type":"boolean"}},"required":["canUploadAssets","canUploadContent"]},"PutEmbedVariantsRequest":{"description":"Request to update the Fast Play configuration.","$ref":"#/components/schemas/GfnContentEmbeddingConfiguration"},"GetEmbedVariantsResponse":{"description":"List of GFN variants that allow Fast Play. The keys are the title IDs, and the values contain the human-readable name and CMS ID of the variant.","$ref":"#/components/schemas/GfnContentEmbeddingConfiguration"}}},"paths":{"/content/":{"get":{"operationId":"getContents","summary":"Get Content IDs","tags":["WorldBuilder","public"],"description":"Retrieves a list of content IDs for a project. You can filter the results by providing query parameters that correspond to properties in the `WorldBuilderContentShape`.","parameters":[{"schema":{"type":"string"},"in":"header","name":"x-m2-organization-id","required":true,"description":"The ID of an organization"},{"schema":{"type":"string"},"in":"header","name":"x-m2-project-id","required":true,"description":"The ID of a project"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"List of content IDs available in World Builder, representing unique identifiers for various content items","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWorldBuilderContentsResponse"}}}},"4XX":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}},"post":{"operationId":"createContent","summary":"Create Content","tags":["WorldBuilder","public"],"description":"Creates new content for a specific project.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostWorldBuilderContentsBody"}}}},"parameters":[{"schema":{"type":"string"},"in":"header","name":"x-m2-organization-id","required":true,"description":"The ID of an organization"},{"schema":{"type":"string"},"in":"header","name":"x-m2-project-id","required":true,"description":"The ID of a project"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"201":{"description":"Response containing the ID of the newly created content in World Builder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostWorldBuilderContentsResponse"}}}},"4XX":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}}},"/content/embed/":{"get":{"operationId":"getContentEmbedRuns","summary":"List Embedded Content Runs","tags":["WorldBuilder"],"description":"Retrieves a list of runs for uploading embedded content for the specified organization. It can filter the runs by state (queued, pending, running, cancelling, completed or failed).","parameters":[{"schema":{"type":"number"},"in":"query","name":"limit","required":false,"description":"Number of documents to return per page"},{"schema":{"type":"string"},"in":"query","name":"startAfter","required":false,"description":"Unique id of the returned value object that the query should start after"},{"schema":{"type":"string"},"in":"query","name":"endBefore","required":false,"description":"Unique id of the returned value object that the query should end before"},{"schema":{"type":"array","items":{"type":"object","properties":{"field":{"description":"Field to order by. Allows nesting with dot notation, e.g. if a field is nested in an object, use 'object.field'","type":"string"},"direction":{"description":"Direction to order by, either 'asc' (Ascending) or 'desc' (Descending)","anyOf":[{"type":"string","enum":["asc"]},{"type":"string","enum":["desc"]}]}},"required":["field","direction"]}},"in":"query","name":"orderBy","required":false},{"schema":{"type":"object","properties":{"field":{"description":"Field to search by. Allows nesting with dot notation, e.g. if a field is nested in an object, use 'object.field'","type":"string"},"prefix":{"description":"Prefix to search for. NOTE: Prefix searching is case sensitive.","type":"string"}}},"in":"query","name":"searchBy","required":false},{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]}}},"in":"query","name":"filterBy","required":false,"description":"Filter by field and values."},{"schema":{"type":"string"},"in":"header","name":"x-m2-organization-id","required":true,"description":"The ID of an organization"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"List of embedded content runs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWorldBuilderContentEmbedRunsResponse"}}}},"4XX":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}}},"/content/{contentId}/":{"get":{"operationId":"getContent","summary":"Get Content","tags":["WorldBuilder","public"],"description":"Retrieves the data for content using its `contentId`.","parameters":[{"schema":{"type":"string"},"in":"path","name":"contentId","required":true,"description":"Unique identifier of the World Builder content to operate on, used in various content-related API endpoints"},{"schema":{"type":"string"},"in":"header","name":"x-m2-organization-id","required":false,"description":"The ID of an organization"},{"schema":{"type":"string"},"in":"header","name":"x-m2-project-id","required":false,"description":"The ID of a project"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"Detailed information about a specific World Builder content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWorldBuilderContentResponse"}}}},"4XX":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}},"patch":{"operationId":"updateContent","summary":"Update Content","tags":["WorldBuilder","public"],"description":"Updates the maps for a specific content ID.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchWorldBuilderContentBody"}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"contentId","required":true,"description":"Unique identifier of the World Builder content to operate on, used in various content-related API endpoints"},{"schema":{"type":"string"},"in":"header","name":"x-m2-organization-id","required":true,"description":"The ID of an organization"},{"schema":{"type":"string"},"in":"header","name":"x-m2-project-id","required":true,"description":"The ID of a project"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"Updated World Builder content after modification, including organization, project, and mod IDs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchWorldBuilderContentResponse"}}}},"4XX":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}},"delete":{"operationId":"deleteContent","summary":"Delete Content","tags":["WorldBuilder","public"],"description":"Deletes a specific content ID.","parameters":[{"schema":{"type":"string"},"in":"path","name":"contentId","required":true,"description":"Unique identifier of the World Builder content to operate on, used in various content-related API endpoints"},{"schema":{"type":"string"},"in":"header","name":"x-m2-organization-id","required":true,"description":"The ID of an organization"},{"schema":{"type":"string"},"in":"header","name":"x-m2-project-id","required":true,"description":"The ID of a project"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"204":{"description":"Empty response indicating successful content deletion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteWorldBuilderContentResponse"}}}},"4XX":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}}},"/content/{contentId}/embed/":{"post":{"operationId":"postContentEmbedRun","summary":"Create a new Fast Play build","tags":["WorldBuilder"],"description":"Queues a new Fast Play build for the specified organization, project, and content.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostWorldBuilderContentEmbedRunRequest"}}}},"parameters":[{"schema":{"type":"string"},"in":"path","name":"contentId","required":true},{"schema":{"type":"string"},"in":"header","name":"x-m2-organization-id","required":true,"description":"The ID of an organization"},{"schema":{"type":"string"},"in":"header","name":"x-m2-project-id","required":true,"description":"The ID of a project"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"The data of the created Fast Play build","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostWorldBuilderContentEmbedRunResponse"}}}},"4XX":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}}},"/content/{contentId}/embed/{contentEmbedRunId}/":{"delete":{"operationId":"deleteContentEmbedRun","summary":"Delete a Fast Play build","tags":["WorldBuilder"],"description":"Stops a Fast Play build that is in the `queued`, `pending`, or `running` phase.","parameters":[{"schema":{"type":"string"},"in":"path","name":"contentId","required":true},{"schema":{"type":"string"},"in":"path","name":"contentEmbedRunId","required":true},{"schema":{"type":"string"},"in":"header","name":"x-m2-organization-id","required":true,"description":"The ID of an organization"},{"schema":{"type":"string"},"in":"header","name":"x-m2-project-id","required":true,"description":"The ID of a project"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"204":{"description":"Default Response","content":{"application/json":{"schema":{}}}},"4XX":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}}},"/mods/":{"get":{"operationId":"getMods","summary":"Get Mods","tags":["WorldBuilder","public"],"description":"Retrieves a list of mods that the user has access to within an organization or project.\n    Only project scoped queries may make paginated requests. Support for organization scoped queries will be removed in a future version.","parameters":[{"schema":{"type":"number"},"in":"query","name":"limit","required":false,"description":"Number of documents to return per page"},{"schema":{"type":"string"},"in":"query","name":"startAfter","required":false,"description":"Unique id of the returned value object that the query should start after"},{"schema":{"type":"string"},"in":"query","name":"endBefore","required":false,"description":"Unique id of the returned value object that the query should end before"},{"schema":{"type":"array","items":{"type":"object","properties":{"field":{"description":"Field to order by. Allows nesting with dot notation, e.g. if a field is nested in an object, use 'object.field'","type":"string"},"direction":{"description":"Direction to order by, either 'asc' (Ascending) or 'desc' (Descending)","anyOf":[{"type":"string","enum":["asc"]},{"type":"string","enum":["desc"]}]}},"required":["field","direction"]}},"in":"query","name":"orderBy","required":false},{"schema":{"type":"object","properties":{"field":{"description":"Field to search by. Allows nesting with dot notation, e.g. if a field is nested in an object, use 'object.field'","type":"string"},"prefix":{"description":"Prefix to search for. NOTE: Prefix searching is case sensitive.","type":"string"}}},"in":"query","name":"searchBy","required":false},{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]}}},"in":"query","name":"filterBy","required":false,"description":"Filter by field and values."},{"schema":{"type":"string"},"in":"header","name":"x-m2-organization-id","required":true,"description":"The ID of an organization"},{"schema":{"type":"string"},"in":"header","name":"x-m2-project-id","required":false,"description":"The ID of a project"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"The relevant mods associated with the organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModsResponseSchema"}}}},"4XX":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}}},"/mods/mapping/":{"get":{"operationId":"getProjectMods","summary":"Get Mod IDs","tags":["WorldBuilder","public"],"description":"Retrieves a list of mod IDs that the user has access to within an organization and project.","parameters":[{"schema":{"type":"string"},"in":"header","name":"x-m2-organization-id","required":true,"description":"The ID of an organization"},{"schema":{"type":"string"},"in":"header","name":"x-m2-project-id","required":true,"description":"The ID of a project"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"The relevant mods associated with the project.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProjectModsResponseSchema"}}}},"4XX":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}}},"/mods/{modId}/":{"get":{"operationId":"getMods","summary":"Get Mod","tags":["WorldBuilder","public"],"description":"Retrieves a mod and its associated content using the mod's `modId`. The response also includes the user's write access permissions for the mod.","parameters":[{"schema":{"type":"number"},"in":"query","name":"limit","required":false,"description":"Number of documents to return per page"},{"schema":{"type":"string"},"in":"query","name":"startAfter","required":false,"description":"Unique id of the returned value object that the query should start after"},{"schema":{"type":"string"},"in":"query","name":"endBefore","required":false,"description":"Unique id of the returned value object that the query should end before"},{"schema":{"type":"array","items":{"type":"object","properties":{"field":{"description":"Field to order by. Allows nesting with dot notation, e.g. if a field is nested in an object, use 'object.field'","type":"string"},"direction":{"description":"Direction to order by, either 'asc' (Ascending) or 'desc' (Descending)","anyOf":[{"type":"string","enum":["asc"]},{"type":"string","enum":["desc"]}]}},"required":["field","direction"]}},"in":"query","name":"orderBy","required":false},{"schema":{"type":"object","properties":{"field":{"description":"Field to search by. Allows nesting with dot notation, e.g. if a field is nested in an object, use 'object.field'","type":"string"},"prefix":{"description":"Prefix to search for. NOTE: Prefix searching is case sensitive.","type":"string"}}},"in":"query","name":"searchBy","required":false},{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]}}},"in":"query","name":"filterBy","required":false,"description":"Filter by field and values."},{"schema":{"type":"string"},"in":"path","name":"modId","required":true},{"schema":{"type":"string"},"in":"header","name":"x-m2-organization-id","required":true,"description":"The ID of an organization"},{"schema":{"type":"string"},"in":"header","name":"x-m2-project-id","required":true,"description":"The ID of a project"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"The response when getting a mod","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModResponseSchema"}}}},"4XX":{"description":"The error object returned by the API when an error occurs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/apiError"}}}}}}},"/mods/{modId}/contents/":{"get":{"operationId":"getModContents","summary":"Get Mod Contents","tags":["WorldBuilder","public"],"description":"Lists all the contents for a mod.","parameters":[{"schema":{"type":"number"},"in":"query","name":"limit","required":false,"description":"Number of documents to return per page"},{"schema":{"type":"string"},"in":"query","name":"startAfter","required":false,"description":"Unique id of the returned value object that the query should start after"},{"schema":{"type":"string"},"in":"query","name":"endBefore","required":false,"description":"Unique id of the returned value object that the query should end before"},{"schema":{"type":"array","items":{"type":"object","properties":{"field":{"description":"Field to order by. Allows nesting with dot notation, e.g. if a field is nested in an object, use 'object.field'","type":"string"},"direction":{"description":"Direction to order by, either 'asc' (Ascending) or 'desc' (Descending)","anyOf":[{"type":"string","enum":["asc"]},{"type":"string","enum":["desc"]}]}},"required":["field","direction"]}},"in":"query","name":"orderBy","required":false},{"schema":{"type":"object","properties":{"field":{"description":"Field to search by. Allows nesting with dot notation, e.g. if a field is nested in an object, use 'object.field'","type":"string"},"prefix":{"description":"Prefix to search for. NOTE: Prefix searching is case sensitive.","type":"string"}}},"in":"query","name":"searchBy","required":false},{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"}]}}},"in":"query","name":"filterBy","required":false,"description":"Filter by field and values."},{"schema":{"type":"string"},"in":"path","name":"modId","required":true},{"schema":{"type":"string"},"in":"header","name":"x-m2-organization-id","required":true,"description":"The ID of an organization"},{"schema":{"type":"string"},"in":"header","name":"x-m2-project-id","required":true,"description":"The ID of a project"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"responses":{"200":{"description":"A list of contents for the requested Mod.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModContentsResponseSchema"}}}}}}}},"servers":[{"url":"https://{organizationId}.m2worlds.io/api/world-builder","variables":{"organizationId":{"default":"your-organization-id"}}}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}