Skip to content

docs: update service-maps api snapshot #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
grounds-openapi-publisher wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update service-maps api snapshot #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
169 changes: 163 additions & 6 deletions public/specs/service-maps/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info" : {
"description" : "The registry for Minecraft maps: what exists, which versions were published, and which version each environment serves.\n\n**Bundles do not pass through this API.** An upload is a presigned URL the client PUTs to directly, and game servers read published content from the CDN — they never call this service.\n\n**Publishing is not going live.** A published version is merely pinnable; moving a pin is what changes the map every player loads, and it is granted separately.\n\n**Uploaded maps may derive asynchronously.** When derivation is enabled, commit an uploaded source, poll its exact version until it reaches a terminal state, and retry only retryable SYSTEM failures through the derive retry endpoint.",
"title" : "Maps API",
"version" : "local-SNAPSHOT"
"version" : "unspecified"
},
"tags" : [ {
"name" : "Maps",
Expand All @@ -14,6 +14,8 @@
}, {
"name" : "Pins",
"description" : "Which version an environment serves. Going live and rolling back."
}, {
"name" : "Workspaces"
} ],
"components" : {
"securitySchemes" : {
Expand Down Expand Up @@ -48,7 +50,6 @@
},
"CreateMapRequest" : {
"type" : "object",
"required" : [ "address" ],
"properties" : {
"address" : {
"type" : "string"
Expand All @@ -66,7 +67,6 @@
},
"ForkRequest" : {
"type" : "object",
"required" : [ "target" ],
"properties" : {
"target" : {
"type" : "string"
Expand All @@ -87,7 +87,7 @@
},
"MapDto" : {
"type" : "object",
"required" : [ "address", "displayName", "kind", "trust", "ownerSub", "createdAt" ],
"required" : [ "address", "displayName", "kind", "stateful", "trust", "ownerSub", "forkedFrom", "createdAt" ],
"properties" : {
"address" : {
"type" : "string"
Expand Down Expand Up @@ -124,9 +124,26 @@
}
}
},
"OpenSnapshotRequest" : {
"type" : "object",
"properties" : {
"base" : {
"type" : [ "integer", "null" ],
"format" : "int64"
},
"files" : {
"type" : [ "array", "null" ],
"items" : {
"$ref" : "#/components/schemas/WorkspaceFile"
}
},
"shrink" : {
"type" : "boolean"
}
}
},
"PublishVersionRequest" : {
"type" : "object",
"required" : [ "bundleSha256" ],
"properties" : {
"bundleSha256" : {
"type" : "string"
Expand All @@ -147,6 +164,22 @@
"format" : "int32"
}
}
},
"WorkspaceFile" : {
"type" : "object",
"required" : [ "path", "sha256", "size" ],
"properties" : {
"path" : {
"type" : "string"
},
"sha256" : {
"type" : "string"
},
"size" : {
"type" : "integer",
"format" : "int64"
}
}
}
}
},
Expand All @@ -161,7 +194,8 @@
"in" : "query",
"schema" : {
"type" : [ "string", "null" ]
}
},
"required" : true
} ],
"responses" : {
"200" : {
Expand Down Expand Up @@ -654,6 +688,129 @@
"keycloakBearer" : [ ]
} ]
}
},
"/v1/workspaces/{server}/head" : {
"get" : {
"summary" : "Read the working-copy head",
"description" : "Every file of the head snapshot with a presigned GET. 404 before the first commit.",
"tags" : [ "Workspaces" ],
"parameters" : [ {
"name" : "server",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : { }
}
}
},
"401" : {
"description" : "Not Authorized"
},
"403" : {
"description" : "Not Allowed"
}
},
"security" : [ {
"keycloakBearer" : [ ]
} ]
}
},
"/v1/workspaces/{server}/snapshots" : {
"post" : {
"summary" : "Open a working-copy snapshot",
"description" : "Returns the snapshot number and a presigned PUT for every blob the bucket does not have yet. Refused with 409 when base is not the head.",
"tags" : [ "Workspaces" ],
"parameters" : [ {
"name" : "server",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/OpenSnapshotRequest"
}
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : { }
}
}
},
"401" : {
"description" : "Not Authorized"
},
"403" : {
"description" : "Not Allowed"
},
"400" : {
"description" : "Bad Request"
}
},
"security" : [ {
"keycloakBearer" : [ ]
} ]
}
},
"/v1/workspaces/{server}/snapshots/{snapshot}/commit" : {
"post" : {
"summary" : "Commit a working-copy snapshot",
"description" : "Makes the snapshot the head once every blob it introduced is in the bucket.",
"tags" : [ "Workspaces" ],
"parameters" : [ {
"name" : "server",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
}, {
"name" : "snapshot",
"in" : "path",
"required" : true,
"schema" : {
"type" : "integer",
"format" : "int64"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : { }
}
}
},
"401" : {
"description" : "Not Authorized"
},
"403" : {
"description" : "Not Allowed"
}
},
"security" : [ {
"keycloakBearer" : [ ]
} ]
}
}
},
"servers" : [ {
Expand Down
Loading