Outline · Example Payload

Starscreate

Stars

Starscreate is an example object payload from Outline, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdpathmethodsummarytagsrequestSchema

Example Payload

Raw ↑ 
{
  "operationId": "starsCreate",
  "path": "/stars.create",
  "method": "POST",
  "summary": "Create a star",
  "tags": [
    "Stars"
  ],
  "requestSchema": {
    "type": "object",
    "properties": {
      "documentId": {
        "type": "string",
        "format": "uuid"
      },
      "collectionId": {
        "type": "string",
        "format": "uuid"
      },
      "index": {
        "type": "string"
      }
    }
  }
}