Work with Spaces¶

Create a Space¶

Request¶

POST /spaces

Because it is a POST request, it has to have at least the following body.

{
    "title": "My Demo Space",
    "description": "A description which may contain ***markdown*** syntax"
}

Response¶

{
    "id": "x-demospace",
    "title": "My Demo Space",
    "description": "A description which may contain ***markdown*** syntax"
}

Read a Specific Space¶

Request¶

Try in your local Swagger

GET /spaces/{spaceId}

Response¶

{
  "id": "{spaceId}",
  "title": "My Demo Space",
  "description": "A description which may contain ***markdown*** syntax"
}

Read all Spaces¶

Request¶

Try in your local Swagger

GET /spaces

Response¶

[
    {
        "id": "x-demospace",
        "title": "My Demo Space",
        "description": "A description which may contain ***markdown*** syntax"
    },
    {
        "id": "x-trees",
        "title": "A public space",
        "description": "All the old oaks in Berlin"
    }
]

Update a Space¶

Request¶

Try in your local Swagger

PATCH /spaces/{spaceId}

which requires a body such as the following:

{
    "title": "My Demo Space",
    "description": "**Altered** Description"
}

Response¶

{
    "title": "My Demo Space",
    "description": "**Altered** Description"
}

Delete a Space¶

Request¶

Try in your local Swagger

DELETE /spaces/{spaceId}

A successful response to this request is the following:

Response¶

HTTP/1.1 204 No Content