TimelineNoteUpdate

Fields

Only the fields SENT are applied (model_fields_set).

4 fields

ends_on

string (date) or null

starts_on

string (date) or null

suite_name

string or null

text

string or null

Raw schema (JSON)

{
  "additionalProperties": false,
  "description": "Only the fields SENT are applied (``model_fields_set``).",
  "properties": {
    "ends_on": {
      "anyOf": [
        {
          "format": "date",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Ends On"
    },
    "starts_on": {
      "anyOf": [
        {
          "format": "date",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Starts On"
    },
    "suite_name": {
      "anyOf": [
        {
          "maxLength": 500,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Suite Name"
    },
    "text": {
      "anyOf": [
        {
          "maxLength": 280,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Text"
    }
  },
  "title": "TimelineNoteUpdate",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• PATCH /api/v1/projects/{project_id}/timeline-notes/{note_id} — Update Timeline Note

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON