{"openapi":"3.1.0","info":{"title":"transformd","description":"Transforms: declarative pipelines that authenticate, filter, reshape and trim a request. Build, version, test and run them here, and refer to them by id from the products that send (RFC-0030).","version":"0.1.0"},"paths":{"/v1/plan":{"get":{"tags":["account"],"summary":"Read Plan","operationId":"read_plan_v1_plan_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]}},"/v1/usage":{"get":{"tags":["account"],"summary":"Read Usage","operationId":"read_usage_v1_usage_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]}},"/v1/pipelines":{"post":{"tags":["pipelines"],"summary":"Create Pipeline","description":"Create a pipeline and its version 1, checked whole: a 422 ``invalid_pipeline`` names the\nfirst problem's step, path and reason. Every plan. A document whose auth step names a slot\nneeds an owner or admin (403 ``role``).","operationId":"create_pipeline_v1_pipelines_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"error.code = quota_exceeded | workspace_frozen | workspace_suspended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","quota_exceeded","unauthorized","validation_error","workspace_frozen","workspace_suspended"]},"get":{"tags":["pipelines"],"summary":"List Pipelines","description":"The workspace's pipelines, newest first, each without its document (GET by id has it).","operationId":"list_pipelines_v1_pipelines_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":0,"title":"Offset"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_PipelineOut_"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]}},"/v1/pipelines/templates":{"get":{"tags":["pipelines"],"summary":"List Pipeline Templates","description":"transform-core's gallery (RFC-0030): the ready-made pipelines one starts from. Slack, Discord\nand Microsoft Teams messages, and the body with only the fields listed or without its personal\ndata. They come from the engine version this service runs, so a template never names a step or\na filter it could not run. The same for every workspace; saving one makes a copy that is the\nworkspace's own.","operationId":"list_pipeline_templates_v1_pipelines_templates_get","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PipelineTemplateOut"},"title":"Response List Pipeline Templates V1 Pipelines Templates Get"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]}},"/v1/pipelines/test":{"post":{"tags":["pipelines"],"summary":"Test Pipeline","description":"Run a document once on a request and save nothing: the editor's Test. It is checked as a save\nchecks it (422 ``invalid_pipeline``), and shares the run rate. What its auth steps add shows\nmasked (``Bearer ••••``). A drop or a failure is a 200 saying so, because that is the answer a\ntest exists to give.","operationId":"test_pipeline_v1_pipelines_test_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineTestIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineRunOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"error.code = workspace_suspended"},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"error.code = rate_limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","rate_limited","unauthorized","validation_error","workspace_suspended"]}},"/v1/pipelines/{pipeline_id}":{"get":{"tags":["pipelines"],"summary":"Read Pipeline","operationId":"read_pipeline_v1_pipelines__pipeline_id__get","parameters":[{"name":"pipeline_id","in":"path","required":true,"schema":{"type":"string","title":"Pipeline Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]},"patch":{"tags":["pipelines"],"summary":"Patch Pipeline","description":"Rename it, switch it on or off, or save new content as its next version. ``disabled`` stops\nit running, here and at every consumer. Saving a document whose auth step names a slot needs\nan owner or admin (403 ``role`` for a member); the same content again, and a document without\none, do not. Such a new version also needs ``confirm_destinations`` to name every service that\nruns it by reference: otherwise it is a 409 ``destinations_unconfirmed`` listing them, and\nnothing is saved.","operationId":"patch_pipeline_v1_pipelines__pipeline_id__patch","parameters":[{"name":"pipeline_id","in":"path","required":true,"schema":{"type":"string","title":"Pipeline Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelinePatch"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"error.code = workspace_frozen | workspace_suspended"},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"error.code = conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["conflict","forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error","workspace_frozen","workspace_suspended"]},"delete":{"tags":["pipelines"],"summary":"Delete Pipeline","description":"Delete a pipeline and its versions, for good. An owner or admin. A consumer still running it\nthen fails each delivery, so ``confirm_destinations`` must name every service that does:\notherwise it is a 409 ``destinations_unconfirmed`` listing them.","operationId":"delete_pipeline_v1_pipelines__pipeline_id__delete","parameters":[{"name":"pipeline_id","in":"path","required":true,"schema":{"type":"string","title":"Pipeline Id"}},{"name":"confirm_destinations","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"description":"Every service that runs it by reference, as a read lists them.","default":[],"title":"Confirm Destinations"},"description":"Every service that runs it by reference, as a read lists them."},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"204":{"description":"Successful Response"},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"error.code = conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["conflict","forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]}},"/v1/pipelines/{pipeline_id}/versions":{"get":{"tags":["pipelines"],"summary":"List Pipeline Versions","description":"The kept versions, newest first, each without its document (GET one version has it).","operationId":"list_pipeline_versions_v1_pipelines__pipeline_id__versions_get","parameters":[{"name":"pipeline_id","in":"path","required":true,"schema":{"type":"string","title":"Pipeline Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":0,"title":"Offset"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_PipelineVersionOut_"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]}},"/v1/pipelines/{pipeline_id}/versions/{version}":{"get":{"tags":["pipelines"],"summary":"Read Pipeline Version","operationId":"read_pipeline_version_v1_pipelines__pipeline_id__versions__version__get","parameters":[{"name":"pipeline_id","in":"path","required":true,"schema":{"type":"string","title":"Pipeline Id"}},{"name":"version","in":"path","required":true,"schema":{"type":"integer","maximum":2147483647,"minimum":1,"title":"Version"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineVersionOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]}},"/v1/pipelines/{pipeline_id}/run":{"post":{"tags":["pipelines"],"summary":"Run Pipeline","description":"Run a saved pipeline on a request: whatever the caller sends as ``body``, ``headers`` and\n``meta``. Stateless: nothing about the request is kept, and the run is only counted. The current\nversion runs unless ``version`` names a kept one. The answer says what the pipeline did: ``ok``\nwith what to send, ``dropped`` by a filter, or ``failed``. Each is a 200; retrying a ``failed``\ngets the same answer. What an auth step adds is masked (``Bearer ••••``): to send with a\ncredential, run the pipeline by reference from the product that sends. Past the plan's rate, or\nwith too many of the workspace's runs under way at once, a 429.\nOpen while a charge is unsettled.","operationId":"run_pipeline_v1_pipelines__pipeline_id__run_post","parameters":[{"name":"pipeline_id","in":"path","required":true,"schema":{"type":"string","title":"Pipeline Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineRunIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineRunOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"error.code = workspace_suspended"},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"error.code = conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"error.code = rate_limited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["conflict","forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","rate_limited","unauthorized","validation_error","workspace_suspended"]}},"/v1/slots":{"post":{"tags":["slots"],"summary":"Create Slot","description":"Add a place for a credential: a pipeline's auth step names it by the ``id`` this answers. It\nholds no value. A product that runs the pipeline by reference binds it to a secret of its own.","operationId":"create_slot_v1_slots_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlotIn"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlotOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"error.code = quota_exceeded | workspace_frozen | workspace_suspended","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","quota_exceeded","unauthorized","validation_error","workspace_frozen","workspace_suspended"]},"get":{"tags":["slots"],"summary":"List Slots","description":"The workspace's slots, newest first.","operationId":"list_slots_v1_slots_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":0,"default":0,"title":"Offset"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_SlotOut_"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]}},"/v1/slots/{slot_id}":{"get":{"tags":["slots"],"summary":"Read Slot","operationId":"read_slot_v1_slots__slot_id__get","parameters":[{"name":"slot_id","in":"path","required":true,"schema":{"type":"string","title":"Slot Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlotOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]},"patch":{"tags":["slots"],"summary":"Patch Slot","description":"Change a slot's label.","operationId":"patch_slot_v1_slots__slot_id__patch","parameters":[{"name":"slot_id","in":"path","required":true,"schema":{"type":"string","title":"Slot Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlotPatch"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlotOut"}}}},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"error.code = workspace_frozen | workspace_suspended"},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error","workspace_frozen","workspace_suspended"]},"delete":{"tags":["slots"],"summary":"Delete Slot","description":"Delete a slot, for good. Refused (409 ``slot_in_use``) while a pipeline's current version\nnames it: change those pipelines first.","operationId":"delete_slot_v1_slots__slot_id__delete","parameters":[{"name":"slot_id","in":"path","required":true,"schema":{"type":"string","title":"Slot Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-api-key","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Api-Key"}},{"name":"X-CSRF","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Csrf"}},{"name":"nn_apps_access_token","in":"cookie","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nn Apps Access Token"}}],"responses":{"204":{"description":"Successful Response"},"401":{"description":"error.code = unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"error.code = forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"error.code = not_found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"error.code = conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"error.code = payload_too_large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"error.code = validation_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"500":{"description":"error.code = internal_error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}},"x-error-codes":["conflict","forbidden","internal_error","invalid_credential","invalid_pipeline","not_found","payload_too_large","unauthorized","validation_error"]}}},"components":{"schemas":{"ConsumerOut":{"properties":{"service":{"type":"string","title":"Service"},"version":{"type":"integer","title":"Version"},"last_seen_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Seen At"},"pinned":{"type":"boolean","title":"Pinned","default":false}},"type":"object","required":["service","version"],"title":"ConsumerOut","description":"A service running one version of this pipeline by reference, as its fetches and pins say."},"ErrorDetail":{"description":"The `error` object: what went wrong.","properties":{"code":{"description":"Stable machine-readable reason. Clients branch on this.","title":"Code","type":"string","x-known-values":["bad_request","conflict","error","forbidden","internal","internal_error","invalid_credential","invalid_pipeline","invalid_request","method_not_allowed","not_entitled","not_found","payload_too_large","plan_violation","quota_exceeded","rate_limited","unauthorized","unavailable","unprocessable","unprocessable_event","validation_error","workspace_frozen","workspace_suspended"]},"message":{"description":"Human-readable explanation. Never branch on it.","title":"Message","type":"string"},"details":{"anyOf":[{},{"type":"null"}],"default":null,"description":"Optional structured detail; its shape is fixed per code, not globally.","title":"Details"},"request_id":{"type":"string","description":"The request's X-Request-ID. Quote it to support; never branch on it."},"next_code":{"type":"string","description":"Present only while this error is moving to a different code: the code it will be sent with once the move is complete. When present, branch on this rather than on `code`.","x-known-values":["bad_request","conflict","forbidden","internal_error","invalid_credential","invalid_pipeline","method_not_allowed","not_entitled","not_found","payload_too_large","quota_exceeded","rate_limited","unauthorized","unavailable","unprocessable_event","validation_error","workspace_frozen","workspace_suspended"]}},"required":["code","message"],"title":"ErrorDetail","type":"object"},"ErrorEnvelope":{"description":"The body of every error response: an `error` object that says what went wrong.","properties":{"error":{"$ref":"#/components/schemas/ErrorDetail"}},"required":["error"],"title":"ErrorEnvelope","type":"object"},"Page_PipelineOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PipelineOut"},"type":"array","title":"Items"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"}},"type":"object","required":["items"],"title":"Page[PipelineOut]"},"Page_PipelineVersionOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PipelineVersionOut"},"type":"array","title":"Items"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"}},"type":"object","required":["items"],"title":"Page[PipelineVersionOut]"},"Page_SlotOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/SlotOut"},"type":"array","title":"Items"},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"}},"type":"object","required":["items"],"title":"Page[SlotOut]"},"PipelineIn":{"properties":{"name":{"type":"string","maxLength":200,"title":"Name","default":""},"pipeline":{"additionalProperties":true,"type":"object","title":"Pipeline"}},"type":"object","required":["pipeline"],"title":"PipelineIn"},"PipelineOut":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"status":{"type":"string","enum":["enabled","disabled"],"title":"Status"},"current_version":{"type":"integer","title":"Current Version"},"pipeline":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"additionalProperties":true,"title":"Pipeline"},"destinations":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Destinations"},"consumers":{"anyOf":[{"items":{"$ref":"#/components/schemas/ConsumerOut"},"type":"array"},{"type":"null"}],"title":"Consumers"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","name","status","current_version","created_at","updated_at"],"title":"PipelineOut"},"PipelinePatch":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Name"},"pipeline":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"additionalProperties":true,"title":"Pipeline"},"status":{"anyOf":[{"type":"string","enum":["enabled","disabled"]},{"type":"null"}],"title":"Status"},"confirm_destinations":{"anyOf":[{"items":{"type":"string","maxLength":64},"type":"array"},{"type":"null"}],"title":"Confirm Destinations"}},"type":"object","title":"PipelinePatch","description":"Partial update: an omitted field is unchanged. A new ``pipeline`` is checked and saved as the\nnext version; restoring an old version is saving its content again.\n\nA new version whose auth steps name a slot reaches every consumer that runs the pipeline by\nreference, so ``confirm_destinations`` must name them all (``destinations`` on PipelineOut).\nOtherwise it is a 409 ``conflict``, reason ``destinations_unconfirmed``, whose ``destinations``\nlists them, and nothing is saved."},"PipelineRunIn":{"properties":{"body":{"title":"Body"},"headers":{"additionalProperties":{"type":"string","maxLength":8192},"propertyNames":{"maxLength":256},"type":"object","maxProperties":256,"title":"Headers"},"meta":{"title":"Meta"},"version":{"anyOf":[{"type":"integer","maximum":2147483647,"minimum":1},{"type":"null"}],"title":"Version"}},"type":"object","title":"PipelineRunIn"},"PipelineRunOut":{"properties":{"status":{"type":"string","enum":["ok","dropped","failed"],"title":"Status"},"version":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Version"},"body":{"title":"Body"},"body_changed":{"type":"boolean","title":"Body Changed","default":false},"headers":{"additionalProperties":{"type":"string"},"type":"object","title":"Headers"},"query":{"additionalProperties":{"type":"string"},"type":"object","title":"Query"},"step":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Step"},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"},"duration_ms":{"type":"number","title":"Duration Ms","default":0}},"type":"object","required":["status"],"title":"PipelineRunOut","description":"What the pipeline did: ``ok`` (send ``body`` and ``headers``, with ``query`` on the URL),\n``dropped`` (a filter dropped it: send nothing), or ``failed`` (the same pipeline on the same\nrequest fails the same way, so don't retry). All three are a 200: the pipeline ran. What an\nauth step adds is always masked (``Bearer ••••``): a slot has no value, so there is none here."},"PipelineTemplateOut":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"pipeline":{"additionalProperties":true,"type":"object","title":"Pipeline"}},"type":"object","required":["id","name","description","pipeline"],"title":"PipelineTemplateOut","description":"A ready-made pipeline from transform-core's gallery: a starting point. Saving one makes a\ncopy that is the workspace's own; nothing refers back to the template."},"PipelineTestIn":{"properties":{"body":{"title":"Body"},"headers":{"additionalProperties":{"type":"string","maxLength":8192},"propertyNames":{"maxLength":256},"type":"object","maxProperties":256,"title":"Headers"},"meta":{"title":"Meta"},"pipeline":{"additionalProperties":true,"type":"object","title":"Pipeline"}},"type":"object","required":["pipeline"],"title":"PipelineTestIn","description":"Run a document once and save nothing: the editor's Test. It need not be saved, so this tests\nwhat is in the editor. It is checked as a save checks it."},"PipelineVersionOut":{"properties":{"version":{"type":"integer","title":"Version"},"created_by":{"type":"string","title":"Created By"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"pipeline":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"additionalProperties":true,"title":"Pipeline"}},"type":"object","required":["version","created_by","created_at"],"title":"PipelineVersionOut"},"PlanOut":{"properties":{"plan":{"type":"string","title":"Plan"},"enforced_as":{"type":"string","title":"Enforced As"},"ceilings":{"additionalProperties":{"type":"integer"},"type":"object","title":"Ceilings"},"past_due":{"type":"boolean","title":"Past Due","default":false},"suspended":{"type":"boolean","title":"Suspended","default":false},"system":{"type":"boolean","title":"System","default":false}},"type":"object","required":["plan","enforced_as","ceilings"],"title":"PlanOut"},"SlotIn":{"properties":{"label":{"type":"string","maxLength":200,"title":"Label","default":""}},"type":"object","title":"SlotIn"},"SlotOut":{"properties":{"id":{"type":"string","title":"Id"},"label":{"type":"string","title":"Label"},"pipeline_count":{"type":"integer","title":"Pipeline Count","default":0},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","label","created_at","updated_at"],"title":"SlotOut","description":"Where a pipeline's auth step takes a credential: an id and a label, and no value."},"SlotPatch":{"properties":{"label":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}],"title":"Label"}},"type":"object","title":"SlotPatch","description":"Change its label."},"UsageOut":{"properties":{"period":{"type":"string","title":"Period"},"runs":{"type":"integer","title":"Runs"},"failures":{"type":"integer","title":"Failures"},"dropped":{"type":"integer","title":"Dropped"},"pipelines":{"type":"integer","title":"Pipelines"},"max_pipelines":{"type":"integer","title":"Max Pipelines"},"slots":{"type":"integer","title":"Slots"},"max_secret_slots":{"type":"integer","title":"Max Secret Slots"}},"type":"object","required":["period","runs","failures","dropped","pipelines","max_pipelines","slots","max_secret_slots"],"title":"UsageOut","description":"This month's runs through the run API (counted, not billed) and what the workspace holds. A\nrun at a consumer counts in the consumer's usage."}}},"x-error-codes":{"aliases":{"internal":{"code":"internal_error","reason":null},"invalid_request":{"code":"validation_error","reason":null},"unprocessable":{"code":"validation_error","reason":null}},"client_only":["bad_response","gateway_error","network_error","timeout"],"codes":{"bad_request":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{},"replaced_by":null,"status":[400],"umbrella":false},"conflict":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null},"hostname":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"slug":{"format":"identifier","join":null,"kind":"value","required":false,"values":null}},"reasons":{"destinations_unconfirmed":{"destinations":{"format":"identifiers","join":null,"kind":"value","required":true,"values":null},"id":{"format":"identifier","join":null,"kind":"value","required":true,"values":null}},"pipeline_disabled":{"id":{"format":"identifier","join":null,"kind":"value","required":true,"values":null}},"slot_in_use":{"id":{"format":"identifier","join":null,"kind":"value","required":true,"values":null},"pipelines":{"format":"number","join":null,"kind":"value","required":true,"values":null}}},"replaced_by":null,"status":[409],"umbrella":true},"error":{"audience":"customer","complete":false,"count_param":null,"deprecated":true,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":null,"replaced_by":null,"status":[],"umbrella":false},"forbidden":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{"required":{"format":null,"join":null,"kind":"selector","required":false,"values":["admin","member"]}},"reasons":{"csrf":{},"membership":{},"no_workspace":{},"not_provisioned":{},"operator":{},"product_not_enabled":{},"project":{},"project_confined":{},"role":{},"scope":{}},"replaced_by":null,"status":[403],"umbrella":true},"internal":{"audience":"customer","complete":false,"count_param":null,"deprecated":true,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":null,"replaced_by":"internal_error","status":[500],"umbrella":false},"internal_error":{"audience":"customer","complete":true,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{},"replaced_by":null,"status":[500],"umbrella":false},"invalid_credential":{"audience":"customer","complete":true,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{},"replaced_by":null,"status":[401,403],"umbrella":false},"invalid_pipeline":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{"auth_not_last":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"credential_header":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"forbidden_header":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"invalid_document":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"invalid_filter":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"invalid_header":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"invalid_path":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"invalid_secret":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"invalid_step":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"invalid_template":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"invalid_value":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"no_steps":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"not_json":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"too_deep":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"too_large":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"too_many_steps":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"unknown_slot":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"unknown_step":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"unsupported_version":{"path":{"format":"identifier","join":null,"kind":"value","required":false,"values":null},"step":{"format":"number","join":null,"kind":"value","required":false,"values":null}}},"replaced_by":null,"status":[422],"umbrella":false},"invalid_request":{"audience":"customer","complete":false,"count_param":null,"deprecated":true,"diagnostic_reasons":[],"entry_types":{"bool_parsing":{},"bool_type":{},"date_parsing":{},"date_type":{},"datetime_from_date_parsing":{},"datetime_parsing":{},"datetime_type":{},"dict_type":{},"enum":{},"extra_forbidden":{},"finite_number":{},"float_parsing":{},"float_type":{},"greater_than":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"greater_than_equal":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"int_from_float":{},"int_parsing":{},"int_parsing_size":{},"int_type":{},"json_invalid":{},"json_type":{},"less_than":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"less_than_equal":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"list_type":{},"literal_error":{},"missing":{},"model_attributes_type":{},"model_type":{},"string_pattern_mismatch":{},"string_too_long":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"string_too_short":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"string_type":{},"string_unicode":{},"too_long":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"too_short":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"url_parsing":{},"url_type":{},"uuid_parsing":{},"uuid_type":{}},"params":{},"reasons":null,"replaced_by":"validation_error","status":[422],"umbrella":false},"method_not_allowed":{"audience":"customer","complete":true,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{},"replaced_by":null,"status":[405],"umbrella":false},"not_entitled":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{"feature":{"format":null,"join":null,"kind":"selector","required":false,"values":null}},"reasons":{},"replaced_by":null,"status":[402],"umbrella":false},"not_found":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{"id":{"format":"identifier","join":null,"kind":"value","required":false,"values":null}},"reasons":{"pipeline":{},"pipeline_version":{},"slot":{}},"replaced_by":null,"status":[404],"umbrella":true},"payload_too_large":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{"limit":{"format":"bytes","join":null,"kind":"value","required":true,"values":null},"size":{"format":"bytes","join":null,"kind":"value","required":false,"values":null}},"reasons":{},"replaced_by":null,"status":[413],"umbrella":false},"plan_violation":{"audience":"customer","complete":false,"count_param":null,"deprecated":true,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":null,"replaced_by":null,"status":[402],"umbrella":false},"quota_exceeded":{"audience":"customer","complete":false,"count_param":"limit","deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{"current":{"format":"number","join":null,"kind":"value","required":false,"values":null},"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null},"metric":{"format":null,"join":null,"kind":"selector","required":false,"values":["pipelines","slots"]},"period":{"format":null,"join":null,"kind":"value","required":false,"values":null}},"reasons":{"allocation":{},"period":{"credit":{"format":null,"join":null,"kind":"selector","required":false,"values":["empty","off","pending"]}}},"replaced_by":null,"status":[402],"umbrella":false},"rate_limited":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{"retry_after":{"format":"seconds","join":null,"kind":"value","required":false,"values":null}},"reasons":{},"replaced_by":null,"status":[429],"umbrella":false},"unauthorized":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{"expired":{},"invalid":{},"missing":{},"no_workspace":{},"revoked":{}},"replaced_by":null,"status":[401],"umbrella":true},"unavailable":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{"retry_after":{"format":"seconds","join":null,"kind":"value","required":false,"values":null}},"reasons":{"ingest_disabled":{},"plan_service":{}},"replaced_by":null,"status":[503],"umbrella":false},"unprocessable":{"audience":"customer","complete":false,"count_param":null,"deprecated":true,"diagnostic_reasons":[],"entry_types":{"bool_parsing":{},"bool_type":{},"date_parsing":{},"date_type":{},"datetime_from_date_parsing":{},"datetime_parsing":{},"datetime_type":{},"dict_type":{},"enum":{},"extra_forbidden":{},"finite_number":{},"float_parsing":{},"float_type":{},"greater_than":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"greater_than_equal":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"int_from_float":{},"int_parsing":{},"int_parsing_size":{},"int_type":{},"json_invalid":{},"json_type":{},"less_than":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"less_than_equal":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"list_type":{},"literal_error":{},"missing":{},"model_attributes_type":{},"model_type":{},"string_pattern_mismatch":{},"string_too_long":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"string_too_short":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"string_type":{},"string_unicode":{},"too_long":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"too_short":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"url_parsing":{},"url_type":{},"uuid_parsing":{},"uuid_type":{}},"params":{},"reasons":null,"replaced_by":"validation_error","status":[422],"umbrella":false},"unprocessable_event":{"audience":"machine","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{},"replaced_by":null,"status":[422],"umbrella":false},"validation_error":{"audience":"customer","complete":false,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{"bool_parsing":{},"bool_type":{},"date_parsing":{},"date_type":{},"datetime_from_date_parsing":{},"datetime_parsing":{},"datetime_type":{},"dict_type":{},"enum":{},"extra_forbidden":{},"finite_number":{},"float_parsing":{},"float_type":{},"greater_than":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"greater_than_equal":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"int_from_float":{},"int_parsing":{},"int_parsing_size":{},"int_type":{},"json_invalid":{},"json_type":{},"less_than":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"less_than_equal":{"limit":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"list_type":{},"literal_error":{},"missing":{},"model_attributes_type":{},"model_type":{},"string_pattern_mismatch":{},"string_too_long":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"string_too_short":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"string_type":{},"string_unicode":{},"too_long":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"too_short":{"count":{"format":"number","join":null,"kind":"value","required":false,"values":null}},"transforms.nul_character":{},"url_parsing":{},"url_type":{},"uuid_parsing":{},"uuid_type":{}},"params":{},"reasons":{},"replaced_by":null,"status":[422],"umbrella":true},"workspace_frozen":{"audience":"customer","complete":true,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{},"replaced_by":null,"status":[402],"umbrella":false},"workspace_suspended":{"audience":"customer","complete":true,"count_param":null,"deprecated":false,"diagnostic_reasons":[],"entry_types":{},"params":{},"reasons":{},"replaced_by":null,"status":[402],"umbrella":false}},"status_codes":{"400":"bad_request","401":"unauthorized","403":"forbidden","404":"not_found","405":"method_not_allowed","409":"conflict","413":"payload_too_large","422":"validation_error","429":"rate_limited","500":"internal_error","503":"unavailable"},"version":1},"servers":[{"url":"https://transforms.nimbusnexus.net"}]}