{ "openapi": "3.1.0", "info": { "title": "Barakah Tasks API", "version": "1.0.0", "description": "Public REST API. Ordinary collections use a fixed sequence high-water. The Event Log advances from the last observed publication sequence without a fixed high-water." }, "servers": [ { "url": "https://api.barakahtasks.com" } ], "paths": { "/v1/tasks": { "get": { "operationId": "listTasks", "parameters": [ { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "tasks:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false }, "post": { "operationId": "createTask", "parameters": [ { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "tasks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": false, "tags": [ "Tasks" ], "summary": "Create a Task" } }, "/v1/tasks/{taskId}": { "get": { "operationId": "getTask", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "tasks:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false }, "patch": { "operationId": "updateTask", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } } ], "security": [ { "oauth2": [ "tasks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": true }, "delete": { "operationId": "deleteTask", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } } ], "security": [ { "oauth2": [ "tasks:delete" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": true, "tags": [ "Tasks" ], "summary": "Delete a Task" } }, "/v1/tasks/{taskId}/complete": { "post": { "operationId": "completeTask", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "tasks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": true, "tags": [ "Tasks" ], "summary": "Complete a Task" } }, "/v1/tasks/{taskId}/reopen": { "post": { "operationId": "reopenTask", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "tasks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": true, "tags": [ "Tasks" ], "summary": "Reopen a Task" } }, "/v1/tasks/{taskId}/restore": { "post": { "operationId": "restoreTask", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "tasks:delete" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": true, "tags": [ "Tasks" ], "summary": "Restore a Task" } }, "/v1/tasks/{taskId}/notes": { "get": { "operationId": "getTaskNotes", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "tasks:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false }, "put": { "operationId": "putTaskNotes", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } } ], "security": [ { "oauth2": [ "tasks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": true, "tags": [ "Notes" ], "summary": "Replace Task Notes" } }, "/v1/tasks/{taskId}/reminder": { "get": { "operationId": "getTaskReminder", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "tasks:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false }, "put": { "operationId": "putTaskReminder", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } } ], "security": [ { "oauth2": [ "tasks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": true }, "delete": { "operationId": "deleteTaskReminder", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } } ], "security": [ { "oauth2": [ "tasks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": true, "tags": [ "Reminders" ], "summary": "Clear a Task reminder" } }, "/v1/tasks/{taskId}/steps": { "get": { "operationId": "listTaskSteps", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "tasks:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false }, "post": { "operationId": "createTaskStep", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "tasks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": false, "tags": [ "Steps" ], "summary": "Create a Task step" } }, "/v1/tasks/{taskId}/steps/{stepId}": { "get": { "operationId": "getTaskStep", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "stepId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "tasks:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false }, "patch": { "operationId": "updateTaskStep", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "stepId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } } ], "security": [ { "oauth2": [ "tasks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": true }, "delete": { "operationId": "deleteTaskStep", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "stepId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } } ], "security": [ { "oauth2": [ "tasks:delete" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": true, "tags": [ "Steps" ], "summary": "Delete a Task step" } }, "/v1/lists": { "get": { "operationId": "listLists", "parameters": [ { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "categories:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false }, "post": { "operationId": "createList", "parameters": [ { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "categories:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": false, "tags": [ "Lists" ], "summary": "Create a List" } }, "/v1/lists/{listId}": { "get": { "operationId": "getList", "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "categories:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false }, "patch": { "operationId": "updateList", "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } } ], "security": [ { "oauth2": [ "categories:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": true }, "delete": { "operationId": "deleteList", "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } } ], "security": [ { "oauth2": [ "categories:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": true, "tags": [ "Lists" ], "summary": "Delete a List" } }, "/v1/lists/{listId}/notes": { "get": { "operationId": "getListNotes", "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "categories:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false }, "put": { "operationId": "putListNotes", "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } } ], "security": [ { "oauth2": [ "categories:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": true, "tags": [ "Notes" ], "summary": "Replace List Notes" } }, "/v1/lists/{listId}/members": { "get": { "operationId": "listListMembers", "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "categories:read", "collaborators:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false, "tags": [ "Lists" ], "summary": "List the owner and accepted members", "x-barakah-fixed-high-water": true, "x-barakah-member-projection": { "included": [ "id", "role", "display_name", "email", "joined_at" ] } } }, "/v1/lists/{listId}/share": { "post": { "operationId": "shareList", "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "categories:write", "collaborators:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": true, "tags": [ "Lists" ], "summary": "Share a List" } }, "/v1/lists/{listId}/unshare": { "post": { "operationId": "unshareList", "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "categories:write", "collaborators:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": true, "tags": [ "Lists" ], "summary": "Unshare a List" } }, "/v1/tags": { "get": { "operationId": "listTags", "parameters": [ { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "tags:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false }, "post": { "operationId": "createTag", "parameters": [ { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "tags:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": false, "tags": [ "Tags" ], "summary": "Create a tag" } }, "/v1/tags/{tagId}": { "get": { "operationId": "getTag", "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "tags:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false }, "patch": { "operationId": "updateTag", "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } } ], "security": [ { "oauth2": [ "tags:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": true }, "delete": { "operationId": "deleteTag", "parameters": [ { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } } ], "security": [ { "oauth2": [ "tags:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": true, "tags": [ "Tags" ], "summary": "Delete a tag" } }, "/v1/tasks/{taskId}/tags/{tagId}": { "put": { "operationId": "assignTaskTag", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "tags:write", "tasks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false }, "delete": { "operationId": "unassignTaskTag", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "tags:write", "tasks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false, "tags": [ "Tags" ], "summary": "Unassign a tag from a Task" } }, "/v1/tasks/{taskId}/comments": { "get": { "operationId": "listTaskComments", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "comments:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false }, "post": { "operationId": "createTaskComment", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "comments:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": false, "tags": [ "Comments" ], "summary": "Post a flat Task comment" } }, "/v1/tasks/{taskId}/attachments/uploads": { "post": { "operationId": "createAttachmentUpload", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "attachments:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": false, "tags": [ "Attachments" ], "summary": "Create an attachment upload delegation" } }, "/v1/tasks/{taskId}/attachments/{attachmentId}/complete": { "post": { "operationId": "completeAttachmentUpload", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "attachmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "attachments:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": false, "tags": [ "Attachments" ], "summary": "Complete an attachment upload" } }, "/v1/tasks/{taskId}/attachments": { "get": { "operationId": "listTaskAttachments", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "attachments:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false, "tags": [ "Attachments" ], "summary": "List Task attachments", "x-barakah-fixed-high-water": true } }, "/v1/tasks/{taskId}/attachments/{attachmentId}/download": { "get": { "operationId": "getAttachmentDownload", "parameters": [ { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "attachmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "attachments:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false, "tags": [ "Attachments" ], "summary": "Create an attachment download delegation" } }, "/v1/settings": { "get": { "operationId": "getSettings", "parameters": [ { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "settings:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false }, "patch": { "operationId": "updateSettings", "parameters": [ { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "settings:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restMutation", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false, "tags": [ "Settings" ], "summary": "Update settings" } }, "/v1/prayer-times": { "get": { "operationId": "getPrayerTimes", "parameters": [ { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "prayer:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false, "tags": [ "Prayer" ], "summary": "Get prayer times" } }, "/v1/prayer-times/resolve": { "post": { "operationId": "resolvePrayerRelativeTime", "parameters": [ { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "prayer:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false, "tags": [ "Prayer" ], "summary": "Resolve a prayer-relative time" } }, "/v1/events": { "get": { "operationId": "listEvents", "parameters": [ { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "events:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false, "tags": [ "Events" ], "summary": "Poll published events forward", "x-barakah-fixed-high-water": false, "x-barakah-sequence-gaps": "normal" } }, "/v1/events/{eventId}": { "get": { "operationId": "getEvent", "parameters": [ { "name": "eventId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "events:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "restRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false, "tags": [ "Events" ], "summary": "Get one retained published CloudEvent" } }, "/v1/webhooks": { "get": { "operationId": "listWebhooks", "parameters": [ { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "webhooks:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "webhookRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false, "x-required-scopes": [ "webhooks:read" ] }, "post": { "operationId": "createWebhook", "parameters": [ { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "webhooks:write" ] } ], "responses": { "201": { "description": "Created; signing secret revealed once." } }, "x-barakah-operation-class": "webhookMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": false, "x-required-scopes": [ "webhooks:write", "events:read" ] } }, "/v1/webhooks/{subscriptionId}": { "get": { "operationId": "getWebhook", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "webhooks:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "webhookRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false }, "patch": { "operationId": "updateWebhook", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "webhooks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "webhookMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": true }, "delete": { "operationId": "deleteWebhook", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "webhooks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "webhookMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": true } }, "/v1/webhooks/{subscriptionId}/verify": { "post": { "operationId": "verifyWebhook", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "webhooks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "webhookVerification", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": true } }, "/v1/webhooks/{subscriptionId}/rotate-secret": { "post": { "operationId": "rotateWebhookSecret", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "webhooks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "webhookMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": true } }, "/v1/webhooks/{subscriptionId}/pause": { "post": { "operationId": "pauseWebhook", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "webhooks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "webhookMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": true } }, "/v1/webhooks/{subscriptionId}/resume": { "post": { "operationId": "resumeWebhook", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "webhooks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "webhookMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": true } }, "/v1/webhooks/{subscriptionId}/deliveries": { "get": { "operationId": "listWebhookDeliveries", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "webhooks:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "webhookRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false } }, "/v1/webhooks/{subscriptionId}/gaps": { "get": { "operationId": "listWebhookGaps", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } } ], "security": [ { "oauth2": [ "webhooks:read" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "webhookRead", "x-barakah-idempotency-required": false, "x-barakah-precondition-required": false } }, "/v1/webhooks/{subscriptionId}/gaps/{gapId}/acknowledge": { "post": { "operationId": "acknowledgeWebhookGap", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "gapId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "webhooks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "webhookMutation", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": true } }, "/v1/webhooks/{subscriptionId}/replays": { "post": { "operationId": "createWebhookReplay", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-Request-ID", "in": "header", "required": false, "schema": { "type": "string", "maxLength": 64 } }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"r[0-9]+\"$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "security": [ { "oauth2": [ "events:read", "webhooks:write" ] } ], "responses": { "200": { "description": "Successful response" }, "201": { "description": "Resource created" }, "204": { "description": "Successful response with no body" }, "400": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Safe public error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-barakah-operation-class": "webhookReplay", "x-barakah-idempotency-required": true, "x-barakah-precondition-required": true } } }, "components": { "securitySchemes": { "oauth2": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://mcp.barakahtasks.com/authorize", "tokenUrl": "https://mcp.barakahtasks.com/oauth/token", "scopes": { "tasks:read": "Read Tasks and related resources", "tasks:write": "Create and update Tasks", "tasks:delete": "Delete and restore Tasks", "categories:read": "Read Lists", "categories:write": "Manage Lists", "collaborators:read": "Read accepted List members", "tags:read": "Read tags", "tags:write": "Manage tags", "comments:read": "Read flat task comments", "comments:write": "Post flat task comments", "attachments:read": "Read attachment metadata", "attachments:write": "Upload attachments", "settings:read": "Read settings", "settings:write": "Update settings", "prayer:read": "Read prayer times", "events:read": "Read retained CloudEvents", "webhooks:read": "Read webhook configuration and history", "webhooks:write": "Manage webhooks, gaps, and replay" } } } } }, "schemas": { "Error": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "details": { "type": "array", "items": { "type": "object" } } } } } }, "CloudEvent": { "type": "object", "required": [ "specversion", "id", "source", "type", "subject", "time", "datacontenttype", "barakahsequence", "barakahpublishedat", "data" ], "properties": { "specversion": { "const": "1.0" }, "id": { "type": "string" }, "source": { "const": "https://api.barakahtasks.com/events" }, "type": { "type": "string" }, "subject": { "type": "string" }, "time": { "type": "string", "format": "date-time" }, "datacontenttype": { "const": "application/json" }, "barakahsequence": { "type": "integer", "minimum": 1 }, "barakahpublishedat": { "type": "string", "format": "date-time" }, "data": { "type": "object" } }, "additionalProperties": true } } }, "x-barakah-contract": { "comments": "flat", "events": "CloudEvents 1.0 structured JSON", "event_authorization": "immutable owner plus current connection, scopes, and entitlement", "event_cursor": "last observed publication sequence; no fixed high-water", "ordinary_cursor": "fixed insertion-sequence high-water; not a snapshot", "rate_charging": "one unit after valid connection identification, including denials, replays, and post-acquisition failures" } }