|
1168 | 1168 | }, |
1169 | 1169 | "/orgs/{orgName}/devboxes/": { |
1170 | 1170 | "get": { |
1171 | | - "description": "List devboxes. Use query param all=true to list all devboxes in org, otherwise returns user's devboxes.", |
| 1171 | + "description": "List devboxes. Use query param all=true to list all devboxes in org, otherwise returns user's devboxes. API key authentication returns org-scoped devboxes.", |
1172 | 1172 | "consumes": [ |
1173 | 1173 | "application/json" |
1174 | 1174 | ], |
|
1227 | 1227 | } |
1228 | 1228 | }, |
1229 | 1229 | "post": { |
1230 | | - "description": "Register a devbox with metadata. Returns 201 Created for new devbox, 200 OK if already exists.", |
| 1230 | + "description": "Register a devbox with metadata. Returns 201 Created for new devbox, 200 OK if already exists. When authenticated via API key, creates org-scoped devboxes shared across all API keys in the org.", |
1231 | 1231 | "consumes": [ |
1232 | 1232 | "application/json" |
1233 | 1233 | ], |
|
4096 | 4096 | "type": "object", |
4097 | 4097 | "properties": { |
4098 | 4098 | "id": { |
4099 | | - "description": "Deterministic ID: hash of user email + metadata", |
| 4099 | + "description": "Deterministic ID: hash of user ID + metadata (for user-owned) or hash of metadata only (for API key-owned, org-scoped)", |
4100 | 4100 | "type": "string" |
4101 | 4101 | }, |
4102 | | - "idMeta": { |
4103 | | - "description": "Metadata used to generate ID (host, machine-id, etc.)", |
4104 | | - "type": "object", |
4105 | | - "additionalProperties": { |
4106 | | - "type": "string" |
4107 | | - } |
4108 | | - }, |
4109 | | - "labels": { |
| 4102 | + "metadata": { |
| 4103 | + "description": "Metadata (all key-value pairs). Only \"name\" and \"machine-id\" are used for ID generation.", |
4110 | 4104 | "type": "object", |
4111 | 4105 | "additionalProperties": { |
4112 | 4106 | "type": "string" |
|
4116 | 4110 | "$ref": "#/definitions/DevboxStatus" |
4117 | 4111 | }, |
4118 | 4112 | "user": { |
4119 | | - "description": "User email attribute (for display/authorization)", |
| 4113 | + "description": "User email attribute (for display/authorization). Empty string for API key-owned devboxes (org-scoped).", |
4120 | 4114 | "type": "string" |
4121 | 4115 | } |
4122 | 4116 | } |
|
4127 | 4121 | "claim": { |
4128 | 4122 | "type": "boolean" |
4129 | 4123 | }, |
4130 | | - "idMeta": { |
4131 | | - "description": "Required: used to generate deterministic ID (host, machine-id, etc.)", |
4132 | | - "type": "object", |
4133 | | - "additionalProperties": { |
4134 | | - "type": "string" |
4135 | | - } |
4136 | | - }, |
4137 | | - "labels": { |
| 4124 | + "metadata": { |
| 4125 | + "description": "Required: metadata key-value pairs. Only \"name\" and \"machine-id\" are used for ID generation.", |
4138 | 4126 | "type": "object", |
4139 | 4127 | "additionalProperties": { |
4140 | 4128 | "type": "string" |
|
0 commit comments