{ "openapi": "3.0.0", "info": { "title": "UpFlow Public API", "version": "1.0.0" }, "components": { "schemas": { "PublicMessageCatalog": { "type": "object", "properties": { "version": { "type": "string", "minLength": 1 }, "locale": { "type": "string", "enum": ["ja"] }, "messages": { "type": "object", "additionalProperties": { "type": "string" } }, "httpStatusMessageIds": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": ["version", "locale", "messages", "httpStatusMessageIds"], "additionalProperties": false }, "PublicErrorEnvelope": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "VALIDATION_ERROR", "INVALID_CURSOR", "METHOD_NOT_ALLOWED", "AUTHENTICATION_REQUIRED", "INVALID_CREDENTIAL", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "IDEMPOTENCY_KEY_REUSED", "PRECONDITION_FAILED", "PAYLOAD_TOO_LARGE", "UNPROCESSABLE_ENTITY", "RATE_LIMITED", "SINGLE_PENDING", "INTERNAL_ERROR", "BAD_GATEWAY", "SERVICE_UNAVAILABLE", "GATEWAY_TIMEOUT", "PRECONDITION_REQUIRED" ] }, "messageId": { "type": "string", "enum": [ "EU00001", "EU00002", "EU00003", "EU00004", "EU00005", "EU00006", "EU00007", "EU00008", "EU00009", "VU00001", "VU00002", "VU00003", "VU00004", "VU00005", "VU00006", "VU00007", "VU00008", "VU00009", "EU00055", "UI00001", "UI00002", "UI00003", "UI00004", "UI00005", "UI00006", "UI00007", "UI00008", "UI00009", "UI00010", "UI00011", "UI00012", "UI00013", "UI00014", "EU00010", "EU00011", "EU00012", "EU00013", "EU00014", "EU00015", "EU00016", "EU00017", "EU00018", "EU00019", "EU00020", "EU00021", "EU00022", "EU00023", "EU00024", "EU00025", "EU00026", "EU00027", "EU00028", "EU00029", "EU00030", "EU00031", "EU00032", "EU00033", "EU00034", "EU00035", "EU00036", "EU00037", "EU00038", "EU00039", "EU00040", "EU00041", "EU00042", "EU00043", "EU00044", "EU00045", "EU00046", "EU00047", "EU00048", "EU00049", "EU00050", "EU00051", "EU00052", "EU00053", "EU00054", "EU00056", "EU00057", "EU00058", "EU00059", "IU00001", "IU00002", "IU00003", "IU00004", "IU00005", "IU00006", "IU00007", "IU00008", "IU00009", "IU00010", "IU00011", "IU00012", "IU00013", "IU00014", "IU00015", "IU00016", "IU00017", "IU00018", "IU00019", "IU00020", "IU00021", "IU00022", "IU00023", "IU00024", "IU00025", "IU00026", "IU00027", "IU00028", "IU00029", "IU00030", "IU00031", "IU00032", "IU00033", "IU00034", "IU00035", "IU00036", "IU00037", "IU00038", "IU00039", "IU00040", "IU00041", "IU00042", "IU00043", "IU00044", "IU00045", "IU00046", "IU00047", "IU00048", "IU00049", "IU00050", "IU00051", "IU00052", "IU00053", "IU00054", "IU00055", "IU00056", "IU00057", "IU00058", "IU00059", "IU00060", "IU00061", "IU00062", "IU00063", "IU00064", "IU00065", "IU00066", "IU00067", "IU00068", "IU00069", "IU00070", "IU00071", "IU00072", "IU00073", "IU00074", "IU00075", "IU00076", "IU00077", "IU00078", "IU00079", "IU00080", "IU00081", "IU00082", "IU00083", "IU00084", "IU00085", "IU00086", "IU00087", "IU00088", "IU00089", "IU00090", "IU00091", "IU00092", "IU00093", "IU00094", "IU00095", "IU00096", "IU00097", "IU00098", "IU00099", "IU00100", "IU00101", "IU00102", "IU00103", "IU00104", "IU00105", "SU00001", "SU00002", "SU00003", "SU00004", "SU00005", "SU00006", "SU00007", "SU00008", "SU00009", "SU00010", "SU00011", "SU00012", "SU00013", "SU00014", "SU00015", "SU00016", "SU00017", "SU00018", "SU00019", "SU00020" ] }, "fieldErrors": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "pattern": "^(?:\\/(?:[^~/]|~[01])*)*$" }, "messageId": { "type": "string", "enum": [ "EU00001", "EU00002", "EU00003", "EU00004", "EU00005", "EU00006", "EU00007", "EU00008", "EU00009", "VU00001", "VU00002", "VU00003", "VU00004", "VU00005", "VU00006", "VU00007", "VU00008", "VU00009", "EU00055", "UI00001", "UI00002", "UI00003", "UI00004", "UI00005", "UI00006", "UI00007", "UI00008", "UI00009", "UI00010", "UI00011", "UI00012", "UI00013", "UI00014", "EU00010", "EU00011", "EU00012", "EU00013", "EU00014", "EU00015", "EU00016", "EU00017", "EU00018", "EU00019", "EU00020", "EU00021", "EU00022", "EU00023", "EU00024", "EU00025", "EU00026", "EU00027", "EU00028", "EU00029", "EU00030", "EU00031", "EU00032", "EU00033", "EU00034", "EU00035", "EU00036", "EU00037", "EU00038", "EU00039", "EU00040", "EU00041", "EU00042", "EU00043", "EU00044", "EU00045", "EU00046", "EU00047", "EU00048", "EU00049", "EU00050", "EU00051", "EU00052", "EU00053", "EU00054", "EU00056", "EU00057", "EU00058", "EU00059", "IU00001", "IU00002", "IU00003", "IU00004", "IU00005", "IU00006", "IU00007", "IU00008", "IU00009", "IU00010", "IU00011", "IU00012", "IU00013", "IU00014", "IU00015", "IU00016", "IU00017", "IU00018", "IU00019", "IU00020", "IU00021", "IU00022", "IU00023", "IU00024", "IU00025", "IU00026", "IU00027", "IU00028", "IU00029", "IU00030", "IU00031", "IU00032", "IU00033", "IU00034", "IU00035", "IU00036", "IU00037", "IU00038", "IU00039", "IU00040", "IU00041", "IU00042", "IU00043", "IU00044", "IU00045", "IU00046", "IU00047", "IU00048", "IU00049", "IU00050", "IU00051", "IU00052", "IU00053", "IU00054", "IU00055", "IU00056", "IU00057", "IU00058", "IU00059", "IU00060", "IU00061", "IU00062", "IU00063", "IU00064", "IU00065", "IU00066", "IU00067", "IU00068", "IU00069", "IU00070", "IU00071", "IU00072", "IU00073", "IU00074", "IU00075", "IU00076", "IU00077", "IU00078", "IU00079", "IU00080", "IU00081", "IU00082", "IU00083", "IU00084", "IU00085", "IU00086", "IU00087", "IU00088", "IU00089", "IU00090", "IU00091", "IU00092", "IU00093", "IU00094", "IU00095", "IU00096", "IU00097", "IU00098", "IU00099", "IU00100", "IU00101", "IU00102", "IU00103", "IU00104", "IU00105", "SU00001", "SU00002", "SU00003", "SU00004", "SU00005", "SU00006", "SU00007", "SU00008", "SU00009", "SU00010", "SU00011", "SU00012", "SU00013", "SU00014", "SU00015", "SU00016", "SU00017", "SU00018", "SU00019", "SU00020" ] }, "args": { "type": "array", "items": { "type": "string" } } }, "required": ["path", "messageId"], "additionalProperties": false } } }, "required": ["code", "messageId"], "additionalProperties": false }, "PublicFormField": { "oneOf": [ { "type": "object", "additionalProperties": false, "required": ["type", "key", "label"], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "type": "object", "additionalProperties": false, "required": ["field", "equals"], "properties": { "field": { "type": "string", "minLength": 1 }, "equals": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "type": { "type": "string", "enum": ["text"] }, "maxLength": { "type": "integer", "minimum": 1 }, "pattern": { "type": "string" }, "defaultValueSource": { "type": "string", "minLength": 1 } } }, { "type": "object", "additionalProperties": false, "required": ["type", "key", "label"], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "type": "object", "additionalProperties": false, "required": ["field", "equals"], "properties": { "field": { "type": "string", "minLength": 1 }, "equals": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "type": { "type": "string", "enum": ["textarea"] }, "maxLength": { "type": "integer", "minimum": 1 } } }, { "type": "object", "additionalProperties": false, "required": ["type", "key", "label"], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "type": "object", "additionalProperties": false, "required": ["field", "equals"], "properties": { "field": { "type": "string", "minLength": 1 }, "equals": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "type": { "type": "string", "enum": ["number"] }, "min": { "type": "number" }, "max": { "type": "number" } } }, { "type": "object", "additionalProperties": false, "required": ["type", "key", "label"], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "type": "object", "additionalProperties": false, "required": ["field", "equals"], "properties": { "field": { "type": "string", "minLength": 1 }, "equals": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "type": { "type": "string", "enum": ["money"] }, "min": { "type": "integer" } } }, { "type": "object", "additionalProperties": false, "required": ["type", "key", "label", "format"], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "type": "object", "additionalProperties": false, "required": ["field", "equals"], "properties": { "field": { "type": "string", "minLength": 1 }, "equals": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "type": { "type": "string", "enum": ["date"] }, "format": { "type": "string", "enum": ["YYYY-MM-DD", "YYYY-MM"] }, "defaultToday": { "type": "boolean" } } }, { "type": "object", "additionalProperties": false, "required": ["type", "key", "label"], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "type": "object", "additionalProperties": false, "required": ["field", "equals"], "properties": { "field": { "type": "string", "minLength": 1 }, "equals": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "type": { "type": "string", "enum": ["time"] } } }, { "type": "object", "additionalProperties": false, "required": ["type", "key", "label"], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "type": "object", "additionalProperties": false, "required": ["field", "equals"], "properties": { "field": { "type": "string", "minLength": 1 }, "equals": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "type": { "type": "string", "enum": ["postal"] } } }, { "type": "object", "additionalProperties": false, "required": ["type", "key", "label", "options"], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "type": "object", "additionalProperties": false, "required": ["field", "equals"], "properties": { "field": { "type": "string", "minLength": 1 }, "equals": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "type": { "type": "string", "enum": ["select"] }, "options": { "type": "array", "minItems": 1, "items": { "type": "object", "additionalProperties": false, "required": ["value", "label"], "properties": { "value": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 } } } }, "optionsSource": { "type": "string", "minLength": 1 }, "optionsQuery": { "type": "object", "additionalProperties": false, "required": ["source", "labelColumn", "valueColumn", "orderColumn"], "properties": { "source": { "type": "string", "minLength": 1 }, "labelColumn": { "type": "string", "minLength": 1 }, "valueColumn": { "type": "string", "minLength": 1 }, "orderColumn": { "type": "string", "minLength": 1 }, "enabledOnly": { "type": "boolean" } } }, "creatable": { "type": "boolean" }, "defaultValue": { "type": "string", "minLength": 1 }, "defaultValueSource": { "type": "string", "minLength": 1 } } }, { "type": "object", "additionalProperties": false, "required": ["type", "key", "label", "options"], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "type": "object", "additionalProperties": false, "required": ["field", "equals"], "properties": { "field": { "type": "string", "minLength": 1 }, "equals": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "type": { "type": "string", "enum": ["multiselect"] }, "options": { "type": "array", "minItems": 1, "items": { "type": "object", "additionalProperties": false, "required": ["value", "label"], "properties": { "value": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 } } } }, "optionsSource": { "type": "string", "minLength": 1 }, "optionsQuery": { "type": "object", "additionalProperties": false, "required": ["source", "labelColumn", "valueColumn", "orderColumn"], "properties": { "source": { "type": "string", "minLength": 1 }, "labelColumn": { "type": "string", "minLength": 1 }, "valueColumn": { "type": "string", "minLength": 1 }, "orderColumn": { "type": "string", "minLength": 1 }, "enabledOnly": { "type": "boolean" } } } } }, { "type": "object", "additionalProperties": false, "required": ["type", "key", "label"], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "type": "object", "additionalProperties": false, "required": ["field", "equals"], "properties": { "field": { "type": "string", "minLength": 1 }, "equals": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "type": { "type": "string", "enum": ["checkbox"] }, "mustBeTrue": { "type": "boolean" } } }, { "type": "object", "additionalProperties": false, "required": ["type", "key", "label"], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "type": "object", "additionalProperties": false, "required": ["field", "equals"], "properties": { "field": { "type": "string", "minLength": 1 }, "equals": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "type": { "type": "string", "enum": ["file"] }, "multiple": { "type": "boolean" }, "accept": { "type": "string" }, "maxBytes": { "type": "integer", "minimum": 1 } } }, { "type": "object", "additionalProperties": false, "required": ["type", "key", "label", "fields"], "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "label": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" }, "pii": { "type": "boolean" }, "hidden": { "type": "boolean" }, "help": { "type": "string" }, "effects": { "type": "array", "items": { "type": "object" } }, "requiredWhen": { "type": "object", "additionalProperties": false, "required": ["field", "equals"], "properties": { "field": { "type": "string", "minLength": 1 }, "equals": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } }, "type": { "type": "string", "enum": ["group"] }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/PublicFormField" } }, "maxItems": { "type": "integer", "minimum": 1 }, "readOnly": { "type": "boolean" }, "removalTracking": { "type": "object", "additionalProperties": false, "required": ["target"], "properties": { "target": { "type": "string", "minLength": 1 }, "idKey": { "type": "string", "minLength": 1 }, "carry": { "type": "array", "items": { "type": "string", "minLength": 1 } } } }, "rowIdentityKey": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "defaultValueSource": { "type": "string", "minLength": 1 }, "persistedEditableKeys": { "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" } } } } ] }, "PublicFormSchema": { "type": "object", "properties": { "applicant": { "type": "object", "properties": { "sections": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" }, "title": { "type": "string", "minLength": 1 }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/PublicFormField" } } }, "required": ["key", "title", "fields"], "additionalProperties": false } } }, "required": ["sections"], "additionalProperties": false }, "nodeForms": { "type": "object", "additionalProperties": { "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/components/schemas/PublicFormField" } } }, "required": ["fields"], "additionalProperties": false } }, "rules": { "type": "string", "minLength": 1 } }, "required": ["applicant", "nodeForms", "rules"], "additionalProperties": false }, "PublicApplicationType": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "category": { "type": "string", "enum": ["HR", "GA", "SALES"] }, "formSchema": { "$ref": "#/components/schemas/PublicFormSchema" }, "initiationType": { "type": "string", "enum": ["USER", "BUSINESS_SCREEN"] }, "mode": { "type": "string", "enum": ["STANDARD", "IMMEDIATE"] } }, "required": ["code", "name", "category", "formSchema"], "additionalProperties": false }, "PublicApplicationTarget": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 } }, "required": ["id", "label"], "additionalProperties": false }, "PublicImmediateExecutionResponse": { "type": "object", "properties": { "outcome": { "type": "string", "enum": ["COMPLETED"] }, "application": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "serialNo": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": ["APPROVED"] }, "completedAt": { "type": "string", "format": "date-time" } }, "required": ["id", "serialNo", "status", "completedAt"] } }, "required": ["outcome", "application"], "additionalProperties": false }, "PublicImmediateExecutionRequest": { "type": "object", "properties": { "executionId": { "type": "string", "minLength": 1, "maxLength": 60 }, "expectedFlowDefinitionId": { "type": "string", "minLength": 1 }, "data": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": ["executionId", "expectedFlowDefinitionId", "data"], "additionalProperties": false }, "PublicImmediateExecutionMultipart": { "type": "object", "properties": { "payload": { "type": "string", "minLength": 1 } }, "required": ["payload"] }, "PublicApplicationTargetDetail": { "type": "object", "properties": { "applicationType": { "type": "string", "minLength": 1 }, "targetId": { "type": "string", "minLength": 1 }, "data": { "type": "object", "additionalProperties": { "nullable": true } }, "editableKeys": { "type": "array", "items": { "type": "string" } }, "revision": { "type": "string", "minLength": 1 } }, "required": ["applicationType", "targetId", "data", "editableKeys", "revision"], "additionalProperties": false }, "PublicFormOption": { "type": "object", "properties": { "value": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 } }, "required": ["value", "label"], "additionalProperties": false }, "PublicFieldEffectValues": { "type": "object", "properties": { "values": { "type": "object", "additionalProperties": { "nullable": true } }, "revision": { "type": "string", "minLength": 1 } }, "required": ["values", "revision"], "additionalProperties": false }, "PublicApplicationTypeInitiation": { "oneOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": ["STANDARD"] }, "flowDefinitionId": { "type": "string", "minLength": 1 }, "formSchema": { "$ref": "#/components/schemas/PublicFormSchema" } }, "required": ["mode", "flowDefinitionId", "formSchema"], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "enum": ["IMMEDIATE"] }, "flowDefinitionId": { "type": "string", "minLength": 1 }, "capabilityKey": { "type": "string", "minLength": 1 }, "actionLabel": { "type": "string", "minLength": 1 }, "formSchema": { "$ref": "#/components/schemas/PublicFormSchema" } }, "required": ["mode", "flowDefinitionId", "capabilityKey", "actionLabel", "formSchema"], "additionalProperties": false } ] }, "PublicApplicationSummary": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "serialNo": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "applicationType": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "BLOCKED", "SENT_BACK", "REJECTED", "APPROVED", "WITHDRAWN" ] }, "approvalMode": { "type": "string", "enum": ["IMMEDIATE", "WORKFLOW"] }, "submittedAt": { "type": "string", "nullable": true, "format": "date-time" }, "completedAt": { "type": "string", "nullable": true, "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "serialNo", "title", "applicationType", "status", "approvalMode", "submittedAt", "completedAt", "createdAt", "updatedAt" ], "additionalProperties": false }, "PublicApplicationRuntimeView": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "serialNo": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "BLOCKED", "SENT_BACK", "REJECTED", "APPROVED", "WITHDRAWN" ] }, "approvalMode": { "type": "string", "enum": ["IMMEDIATE", "WORKFLOW"] }, "applicationType": { "type": "string", "minLength": 1 }, "data": { "type": "object", "additionalProperties": { "nullable": true } }, "targets": { "type": "array", "items": { "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "resourceId": { "type": "string", "minLength": 1 }, "relation": { "type": "string", "minLength": 1 }, "isProvisional": { "type": "boolean" } }, "required": ["resourceType", "resourceId", "relation", "isProvisional"] } }, "formSchema": { "$ref": "#/components/schemas/PublicFormSchema" }, "currentNodeKey": { "type": "string" }, "currentTaskId": { "type": "string", "minLength": 1 }, "currentNodeForm": { "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/components/schemas/PublicFormField" } } }, "required": ["fields"], "additionalProperties": false }, "currentNodeType": { "type": "string", "enum": ["APPROVAL", "INPUT", "APPROVAL_WITH_INPUT", "TASK", "AWAIT", "NOTIFY"] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "submittedAt": { "type": "string", "nullable": true, "format": "date-time" }, "availableActions": { "type": "array", "items": { "type": "string", "enum": [ "withdraw", "approve", "sendBack", "reject", "reapply", "edit", "discard", "submitInput", "provideInput" ] } }, "lastComment": { "type": "string" }, "taskInputs": { "type": "array", "items": { "type": "object", "properties": { "formKey": { "type": "string" }, "nodeKey": { "type": "string", "minLength": 1 }, "taskName": { "type": "string", "minLength": 1 }, "actorName": { "type": "string", "nullable": true }, "actedAt": { "type": "string", "format": "date-time" }, "inputData": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": ["nodeKey", "taskName", "actorName", "actedAt", "inputData"] } } }, "required": [ "id", "serialNo", "title", "status", "approvalMode", "applicationType", "data", "targets", "formSchema", "createdAt", "updatedAt", "submittedAt", "availableActions" ], "additionalProperties": false }, "PublicApplicationSummaryCounts": { "type": "object", "properties": { "approvalMode": { "type": "string", "enum": ["WORKFLOW"] }, "draft": { "type": "integer", "minimum": 0 }, "inReview": { "type": "integer", "minimum": 0 }, "sentBack": { "type": "integer", "minimum": 0 }, "approvedThisMonth": { "type": "integer", "minimum": 0 } }, "required": ["approvalMode", "draft", "inReview", "sentBack", "approvedThisMonth"], "additionalProperties": false }, "PublicUpcomingApproval": { "type": "object", "properties": { "applicationId": { "type": "string", "minLength": 1 }, "serialNo": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "status": { "type": "string", "enum": ["PENDING", "SENT_BACK"] }, "applicantId": { "type": "string", "minLength": 1 }, "applicantName": { "type": "string" }, "submittedAt": { "type": "string", "nullable": true, "format": "date-time" }, "nodeKey": { "type": "string", "minLength": 1 }, "nodeName": { "type": "string", "minLength": 1 }, "canOpenDetail": { "type": "boolean" } }, "required": [ "applicationId", "serialNo", "title", "status", "applicantId", "applicantName", "submittedAt", "nodeKey", "nodeName", "canOpenDetail" ], "additionalProperties": false }, "PublicNotificationSummary": { "type": "object", "properties": { "sentBack": { "type": "integer", "minimum": 0 }, "pendingApproval": { "type": "integer", "minimum": 0 }, "completedUnread": { "type": "integer", "minimum": 0 } }, "required": ["sentBack", "pendingApproval", "completedUnread"], "additionalProperties": false }, "PublicApplicationEvents": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SUBMITTED", "APPROVED", "SENT_BACK", "REJECTED", "WITHDRAWN", "COMMENTED", "TASK_INPUT", "REAPPLIED", "RECOVERED", "BLOCKED", "SKIPPED", "CHILDREN_SELECTED", "CHILD_FIRED", "CHILD_COMPLETED", "AWAIT_SATISFIED", "AWAIT_ESCALATED", "PARENT_CANCELLED", "INPUT_REQUIRED", "INPUT_SUBMITTED", "CREATED", "DRAFT_UPDATED" ] }, "actorName": { "type": "string", "nullable": true }, "isOwn": { "type": "boolean" }, "comment": { "type": "string" }, "occurredAt": { "type": "string", "format": "date-time" } }, "required": ["type", "actorName", "isOwn", "occurredAt"] } } }, "required": ["events"], "additionalProperties": false }, "PublicApplicationFlow": { "type": "object", "properties": { "steps": { "type": "array", "items": { "type": "object", "properties": { "nodeKey": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "approval", "approval_with_input", "input", "task", "await", "notify", "terminal" ] }, "status": { "type": "string", "enum": [ "approved", "current", "pending", "skipped", "blocked", "rejected", "sentBack" ] }, "assigneeName": { "type": "string", "nullable": true }, "actedAt": { "type": "string", "format": "date-time" }, "linkedApplicationId": { "type": "string", "minLength": 1 } }, "required": ["nodeKey", "name", "kind", "status", "assigneeName"], "additionalProperties": false } } }, "required": ["steps"], "additionalProperties": false }, "PublicCreateApplicationRequest": { "type": "object", "properties": { "applicationType": { "type": "string", "minLength": 1 }, "data": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": ["applicationType", "data"], "additionalProperties": false }, "PublicApprovalTask": { "type": "object", "nullable": true, "properties": { "id": { "type": "string", "minLength": 1 }, "applicationId": { "type": "string", "minLength": 1 }, "nodeKey": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": ["APPROVAL", "INPUT", "APPROVAL_WITH_INPUT", "TASK", "AWAIT", "NOTIFY"] }, "createdAt": { "type": "string", "format": "date-time" }, "inputSchema": { "nullable": true }, "availableActions": { "type": "array", "items": { "type": "string", "enum": ["approve", "reject", "sendBack"] } } }, "required": [ "id", "applicationId", "nodeKey", "name", "type", "createdAt", "availableActions" ], "additionalProperties": false }, "PublicApplication": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "serialNo": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "applicationType": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "BLOCKED", "SENT_BACK", "REJECTED", "APPROVED", "WITHDRAWN" ] }, "approvalMode": { "type": "string", "enum": ["IMMEDIATE", "WORKFLOW"] }, "submittedAt": { "type": "string", "nullable": true, "format": "date-time" }, "completedAt": { "type": "string", "nullable": true, "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "data": { "type": "object", "additionalProperties": { "nullable": true } }, "formSchema": { "$ref": "#/components/schemas/PublicFormSchema" }, "currentTask": { "$ref": "#/components/schemas/PublicApprovalTask" }, "availableActions": { "type": "array", "items": { "type": "string", "enum": ["update", "delete", "submit", "withdraw", "reapply"] } } }, "required": [ "id", "serialNo", "title", "applicationType", "status", "approvalMode", "submittedAt", "completedAt", "createdAt", "updatedAt", "data", "formSchema", "currentTask", "availableActions" ], "additionalProperties": false }, "PublicUpdateApplicationRequest": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": ["data"], "additionalProperties": false }, "PublicReapplyApplicationRequest": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "nullable": true } }, "comment": { "type": "string", "minLength": 1 } }, "additionalProperties": false }, "PublicApplicationHistoryItem": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "SUBMITTED", "APPROVED", "SENT_BACK", "REJECTED", "WITHDRAWN", "COMMENTED", "TASK_INPUT", "REAPPLIED", "RECOVERED", "BLOCKED", "SKIPPED", "CHILDREN_SELECTED", "CHILD_FIRED", "CHILD_COMPLETED", "AWAIT_SATISFIED", "AWAIT_ESCALATED", "PARENT_CANCELLED", "INPUT_REQUIRED", "INPUT_SUBMITTED", "CREATED", "DRAFT_UPDATED" ] }, "actorName": { "type": "string", "nullable": true }, "comment": { "type": "string" }, "occurredAt": { "type": "string", "format": "date-time" } }, "required": ["id", "type", "actorName", "occurredAt"], "additionalProperties": false }, "PublicSendBackTarget": { "type": "object", "properties": { "nodeKey": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 } }, "required": ["nodeKey", "label"], "additionalProperties": false }, "PublicApproveTaskRequest": { "type": "object", "properties": { "inputData": { "type": "object", "additionalProperties": { "nullable": true } } }, "additionalProperties": false }, "PublicRejectTaskRequest": { "type": "object", "properties": { "comment": { "type": "string", "minLength": 1 } }, "required": ["comment"], "additionalProperties": false }, "PublicSendBackTaskRequest": { "type": "object", "properties": { "toNodeKey": { "type": "string", "minLength": 1 }, "comment": { "type": "string", "minLength": 1 } }, "required": ["toNodeKey", "comment"], "additionalProperties": false }, "PublicApplicationComment": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "body": { "type": "string", "nullable": true }, "authorId": { "type": "string", "minLength": 1 }, "authorName": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "version": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "deletedAt": { "type": "string", "nullable": true }, "isOwn": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" } }, "required": [ "id", "body", "authorId", "authorName", "createdAt", "updatedAt", "version", "deletedAt", "isOwn", "canEdit", "canDelete" ], "additionalProperties": false }, "PublicPostApplicationComment": { "type": "object", "properties": { "body": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": ["body"], "additionalProperties": false }, "PublicUpdateApplicationComment": { "type": "object", "properties": { "body": { "type": "string", "minLength": 1, "maxLength": 2000 }, "expectedVersion": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } }, "required": ["body", "expectedVersion"], "additionalProperties": false }, "PublicApplicationInput": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "nullable": true } }, "inputData": { "type": "object", "additionalProperties": { "nullable": true } }, "comment": { "type": "string" } }, "additionalProperties": false }, "PublicApprovalInput": { "type": "object", "properties": { "inputData": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": ["inputData"], "additionalProperties": false }, "PublicAttachment": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "fieldKey": { "type": "string", "minLength": 1 }, "fileName": { "type": "string", "minLength": 1 }, "mimeType": { "type": "string", "minLength": 1 }, "sizeBytes": { "type": "integer", "minimum": 0 }, "taskId": { "type": "string", "nullable": true, "minLength": 1 }, "createdAt": { "type": "string", "format": "date-time" } }, "required": ["id", "fieldKey", "fileName", "mimeType", "sizeBytes", "createdAt"], "additionalProperties": false }, "PublicMe": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "email": { "type": "string" }, "sei": { "type": "string" }, "mei": { "type": "string", "nullable": true } }, "required": ["id", "organizationId", "email", "sei", "mei"], "additionalProperties": false }, "availableOperations": { "type": "array", "items": { "type": "string" } } }, "required": ["user", "availableOperations"], "additionalProperties": false }, "PublicNotification": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "title": { "type": "string" }, "body": { "type": "string", "nullable": true }, "applicationId": { "type": "string", "nullable": true }, "approvalMode": { "type": "string", "nullable": true, "enum": ["IMMEDIATE", "WORKFLOW"] }, "isRead": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "readAt": { "type": "string", "nullable": true, "format": "date-time" } }, "required": [ "id", "kind", "title", "body", "applicationId", "approvalMode", "isRead", "createdAt", "readAt" ], "additionalProperties": false }, "PublicNotificationPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicNotification" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicDepartment": { "type": "object", "properties": { "id": { "type": "string" }, "parentId": { "type": "string", "nullable": true }, "code": { "type": "string" }, "name": { "type": "string" }, "sortOrder": { "type": "integer" } }, "required": ["id", "parentId", "code", "name", "sortOrder"], "additionalProperties": false }, "PublicDepartmentPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicDepartment" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicPosition": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "rank": { "type": "integer" } }, "required": ["id", "code", "name", "rank"], "additionalProperties": false }, "PublicPositionPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicPosition" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicEmployeeSummary": { "type": "object", "properties": { "id": { "type": "string" }, "sei": { "type": "string" }, "mei": { "type": "string", "nullable": true }, "seiKana": { "type": "string", "nullable": true }, "meiKana": { "type": "string", "nullable": true }, "seiAlphabet": { "type": "string", "nullable": true }, "meiAlphabet": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": ["ACTIVE", "ON_LEAVE", "PENDING_RETIREMENT", "RETIRED"] }, "personType": { "type": "string", "enum": ["EMPLOYEE", "BP_MEMBER"] }, "company": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, "position": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, "departments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "path": { "type": "string" }, "isLead": { "type": "boolean" } }, "required": ["id", "path", "isLead"], "additionalProperties": false } } }, "required": [ "id", "sei", "mei", "seiKana", "meiKana", "seiAlphabet", "meiAlphabet", "status", "personType", "company", "position", "departments" ], "additionalProperties": false }, "PublicEmployeePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicEmployeeSummary" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicEmployeeDetail": { "type": "object", "properties": { "employeeId": { "type": "string" }, "values": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": ["employeeId", "values"], "additionalProperties": false }, "PublicEmployeeField": { "type": "object", "properties": { "key": { "type": "string" }, "valueType": { "type": "string", "enum": ["string", "date", "enum", "object"] }, "cardinality": { "type": "string", "enum": ["one", "many"] }, "nullable": { "type": "boolean" }, "pii": { "type": "boolean" }, "display": { "type": "object", "properties": { "label": { "type": "string" }, "group": { "type": "string" }, "order": { "type": "integer" } }, "required": ["label", "group", "order"], "additionalProperties": false } }, "required": ["key", "valueType", "cardinality", "nullable", "pii", "display"], "additionalProperties": false }, "PublicEmployeeFieldCatalog": { "type": "object", "properties": { "version": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "order": { "type": "integer" } }, "required": ["key", "label", "order"], "additionalProperties": false } }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/PublicEmployeeField" } } }, "required": ["version", "groups", "fields"], "additionalProperties": false }, "PublicOrganizationChartDepartment": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "parentId": { "type": "string", "nullable": true }, "sortOrder": { "type": "integer" } }, "required": ["id", "name", "parentId", "sortOrder"], "additionalProperties": false }, "PublicOrganizationChartDepartmentPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicOrganizationChartDepartment" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicOrganizationChartMember": { "type": "object", "properties": { "id": { "type": "string" }, "sei": { "type": "string" }, "mei": { "type": "string", "nullable": true }, "seiKana": { "type": "string", "nullable": true }, "meiKana": { "type": "string", "nullable": true }, "seiAlphabet": { "type": "string", "nullable": true }, "meiAlphabet": { "type": "string", "nullable": true }, "positionName": { "type": "string", "nullable": true }, "departmentIds": { "type": "array", "items": { "type": "string" } }, "leadDepartmentIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "sei", "mei", "seiKana", "meiKana", "seiAlphabet", "meiAlphabet", "positionName", "departmentIds", "leadDepartmentIds" ], "additionalProperties": false }, "PublicOrganizationChartMemberPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicOrganizationChartMember" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicProject": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "clientName": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "endDate": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": ["ACTIVE", "CLOSED"] } }, "required": ["id", "name", "clientName", "startDate", "endDate", "status"], "additionalProperties": false }, "PublicProjectPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicProject" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicProjectCustomerLoan": { "type": "object", "properties": { "id": { "type": "string" }, "equipmentId": { "type": "string" }, "equipmentName": { "type": "string" }, "lentOn": { "type": "string" }, "dueOn": { "type": "string", "nullable": true }, "returnedOn": { "type": "string", "nullable": true } }, "required": ["id", "equipmentId", "equipmentName", "lentOn", "dueOn", "returnedOn"], "additionalProperties": false }, "PublicProjectCustomerLoanAssignment": { "type": "object", "properties": { "assignmentId": { "type": "string" }, "userId": { "type": "string" }, "userName": { "type": "string" }, "status": { "type": "string", "enum": ["ACTIVE", "LEFT"] }, "lendings": { "type": "array", "items": { "$ref": "#/components/schemas/PublicProjectCustomerLoan" } } }, "required": ["assignmentId", "userId", "userName", "status", "lendings"], "additionalProperties": false }, "PublicProjectCustomerLoans": { "type": "object", "properties": { "projectId": { "type": "string" }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/PublicProjectCustomerLoanAssignment" } }, "availableEquipment": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } } }, "required": ["projectId", "assignments", "availableEquipment"], "additionalProperties": false }, "PublicOffice": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "postalCode": { "type": "string", "nullable": true }, "prefecture": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "otherAddress": { "type": "string", "nullable": true }, "building": { "type": "string", "nullable": true } }, "required": [ "id", "code", "name", "postalCode", "prefecture", "city", "otherAddress", "building" ], "additionalProperties": false }, "PublicOfficePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicOffice" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicWorkingHours": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "breakStartTime": { "type": "string", "nullable": true }, "breakEndTime": { "type": "string", "nullable": true }, "workingMinutes": { "type": "integer" }, "breakMinutes": { "type": "integer" } }, "required": [ "id", "name", "startTime", "endTime", "breakStartTime", "breakEndTime", "workingMinutes", "breakMinutes" ], "additionalProperties": false }, "PublicWorkingHoursPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicWorkingHours" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicExpense": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "accountTitle": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 } }, "required": ["id", "name"], "additionalProperties": false }, "subAccountTitle": { "type": "object", "nullable": true, "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 } }, "required": ["id", "name"], "additionalProperties": false } }, "required": ["id", "name", "accountTitle", "subAccountTitle"], "additionalProperties": false }, "PublicExpensePage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicExpense" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicInternalAnnouncement": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "body": { "type": "string" }, "publishedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "nullable": true, "format": "date-time" } }, "required": ["id", "title", "body", "publishedAt", "expiresAt"], "additionalProperties": false }, "PublicInternalAnnouncementPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicInternalAnnouncement" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicEquipment": { "type": "object", "properties": { "category": { "type": "string", "enum": ["SMARTPHONE", "TABLET", "COMPUTER", "SIM", "KEY", "OTHER"] }, "productName": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "managementNo": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 128 }, "source": { "type": "string", "enum": ["PURCHASED", "CLIENT_LOAN"] }, "clientDedicated": { "type": "boolean" }, "remarks": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 2000 }, "id": { "type": "string" }, "company": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, "status": { "type": "string", "enum": ["IN_STOCK", "LENT", "DELETED"] }, "currentHolder": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "sei": { "type": "string" }, "mei": { "type": "string", "nullable": true } }, "required": ["id", "sei", "mei"], "additionalProperties": false }, "lentUntil": { "type": "string", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "category", "productName", "name", "managementNo", "source", "clientDedicated", "remarks", "id", "company", "status", "currentHolder", "lentUntil", "createdAt", "updatedAt" ], "additionalProperties": false }, "PublicEquipmentPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicEquipment" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicEquipmentDetail": { "type": "object", "properties": { "category": { "type": "string", "enum": ["SMARTPHONE", "TABLET", "COMPUTER", "SIM", "KEY", "OTHER"] }, "productName": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "managementNo": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 128 }, "source": { "type": "string", "enum": ["PURCHASED", "CLIENT_LOAN"] }, "clientDedicated": { "type": "boolean" }, "remarks": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 2000 }, "id": { "type": "string" }, "company": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false }, "status": { "type": "string", "enum": ["IN_STOCK", "LENT", "DELETED"] }, "currentHolder": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "sei": { "type": "string" }, "mei": { "type": "string", "nullable": true } }, "required": ["id", "sei", "mei"], "additionalProperties": false }, "lentUntil": { "type": "string", "nullable": true, "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "originApplication": { "type": "object", "nullable": true, "properties": { "id": { "type": "string" }, "serialNo": { "type": "string" }, "title": { "type": "string" }, "typeName": { "type": "string" }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "BLOCKED", "SENT_BACK", "REJECTED", "APPROVED", "WITHDRAWN" ] }, "applicant": { "type": "object", "properties": { "id": { "type": "string" }, "sei": { "type": "string" }, "mei": { "type": "string", "nullable": true } }, "required": ["id", "sei", "mei"], "additionalProperties": false }, "completedAt": { "type": "string", "nullable": true, "format": "date-time" } }, "required": [ "id", "serialNo", "title", "typeName", "status", "applicant", "completedAt" ], "additionalProperties": false }, "canReadOriginApplication": { "type": "boolean" } }, "required": [ "category", "productName", "name", "managementNo", "source", "clientDedicated", "remarks", "id", "company", "status", "currentHolder", "lentUntil", "createdAt", "updatedAt", "originApplication", "canReadOriginApplication" ], "additionalProperties": false }, "PublicEquipmentLendingStatus": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string", "enum": ["SMARTPHONE", "TABLET", "COMPUTER", "SIM", "KEY", "OTHER"] }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": ["IN_STOCK", "LENT"] }, "dueAt": { "type": "string", "nullable": true } }, "required": ["category", "name", "status", "dueAt"] } } }, "required": ["items"], "additionalProperties": false }, "PublicCompany": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "shortName": { "type": "string", "nullable": true }, "nameKana": { "type": "string", "nullable": true }, "type": { "type": "string", "enum": ["CLIENT", "PARTNER"] }, "orderer": { "type": "boolean" }, "supplier": { "type": "boolean" }, "supplierType": { "type": "string", "nullable": true, "enum": ["SES", "AGENT_NEW_GRAD", "AGENT_MID_INEXPERIENCED", "AGENT_MID_EXPERIENCED"] }, "status": { "type": "string", "enum": ["ACTIVE", "INACTIVE"] } }, "required": [ "id", "code", "name", "shortName", "nameKana", "type", "orderer", "supplier", "supplierType", "status" ], "additionalProperties": false }, "PublicCompanyPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicCompany" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicCompanyDetail": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "shortName": { "type": "string", "nullable": true }, "nameKana": { "type": "string", "nullable": true }, "type": { "type": "string", "enum": ["CLIENT", "PARTNER"] }, "orderer": { "type": "boolean" }, "supplier": { "type": "boolean" }, "supplierType": { "type": "string", "nullable": true, "enum": ["SES", "AGENT_NEW_GRAD", "AGENT_MID_INEXPERIENCED", "AGENT_MID_EXPERIENCED"] }, "status": { "type": "string", "enum": ["ACTIVE", "INACTIVE"] }, "salesRepId": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "endDate": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "prefecture": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "otherAddress": { "type": "string", "nullable": true }, "building": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "remarks": { "type": "string", "nullable": true }, "toEmailAddress": { "type": "string", "nullable": true }, "ccEmailAddresses": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "methodOfSendingDocuments": { "type": "string", "nullable": true }, "tag": { "type": "string", "nullable": true }, "corporateNumber": { "type": "string", "nullable": true }, "invoiceNumber": { "type": "string", "nullable": true }, "codeForAccounting": { "type": "string", "nullable": true }, "nameForAccounting": { "type": "string", "nullable": true }, "bankCode": { "type": "string", "nullable": true }, "bankName": { "type": "string", "nullable": true }, "branchCode": { "type": "string", "nullable": true }, "branchName": { "type": "string", "nullable": true }, "ordererPaymentTerms": { "type": "string", "nullable": true }, "supplierPaymentTerms": { "type": "string", "nullable": true }, "supplierWithholdingTax": { "type": "string", "nullable": true }, "companyContacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "currentProfileApplicationId": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true }, "post": { "type": "string", "nullable": true }, "lastName": { "type": "string", "minLength": 1 }, "firstName": { "type": "string", "nullable": true }, "lastNameKana": { "type": "string", "nullable": true }, "firstNameKana": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email" }, "memo": { "type": "string", "nullable": true }, "businessCard": { "type": "object", "nullable": true, "properties": { "id": { "type": "string", "minLength": 1 }, "fieldKey": { "type": "string", "enum": ["businessCard", "profilePhoto"] }, "fileName": { "type": "string", "minLength": 1 }, "contentType": { "type": "string", "minLength": 1 }, "sizeBytes": { "type": "integer", "minimum": 0 }, "applicationId": { "type": "string" } }, "required": [ "id", "fieldKey", "fileName", "contentType", "sizeBytes", "applicationId" ], "additionalProperties": false }, "profilePhoto": { "type": "object", "nullable": true, "properties": { "id": { "type": "string", "minLength": 1 }, "fieldKey": { "type": "string", "enum": ["businessCard", "profilePhoto"] }, "fileName": { "type": "string", "minLength": 1 }, "contentType": { "type": "string", "minLength": 1 }, "sizeBytes": { "type": "integer", "minimum": 0 }, "applicationId": { "type": "string" } }, "required": [ "id", "fieldKey", "fileName", "contentType", "sizeBytes", "applicationId" ], "additionalProperties": false } }, "required": [ "id", "currentProfileApplicationId", "department", "post", "lastName", "firstName", "lastNameKana", "firstNameKana", "phoneNumber", "email", "memo", "businessCard", "profilePhoto" ], "additionalProperties": false } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "fieldKey": { "type": "string", "enum": ["ndaFile", "masterContract"] }, "fileName": { "type": "string", "minLength": 1 }, "contentType": { "type": "string", "minLength": 1 }, "sizeBytes": { "type": "integer", "minimum": 0 } }, "required": ["id", "fieldKey", "fileName", "contentType", "sizeBytes"], "additionalProperties": false } } }, "required": [ "id", "code", "name", "shortName", "nameKana", "type", "orderer", "supplier", "supplierType", "status", "salesRepId", "startDate", "endDate", "postalCode", "prefecture", "city", "otherAddress", "building", "phoneNumber", "remarks", "toEmailAddress", "ccEmailAddresses", "url", "methodOfSendingDocuments", "tag", "corporateNumber", "invoiceNumber", "codeForAccounting", "nameForAccounting", "bankCode", "bankName", "branchCode", "branchName", "ordererPaymentTerms", "supplierPaymentTerms", "supplierWithholdingTax", "companyContacts", "documents" ], "additionalProperties": false }, "PublicCompanyContactHistoryItem": { "type": "object", "properties": { "id": { "type": "string" }, "applicationId": { "type": "string" }, "serialNo": { "type": "string" }, "applicantName": { "type": "string" }, "completedAt": { "type": "string" }, "companyContacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "currentProfileApplicationId": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true }, "post": { "type": "string", "nullable": true }, "lastName": { "type": "string", "minLength": 1 }, "firstName": { "type": "string", "nullable": true }, "lastNameKana": { "type": "string", "nullable": true }, "firstNameKana": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email" }, "memo": { "type": "string", "nullable": true }, "businessCard": { "type": "object", "nullable": true, "properties": { "id": { "type": "string", "minLength": 1 }, "fieldKey": { "type": "string", "enum": ["businessCard", "profilePhoto"] }, "fileName": { "type": "string", "minLength": 1 }, "contentType": { "type": "string", "minLength": 1 }, "sizeBytes": { "type": "integer", "minimum": 0 }, "applicationId": { "type": "string" } }, "required": [ "id", "fieldKey", "fileName", "contentType", "sizeBytes", "applicationId" ], "additionalProperties": false }, "profilePhoto": { "type": "object", "nullable": true, "properties": { "id": { "type": "string", "minLength": 1 }, "fieldKey": { "type": "string", "enum": ["businessCard", "profilePhoto"] }, "fileName": { "type": "string", "minLength": 1 }, "contentType": { "type": "string", "minLength": 1 }, "sizeBytes": { "type": "integer", "minimum": 0 }, "applicationId": { "type": "string" } }, "required": [ "id", "fieldKey", "fileName", "contentType", "sizeBytes", "applicationId" ], "additionalProperties": false } }, "required": [ "id", "currentProfileApplicationId", "department", "post", "lastName", "firstName", "lastNameKana", "firstNameKana", "phoneNumber", "email", "memo", "businessCard", "profilePhoto" ], "additionalProperties": false } }, "removedCompanyContacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "lastName": { "type": "string", "default": "" }, "firstName": { "type": "string", "default": "" }, "lastNameKana": { "type": "string", "nullable": true }, "firstNameKana": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "memo": { "type": "string", "nullable": true }, "businessCard": { "type": "object", "nullable": true, "properties": { "id": { "type": "string", "minLength": 1 }, "fieldKey": { "type": "string", "enum": ["businessCard", "profilePhoto"] }, "fileName": { "type": "string", "minLength": 1 }, "contentType": { "type": "string", "minLength": 1 }, "sizeBytes": { "type": "integer", "minimum": 0 }, "applicationId": { "type": "string" } }, "required": [ "id", "fieldKey", "fileName", "contentType", "sizeBytes", "applicationId" ], "additionalProperties": false }, "profilePhoto": { "type": "object", "nullable": true, "properties": { "id": { "type": "string", "minLength": 1 }, "fieldKey": { "type": "string", "enum": ["businessCard", "profilePhoto"] }, "fileName": { "type": "string", "minLength": 1 }, "contentType": { "type": "string", "minLength": 1 }, "sizeBytes": { "type": "integer", "minimum": 0 }, "applicationId": { "type": "string" } }, "required": [ "id", "fieldKey", "fileName", "contentType", "sizeBytes", "applicationId" ], "additionalProperties": false } }, "required": ["id", "businessCard", "profilePhoto"], "additionalProperties": false } } }, "required": [ "id", "applicationId", "serialNo", "applicantName", "completedAt", "companyContacts", "removedCompanyContacts" ], "additionalProperties": false }, "PublicCompanyContactHistoryPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicCompanyContactHistoryItem" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicOfficeHistoryItem": { "type": "object", "properties": { "id": { "type": "string" }, "applicationId": { "type": "string" }, "serialNo": { "type": "string" }, "applicantName": { "type": "string" }, "completedAt": { "type": "string" }, "lifecycleAction": { "type": "string", "enum": ["ARCHIVED", "RESTORED"] }, "offices": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "postalCode": { "type": "string", "nullable": true }, "prefecture": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "otherAddress": { "type": "string", "nullable": true }, "building": { "type": "string", "nullable": true } }, "required": [ "id", "code", "name", "postalCode", "prefecture", "city", "otherAddress", "building" ], "additionalProperties": false } }, "removedOffices": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" } }, "required": ["id", "code", "name"], "additionalProperties": false } } }, "required": [ "id", "applicationId", "serialNo", "applicantName", "completedAt", "offices", "removedOffices" ], "additionalProperties": false }, "PublicOfficeHistoryPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicOfficeHistoryItem" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicWorkingHoursHistoryItem": { "type": "object", "properties": { "id": { "type": "string" }, "applicationId": { "type": "string" }, "serialNo": { "type": "string" }, "applicantName": { "type": "string" }, "completedAt": { "type": "string" }, "lifecycleAction": { "type": "string", "enum": ["ARCHIVED", "RESTORED"] }, "workingHours": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 21 }, "startTime": { "type": "string" }, "endTime": { "type": "string" }, "breakStartTime": { "type": "string", "nullable": true }, "breakEndTime": { "type": "string", "nullable": true }, "workingMinutes": { "type": "integer", "minimum": 0 }, "breakMinutes": { "type": "integer", "minimum": 0 } }, "required": [ "id", "name", "startTime", "endTime", "breakStartTime", "breakEndTime", "workingMinutes", "breakMinutes" ], "additionalProperties": false } }, "removedWorkingHours": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } } }, "required": [ "id", "applicationId", "serialNo", "applicantName", "completedAt", "workingHours", "removedWorkingHours" ], "additionalProperties": false }, "PublicWorkingHoursHistoryPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicWorkingHoursHistoryItem" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicEmployeeApplicationsPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "serialNo": { "type": "string", "minLength": 1 }, "title": { "type": "string" }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "BLOCKED", "SENT_BACK", "REJECTED", "APPROVED", "WITHDRAWN" ] }, "approvalMode": { "type": "string", "enum": ["IMMEDIATE", "WORKFLOW"] }, "updatedAt": { "type": "string", "format": "date-time" }, "submittedAt": { "type": "string", "nullable": true, "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "currentNodeName": { "type": "string", "nullable": true }, "targets": { "type": "array", "items": { "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1 }, "resourceId": { "type": "string", "minLength": 1 }, "relation": { "type": "string", "minLength": 1 }, "isProvisional": { "type": "boolean" } }, "required": ["resourceType", "resourceId", "relation", "isProvisional"] } } }, "required": [ "id", "serialNo", "title", "status", "approvalMode", "updatedAt", "submittedAt", "createdAt", "currentNodeName", "targets" ] } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false }, "availableTypes": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 } }, "required": ["code", "name"], "additionalProperties": false } } }, "required": ["items", "pageInfo", "availableTypes"], "additionalProperties": false }, "PublicManagerDescendants": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "sei": { "type": "string", "minLength": 1 }, "mei": { "type": "string", "nullable": true }, "seiKana": { "type": "string", "nullable": true }, "meiKana": { "type": "string", "nullable": true }, "seiAlphabet": { "type": "string", "nullable": true }, "meiAlphabet": { "type": "string", "nullable": true }, "positionName": { "type": "string" }, "depth": { "type": "integer", "minimum": 1 } }, "required": [ "id", "sei", "mei", "seiKana", "meiKana", "seiAlphabet", "meiAlphabet", "positionName", "depth" ], "additionalProperties": false } }, "truncated": { "type": "boolean" } }, "required": ["items", "truncated"], "additionalProperties": false }, "PublicManagerChain": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "sei": { "type": "string", "minLength": 1 }, "mei": { "type": "string", "nullable": true }, "seiKana": { "type": "string", "nullable": true }, "meiKana": { "type": "string", "nullable": true }, "seiAlphabet": { "type": "string", "nullable": true }, "meiAlphabet": { "type": "string", "nullable": true }, "positionName": { "type": "string" } }, "required": [ "id", "sei", "mei", "seiKana", "meiKana", "seiAlphabet", "meiAlphabet", "positionName" ] } } }, "required": ["items"], "additionalProperties": false }, "PublicQaInquiryPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "applicationId": { "type": "string" }, "question": { "type": "string" }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "BLOCKED", "SENT_BACK", "REJECTED", "APPROVED", "WITHDRAWN" ] }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": ["applicationId", "question", "status", "updatedAt"], "additionalProperties": false } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicQaStarterPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "question": { "type": "string" } }, "required": ["id", "question"], "additionalProperties": false } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicQaChatResponse": { "oneOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": ["answered"] }, "answer": { "type": "string" }, "weak": { "type": "boolean" }, "citations": { "type": "array", "items": { "type": "string" }, "maxItems": 3 }, "question": { "type": "string" }, "contextRefs": { "type": "array", "items": { "type": "string" } } }, "required": ["status", "answer", "weak", "citations", "question", "contextRefs"], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "enum": ["not_ready"] } }, "required": ["status"], "additionalProperties": false } ] }, "PublicQaChatRequest": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1, "maxLength": 2000 }, "starterId": { "type": "string" } }, "required": ["question"], "additionalProperties": false }, "PublicPostalAddress": { "type": "object", "properties": { "prefecture": { "type": "string" }, "city": { "type": "string" } }, "required": ["prefecture", "city"], "additionalProperties": false }, "PublicBank": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } }, "required": ["code", "name"], "additionalProperties": false }, "PublicBankPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicBank" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false }, "PublicQualification": { "type": "object", "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "defaultAllowance": { "type": "number", "nullable": true }, "defaultValidMonths": { "type": "integer", "nullable": true }, "isEnabled": { "type": "boolean" } }, "required": ["id", "code", "name", "defaultAllowance", "defaultValidMonths", "isEnabled"], "additionalProperties": false }, "PublicQualificationPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicQualification" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"], "additionalProperties": false } }, "required": ["items", "pageInfo"], "additionalProperties": false } }, "parameters": { "actingUser": { "name": "X-Acting-User", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1 }, "description": "Required when bearerAuth uses an organization service token." } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "UpFlow PAT or organization service token" } } }, "paths": { "/v1/messages": { "get": { "operationId": "getPublicV1Messages", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "reference:read", "responses": { "200": { "description": "Current public message catalog", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicMessageCatalog" } } } }, "304": { "description": "Catalog has not changed", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } } }, "401": { "description": "Authentication is missing or invalid", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Caller scope forbids catalog access", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } }, "parameters": [ { "$ref": "#/components/parameters/actingUser" } ] } }, "/v1/application-types": { "get": { "operationId": "listPublicV1ApplicationTypes", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application_type:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Eligible published application types", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicApplicationType" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"] } }, "required": ["items", "pageInfo"] } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/application-types/{applicationType}/targets": { "get": { "operationId": "searchPublicV1ApplicationTargets", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application_type:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationType", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "q", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Eligible application targets", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicApplicationTarget" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"] } }, "required": ["items", "pageInfo"] } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/application-types/{applicationType}/immediate-executions": { "post": { "operationId": "executePublicV1ImmediateApplication", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationType", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicImmediateExecutionRequest" } } } }, "responses": { "201": { "description": "Immediate application completed", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicImmediateExecutionResponse" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/application-types/{applicationType}/immediate-executions/multipart": { "post": { "operationId": "executePublicV1ImmediateApplicationMultipart", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationType", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PublicImmediateExecutionMultipart" } } } }, "responses": { "201": { "description": "Immediate application with files completed", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicImmediateExecutionResponse" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/application-types/{applicationType}/targets/{targetId}": { "get": { "operationId": "getPublicV1ApplicationTarget", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application_type:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationType", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "targetId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Application target snapshot", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationTargetDetail" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/application-types/{applicationType}/form-options": { "get": { "operationId": "searchPublicV1FormOptions", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application_type:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationType", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "fieldKey", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "q", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Application form options", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicFormOption" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"] } }, "required": ["items", "pageInfo"] } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/application-types/{applicationType}/field-effect-values/{targetId}": { "get": { "operationId": "getPublicV1FieldEffectValues", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application_type:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationType", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "targetId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Server-authoritative field effect values", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicFieldEffectValues" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/application-types/{applicationType}/initiation": { "get": { "operationId": "getPublicV1ApplicationTypeInitiation", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application_type:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationType", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Published application initiation descriptor available to the caller", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationTypeInitiation" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/application-types/{applicationType}/form": { "get": { "operationId": "getPublicV1ApplicationTypeFormGuide", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application_type:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationType", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Published application form available to the caller", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicFormSchema" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications": { "get": { "operationId": "listPublicV1Applications", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "enum": [ "DRAFT", "PENDING", "BLOCKED", "SENT_BACK", "REJECTED", "APPROVED", "WITHDRAWN" ] }, "required": false, "name": "status", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "q", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Applications visible to the caller", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicApplicationSummary" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"] } }, "required": ["items", "pageInfo"] } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } }, "post": { "operationId": "createPublicV1Application", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCreateApplicationRequest" } } } }, "responses": { "201": { "description": "Draft created", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationSummary" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/view": { "get": { "operationId": "getPublicV1ApplicationView", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "getPublicV1ApplicationView", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationRuntimeView" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/application-summary": { "get": { "operationId": "getPublicV1ApplicationSummary", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "responses": { "200": { "description": "Application status summary for the caller", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationSummaryCounts" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } }, "parameters": [ { "$ref": "#/components/parameters/actingUser" } ] } }, "/v1/upcoming-approvals": { "get": { "operationId": "listPublicV1UpcomingApprovals", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Approval tasks predicted to reach the caller", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicUpcomingApproval" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"] } }, "required": ["items", "pageInfo"] } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/notification-summary": { "get": { "operationId": "getPublicV1NotificationSummary", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "notification:read", "responses": { "200": { "description": "Unread workflow notification summary", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicNotificationSummary" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } }, "parameters": [ { "$ref": "#/components/parameters/actingUser" } ] } }, "/v1/applications/{applicationId}/events": { "get": { "operationId": "listPublicV1ApplicationEvents", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1ApplicationEvents", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationEvents" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/flow": { "get": { "operationId": "getPublicV1ApplicationFlow", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "getPublicV1ApplicationFlow", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationFlow" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}": { "get": { "operationId": "getPublicV1Application", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Application detail", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplication" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } }, "patch": { "operationId": "updatePublicV1Application", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicUpdateApplicationRequest" } } } }, "responses": { "200": { "description": "Draft updated", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationSummary" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } }, "delete": { "operationId": "deletePublicV1Application", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "204": { "description": "Mutation completed", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/submit": { "post": { "operationId": "submitPublicV1Application", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Application submitted", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationSummary" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/withdraw": { "post": { "operationId": "withdrawPublicV1Application", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "204": { "description": "Mutation completed", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/reapply": { "post": { "operationId": "reapplyPublicV1Application", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicReapplyApplicationRequest" } } } }, "responses": { "204": { "description": "Application reapplied", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/history": { "get": { "operationId": "listPublicV1ApplicationHistory", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Application history", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicApplicationHistoryItem" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"] } }, "required": ["items", "pageInfo"] } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/approval-tasks": { "get": { "operationId": "listPublicV1ApprovalTasks", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "enum": ["true"] }, "required": false, "name": "includeSummary", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Approval inbox", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicApprovalTask" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"] }, "summary": { "type": "object", "properties": { "upcoming": { "type": "integer", "minimum": 0 }, "pending": { "type": "integer", "minimum": 0 }, "sentBack": { "type": "integer", "minimum": 0 }, "approvedThisMonth": { "type": "integer", "minimum": 0 } }, "required": ["upcoming", "pending", "sentBack", "approvedThisMonth"], "additionalProperties": false } }, "required": ["items", "pageInfo"] } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/approval-tasks/{taskId}": { "get": { "operationId": "getPublicV1ApprovalTask", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "taskId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Approval task detail", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApprovalTask" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/approval-tasks/{taskId}/send-back-targets": { "get": { "operationId": "listPublicV1SendBackTargets", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "taskId", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Send-back targets", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicSendBackTarget" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"] } }, "required": ["items", "pageInfo"] } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/approval-tasks/{taskId}/approve": { "post": { "operationId": "approvePublicV1ApprovalTask", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:approve", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "taskId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApproveTaskRequest" } } } }, "responses": { "204": { "description": "Task mutation completed", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/approval-tasks/{taskId}/reject": { "post": { "operationId": "rejectPublicV1ApprovalTask", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:reject", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "taskId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicRejectTaskRequest" } } } }, "responses": { "204": { "description": "Task mutation completed", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/approval-tasks/{taskId}/send-back": { "post": { "operationId": "sendBackPublicV1ApprovalTask", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:sendback", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "taskId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicSendBackTaskRequest" } } } }, "responses": { "204": { "description": "Task mutation completed", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/comments": { "get": { "operationId": "listPublicV1ApplicationComments", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Application comments", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicApplicationComment" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"] } }, "required": ["items", "pageInfo"] } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } }, "post": { "operationId": "createPublicV1ApplicationComment", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPostApplicationComment" } } } }, "responses": { "201": { "description": "Application comment created", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationComment" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/comments/{commentId}": { "patch": { "operationId": "updatePublicV1ApplicationComment", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "commentId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicUpdateApplicationComment" } } } }, "responses": { "204": { "description": "Application comment updated", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } }, "delete": { "operationId": "deletePublicV1ApplicationComment", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "commentId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "204": { "description": "Application comment deleted", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/input": { "post": { "operationId": "submitPublicV1ApplicationInput", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApplicationInput" } } } }, "responses": { "204": { "description": "Applicant input submitted", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/submit-input": { "post": { "operationId": "submitPublicV1ApprovalInput", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:approve", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApprovalInput" } } } }, "responses": { "204": { "description": "Filler input submitted", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/attachments": { "post": { "operationId": "uploadPublicV1ApplicationAttachment", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "fieldKey": { "type": "string", "minLength": 1 }, "taskId": { "type": "string", "minLength": 1 }, "file": { "type": "string", "format": "binary" } }, "required": ["fieldKey", "file"], "additionalProperties": false } } } }, "responses": { "201": { "description": "Attachment uploaded", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicAttachment" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } }, "get": { "operationId": "listPublicV1ApplicationAttachments", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Application attachments", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PublicAttachment" } }, "pageInfo": { "type": "object", "properties": { "hasNext": { "type": "boolean" }, "nextCursor": { "type": "string", "nullable": true, "minLength": 1 } }, "required": ["hasNext", "nextCursor"] } }, "required": ["items", "pageInfo"] } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/attachments/{attachmentId}": { "get": { "operationId": "downloadPublicV1ApplicationAttachment", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "attachmentId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Attachment bytes", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } }, "delete": { "operationId": "deletePublicV1ApplicationAttachment", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:submit", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "attachmentId", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "taskId", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[\\x21-\\x7e]+$" }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "204": { "description": "Attachment deleted", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "413": { "description": "Payload too large", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "422": { "description": "Semantically invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/me": { "get": { "operationId": "getPublicV1Me", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "me:read", "responses": { "200": { "description": "Current caller", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicMe" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } }, "parameters": [ { "$ref": "#/components/parameters/actingUser" } ] } }, "/v1/notifications": { "get": { "operationId": "listPublicV1Notifications", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "notification:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "enum": ["true", "false"] }, "required": false, "name": "unread", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1Notifications", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicNotificationPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/notifications/{notificationId}/read": { "put": { "operationId": "markPublicV1NotificationRead", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "notification:write", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "notificationId", "in": "path" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "required": true, "name": "Idempotency-Key", "in": "header" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "204": { "description": "Notification marked read", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "409": { "description": "Conflict", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/departments": { "get": { "operationId": "listPublicV1Departments", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "department:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1Departments", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDepartmentPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/positions": { "get": { "operationId": "listPublicV1Positions", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "position:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1Positions", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPositionPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/employees": { "get": { "operationId": "listPublicV1Employees", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "user:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "q", "in": "query" }, { "schema": { "type": "string", "enum": ["ACTIVE", "ON_LEAVE", "PENDING_RETIREMENT", "RETIRED"] }, "required": false, "name": "status", "in": "query" }, { "schema": { "type": "string", "enum": ["EMPLOYEE", "BP_MEMBER"] }, "required": false, "name": "personType", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "departmentId", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "positionId", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1Employees", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEmployeePage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/employees/{employeeId}": { "get": { "operationId": "getPublicV1Employee", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "user:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "employeeId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Employee detail", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEmployeeDetail" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/employee-field-catalog": { "get": { "operationId": "getPublicV1EmployeeFieldCatalog", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "user:read", "responses": { "200": { "description": "Employee field catalog", "headers": { "ETag": { "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEmployeeFieldCatalog" } } } }, "304": { "description": "Catalog has not changed", "headers": { "ETag": { "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } }, "parameters": [ { "$ref": "#/components/parameters/actingUser" } ] } }, "/v1/organization-chart/departments": { "get": { "operationId": "listPublicV1OrganizationChartDepartments", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "org:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1OrganizationChartDepartments", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicOrganizationChartDepartmentPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/organization-chart/members": { "get": { "operationId": "listPublicV1OrganizationChartMembers", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "org:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1OrganizationChartMembers", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicOrganizationChartMemberPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/projects": { "get": { "operationId": "listPublicV1Projects", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "project:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "enum": ["ACTIVE", "CLOSED"] }, "required": false, "name": "status", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1Projects", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicProjectPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/projects/{projectId}/customer-loans": { "get": { "operationId": "getPublicV1ProjectCustomerLoans", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "project:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "projectId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Project customer loans", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicProjectCustomerLoans" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/offices": { "get": { "operationId": "listPublicV1Offices", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "company:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1Offices", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicOfficePage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/working-hours": { "get": { "operationId": "listPublicV1WorkingHours", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "company:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1WorkingHours", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicWorkingHoursPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/expenses": { "get": { "operationId": "listPublicV1Expenses", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "expense:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1Expenses", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicExpensePage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/announcements": { "get": { "operationId": "listPublicV1Announcements", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "announcement:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1Announcements", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInternalAnnouncementPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/equipment": { "get": { "operationId": "listPublicV1Equipment", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "equipment:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "enum": ["SMARTPHONE", "TABLET", "COMPUTER", "SIM", "KEY", "OTHER"] }, "required": false, "name": "category", "in": "query" }, { "schema": { "type": "string", "enum": ["IN_STOCK", "LENT", "DELETED"] }, "required": false, "name": "status", "in": "query" }, { "schema": { "type": "string", "enum": ["PURCHASED", "CLIENT_LOAN"] }, "required": false, "name": "source", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 255 }, "required": false, "name": "search", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1Equipment", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEquipmentPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/equipment/{equipmentId}": { "get": { "operationId": "getPublicV1Equipment", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "equipment:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "equipmentId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Equipment detail", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEquipmentDetail" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/applications/{applicationId}/equipment-lending-status": { "get": { "operationId": "getPublicV1ApplicationEquipmentLendingStatus", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "application:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "applicationId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Application equipment lending status", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEquipmentLendingStatus" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/companies": { "get": { "operationId": "listPublicV1Companies", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "company:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1Companies", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCompanyPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/companies/{companyId}": { "get": { "operationId": "getPublicV1Company", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "company:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "companyId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Company detail", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCompanyDetail" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/companies/{companyId}/contact-history": { "get": { "operationId": "listPublicV1CompanyContactHistory", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "company:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1CompanyContactHistory", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCompanyContactHistoryPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/offices/history": { "get": { "operationId": "listPublicV1OfficeHistory", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "company:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1OfficeHistory", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicOfficeHistoryPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/working-hours/history": { "get": { "operationId": "listPublicV1WorkingHoursHistory", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "company:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1WorkingHoursHistory", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicWorkingHoursHistoryPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/employees/{employeeId}/applications": { "get": { "operationId": "listPublicV1EmployeeApplications", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "user:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "employeeId", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "enum": [ "department", "address", "commute", "bankAccount", "projects", "equipment", "emergencyContact" ] }, "required": false, "name": "field", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "statuses", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "typeCodes", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "from", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "to", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "q", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Employee applications", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicEmployeeApplicationsPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/employees/{employeeId}/descendants": { "get": { "operationId": "listPublicV1EmployeeDescendants", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "user:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "employeeId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Employee descendants", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicManagerDescendants" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/employees/{employeeId}/manager-chain": { "get": { "operationId": "listPublicV1EmployeeManagerChain", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "user:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "employeeId", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Employee manager chain", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicManagerChain" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/qa/inquiries": { "get": { "operationId": "listPublicV1QaInquiries", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "qa:chat", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1QaInquiries", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicQaInquiryPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/qa/starters": { "get": { "operationId": "listPublicV1QaStarters", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "qa:chat", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1QaStarters", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicQaStarterPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/qa/chat": { "post": { "operationId": "createPublicV1QaChat", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "qa:chat", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicQaChatRequest" } } } }, "responses": { "200": { "description": "Grounded QA answer", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicQaChatResponse" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "502": { "description": "Upstream generation failure", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } }, "parameters": [ { "$ref": "#/components/parameters/actingUser" } ] } }, "/v1/postal-addresses/{postalCode}": { "get": { "operationId": "lookupPublicV1PostalAddress", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "reference:read", "parameters": [ { "schema": { "type": "string", "pattern": "^(?:\\d{7}|\\d{3}-\\d{4})$" }, "required": true, "name": "postalCode", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Postal address", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPostalAddress" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "502": { "description": "Upstream failure", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "503": { "description": "Service unavailable", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/banks": { "get": { "operationId": "listPublicV1Banks", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "reference:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "q", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1Banks", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicBankPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "502": { "description": "Upstream failure", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "503": { "description": "Service unavailable", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/banks/{bankCode}": { "get": { "operationId": "getPublicV1Bank", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "reference:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "bankCode", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Bank", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicBank" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "502": { "description": "Upstream failure", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "503": { "description": "Service unavailable", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/banks/{bankCode}/branches": { "get": { "operationId": "listPublicV1BankBranches", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "reference:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "schema": { "type": "string", "minLength": 1 }, "required": false, "name": "q", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1BankBranches", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicBankPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "502": { "description": "Upstream failure", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "503": { "description": "Service unavailable", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/banks/{bankCode}/branches/{branchCode}": { "get": { "operationId": "getPublicV1BankBranch", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "reference:read", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "bankCode", "in": "path" }, { "schema": { "type": "string", "minLength": 1 }, "required": true, "name": "branchCode", "in": "path" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "Bank branch", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicBank" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "502": { "description": "Upstream failure", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "503": { "description": "Service unavailable", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } }, "/v1/qualifications": { "get": { "operationId": "listPublicV1Qualifications", "security": [ { "bearerAuth": [] } ], "x-upflow-scope": "qualification:read", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 2048 }, "required": false, "name": "cursor", "in": "query" }, { "$ref": "#/components/parameters/actingUser" } ], "responses": { "200": { "description": "listPublicV1Qualifications", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicQualificationPage" } } } }, "400": { "description": "Invalid request", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "401": { "description": "Authentication required", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "403": { "description": "Forbidden", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "404": { "description": "Not found", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "429": { "description": "Rate limited", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } }, "Retry-After": { "description": "Seconds until the caller may retry", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } }, "500": { "description": "Internal error", "headers": { "RateLimit-Limit": { "description": "Maximum requests allowed in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer", "minimum": 0 } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicErrorEnvelope" } } } } } } } }, "x-upflow-error-registry": { "VALIDATION_ERROR": { "status": 400, "messageId": "EU00001" }, "INVALID_CURSOR": { "status": 400, "messageId": "EU00001" }, "METHOD_NOT_ALLOWED": { "status": 405, "messageId": "EU00001" }, "AUTHENTICATION_REQUIRED": { "status": 401, "messageId": "EU00047" }, "INVALID_CREDENTIAL": { "status": 401, "messageId": "EU00048" }, "FORBIDDEN": { "status": 403, "messageId": "EU00002" }, "NOT_FOUND": { "status": 404, "messageId": "EU00003" }, "CONFLICT": { "status": 409, "messageId": "EU00027" }, "IDEMPOTENCY_KEY_REUSED": { "status": 409, "messageId": "EU00027" }, "PRECONDITION_FAILED": { "status": 412, "messageId": "EU00027" }, "PAYLOAD_TOO_LARGE": { "status": 413, "messageId": "EU00004" }, "UNPROCESSABLE_ENTITY": { "status": 422, "messageId": "EU00001" }, "RATE_LIMITED": { "status": 429, "messageId": "EU00005" }, "SINGLE_PENDING": { "status": 400, "messageId": "EU00036" }, "INTERNAL_ERROR": { "status": 500, "messageId": "EU00006" }, "BAD_GATEWAY": { "status": 502, "messageId": "EU00007" }, "SERVICE_UNAVAILABLE": { "status": 503, "messageId": "EU00008" }, "GATEWAY_TIMEOUT": { "status": 504, "messageId": "EU00009" }, "PRECONDITION_REQUIRED": { "status": 428, "messageId": "EU00001" } } }