Rust · 0.1.0

Update Space

PATCH /api/v1/spaces/{space}

SpaceService · SpaceService_UpdateSpace

Protocol-derived reference. Authorization and instance policy still apply. Schema descriptions are inherited from the MIT-licensed application contract; examples here are not executed against a live server.

Access

Requires the space ADMIN role as an active member. An instance administrator who is not a space administrator cannot use these governance operations.

Editable metadata

Use a nonempty mask containing title, description or icon. Title cannot be blank. Including icon in the mask while omitting its value resets the icon. This operation does not move memos or change membership.

Request

UpdateSpace updates space metadata.

PATCH/api/v1/spaces/{space}

Parameters

Name / location	Type / requirement	Description
`space` path	string Required	The space id.
`updateMask` query	string (field-mask) Required (contract description)	Required. The fields to update: title or description.

Request body

Required

application/json · Space

Responses

200 · OK

application/json · Space

default · Default error response

application/json · Status

Complete operation definition

All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.

Open JSON definition

{
  "tags": [
    "SpaceService"
  ],
  "description": "UpdateSpace updates space metadata.",
  "operationId": "SpaceService_UpdateSpace",
  "parameters": [
    {
      "name": "space",
      "in": "path",
      "description": "The space id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "updateMask",
      "in": "query",
      "description": "Required. The fields to update: title or description.",
      "schema": {
        "type": "string",
        "format": "field-mask"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Space"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Space"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}