dev.knotless.putRunOutput

lexicons.knotless.dev

Documentation

Sends the appview what a check's steps printed since the runner last sent, for the pages following the check while it runs: the dev.knotless.check record says nothing of a run until it ends. Only whole lines are sent, with the run's secrets masked as its log's are. The appview keeps the tail of each run in memory, never for good: the record's log is what is kept. Only the runner that files the check may send its output, and an appview holding as many runs as it keeps, or as many of the caller's, refuses more until some end. Requires a service token from the caller's PDS, audience the appview's DID, for this method.

main procedure

Sends the appview what a check's steps printed since the runner last sent, for the pages following the check while it runs: the dev.knotless.check record says nothing of a run until it ends. Only whole lines are sent, with the run's secrets masked as its log's are. The appview keeps the tail of each run in memory, never for good: the record's log is what is kept. Only the runner that files the check may send its output, and an appview holding as many runs as it keeps, or as many of the caller's, refuses more until some end. Requires a service token from the caller's PDS, audience the appview's DID, for this method.

Input

Encodingapplication/json
check stringat-uri Required

The dev.knotless.check record the run files, in the caller's repo.

ended boolean Optional

Set on the last send: the run's steps are over, and its record is about to be filed.

going string Optional

The name of the step running now, sent with `steps`: none between steps.

maxLength: 512 bytes
offset integer Required

Where `text` starts in all the run has sent, in bytes: text sent again is passed over, and a gap, from output the runner let go, starts what is kept anew.

minimum: 0
steps array Optional

The steps that ended so far, as the check's record will say.

maxLength: 256 items
text string Optional

What the steps printed since the last send, as UTF-8.

maxLength: 20000 bytes

Output

Encodingapplication/json
watched boolean Required

Whether a page follows the run now: a runner may send less often when none does.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "description": "Sends the appview what a check's steps printed since the runner last sent, for the pages following the check while it runs: the dev.knotless.check record says nothing of a run until it ends. Only whole lines are sent, with the run's secrets masked as its log's are. The appview keeps the tail of each run in memory, never for good: the record's log is what is kept. Only the runner that files the check may send its output, and an appview holding as many runs as it keeps, or as many of the caller's, refuses more until some end. Requires a service token from the caller's PDS, audience the appview's DID, for this method.",
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "check": {
          "description": "The dev.knotless.check record the run files, in the caller's repo.",
          "format": "at-uri",
          "type": "string"
        },
        "ended": {
          "description": "Set on the last send: the run's steps are over, and its record is about to be filed.",
          "type": "boolean"
        },
        "going": {
          "description": "The name of the step running now, sent with `steps`: none between steps.",
          "maxLength": 512,
          "type": "string"
        },
        "offset": {
          "description": "Where `text` starts in all the run has sent, in bytes: text sent again is passed over, and a gap, from output the runner let go, starts what is kept anew.",
          "minimum": 0,
          "type": "integer"
        },
        "steps": {
          "description": "The steps that ended so far, as the check's record will say.",
          "items": {
            "ref": "dev.knotless.check#step",
            "type": "ref"
          },
          "maxLength": 256,
          "type": "array"
        },
        "text": {
          "description": "What the steps printed since the last send, as UTF-8.",
          "maxLength": 20000,
          "type": "string"
        }
      },
      "required": [
        "check",
        "offset"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "watched": {
          "description": "Whether a page follows the run now: a runner may send less often when none does.",
          "type": "boolean"
        }
      },
      "required": [
        "watched"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@