Get a worktree's README

GET https://runix.chat/api/v1/armada/workspaces/{workspace_uuid}/readme

The headings of a worktree's README as people see it now: the document they are editing together, or README.md in the worktree when nobody has opened it yet.

Changes: New in Zulip 13.0 (feature level ZF-8c5c9c).

Usage examples

curl -sSX GET -G https://runix.chat/api/v1/armada/workspaces/8e6d3b9e-4c36-4f2a-9a55-3f4b0c6f1d2e/readme \
    -u EMAIL_ADDRESS:API_KEY

Parameters

Response

Return values

• armada_readme: object

  The worktree's README.

  • path: string

    The README's path in the worktree: README.md.

  • exists: boolean

    Whether the README has any text, or a file. Every worktree's README can be edited; its file is made when someone first writes in it.

  • headings: (object)[]

    The README's headings, in order.

    • level: integer

      Its level, from 1 to 6.

    • text: string

      Its words, as written (Markdown).

    • slug: string

      Its anchor, as GitHub makes one, unique in the README.

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "armada_readme": {
        "exists": true,
        "headings": [
            {
                "level": 1,
                "slug": "click",
                "text": "click"
            },
            {
                "level": 2,
                "slug": "a-simple-example",
                "text": "A simple example"
            }
        ],
        "path": "README.md"
    },
    "msg": "",
    "result": "success"
}