diff --git a/backend/README.md b/backend/README.md index 66c4c93bb3..bd3ea6f0ad 100644 --- a/backend/README.md +++ b/backend/README.md @@ -175,11 +175,15 @@ psql -d unstract_db -U unstract_dev ## API Docs -While running the backend server locally, access the API documentation that's auto generated at -the backend endpoint `/api/v1/doc/`. +The OpenAPI spec for the API deployment endpoints is committed at +[`specs/docstudio-oss.json`](../specs/docstudio-oss.json) and is the contract the published +clients and their generated SDKs are built from. It is not served at runtime — regenerate it in +the same PR as any route, serializer or schema-annotation change: -**NOTE:** There exists issues accessing this when the django server is run with gunicorn (in case of running with -a container) +```bash +uv run python manage.py generate_docstudio_spec # rewrite the committed spec +uv run python manage.py generate_docstudio_spec --check # no write, drift is an error +``` - [Account](account/api_doc.md) - [FileManagement](file_management/api_doc.md) diff --git a/backend/api_v2/api_deployment_views.py b/backend/api_v2/api_deployment_views.py index d5cfa800a1..8f5d0763a9 100644 --- a/backend/api_v2/api_deployment_views.py +++ b/backend/api_v2/api_deployment_views.py @@ -33,6 +33,7 @@ contains_tool_not_found_error, ) from api_v2.models import APIDeployment +from api_v2.openapi_schema import DEPLOYMENT_EXECUTION_SCHEMA from api_v2.rate_limiter import APIDeploymentRateLimiter from api_v2.serializers import ( APIDeploymentListSerializer, @@ -50,6 +51,7 @@ logger = logging.getLogger(__name__) +@DEPLOYMENT_EXECUTION_SCHEMA class DeploymentExecution(views.APIView): def initialize_request(self, request: Request, *args: Any, **kwargs: Any) -> Request: """To remove csrf request for public API. diff --git a/backend/api_v2/deployment_spec_urls.py b/backend/api_v2/deployment_spec_urls.py new file mode 100644 index 0000000000..9dff155d9d --- /dev/null +++ b/backend/api_v2/deployment_spec_urls.py @@ -0,0 +1,29 @@ +"""URLconf the published OpenAPI spec is generated against. + +Each entry is an included sub-urlconf: generating against one directly yields +paths without the prefix it is mounted at, i.e. a spec describing URLs the +server does not serve. The mounts are selected out of the served urlconf +rather than restated, so moving one moves the generated paths with it. + +Widening the spec to another endpoint means annotating its view with +``@extend_schema`` and adding its urlconf here. +""" + +from django.core.exceptions import ImproperlyConfigured + +from backend import base_urls + +SPEC_URLCONFS = ("api_v2.execution_urls",) + +urlpatterns = [ + entry + for entry in base_urls.urlpatterns + if getattr(getattr(entry, "urlconf_name", None), "__name__", None) in SPEC_URLCONFS +] + +missing = set(SPEC_URLCONFS) - {entry.urlconf_name.__name__ for entry in urlpatterns} +if missing: + raise ImproperlyConfigured( + f"{', '.join(sorted(missing))} is not mounted in backend.base_urls; the " + "spec would be generated for routes the server does not serve." + ) diff --git a/backend/api_v2/management/commands/generate_docstudio_spec.py b/backend/api_v2/management/commands/generate_docstudio_spec.py new file mode 100644 index 0000000000..dc5ddabe88 --- /dev/null +++ b/backend/api_v2/management/commands/generate_docstudio_spec.py @@ -0,0 +1,132 @@ +"""Regenerate the committed API deployment OpenAPI spec. + +The spec is the contract the published clients and their generated SDKs are +built from, so it is committed and CI fails on drift: change a route, a +serializer or the schema annotation, and regenerate in the same PR. + + uv run python manage.py generate_docstudio_spec # from backend/ + uv run python manage.py generate_docstudio_spec --check # no write, drift is an error + +The generated paths carry ``API_DEPLOYMENT_PATH_PREFIX``, so generation refuses +to produce a spec mounted anywhere but the public default: the committed +artifact describes the deployment as it is served publicly, not as one +installation chooses to mount it. +""" + +import json +from pathlib import Path +from typing import Any + +from django.core.management.base import BaseCommand, CommandError +from drf_spectacular.drainage import GENERATOR_STATS +from drf_spectacular.generators import SchemaGenerator +from drf_spectacular.validation import validate_schema + +DEFAULT_OUT = Path(__file__).resolve().parents[4] / "specs" / "docstudio-oss.json" +URLCONF = "api_v2.deployment_spec_urls" +REGENERATE = "uv run python manage.py generate_docstudio_spec" +# The mount the deployment is served at publicly. `API_DEPLOYMENT_PATH_PREFIX` +# can move it per installation, and a spec carrying a private prefix would send +# every generated client to a URL only that installation answers. +PUBLISHED_PATH_PREFIX = "deployment" +# Named in every failure message: the repos that regenerate from this file are +# the ones a spec change actually breaks, and nothing there watches this repo. +DOWNSTREAM = ( + "The published client (Zipstack/unstract-python-client) and the CLI " + "(Zipstack/unstract-cli) are generated from this file — raise the matching " + "PRs there for anything that changes an operation id, a tag or a schema." +) + + +class SpecGenerationFailed(CommandError): + """Raised when the generator had to guess.""" + + +def render_spec() -> str: + """The committed artifact, byte for byte. + + Shared with the drift test: two copies of this could disagree, and then + the gate rejects exactly the file the command it names produces. + """ + GENERATOR_STATS.reset() + schema = SchemaGenerator(urlconf=URLCONF).get_schema(request=None, public=True) + if GENERATOR_STATS: + # An operation spectacular could not resolve is published with no + # request body and an empty response rather than dropped, which reads + # downstream as an annotation that is simply thin. Both caches are + # drained because the severity a given diagnostic carries is + # spectacular's choice, not something to rely on. + diagnostics = "\n".join( + f" {severity}: {message}" + for severity, cache in ( + ("error", GENERATOR_STATS._error_cache), + ("warning", GENERATOR_STATS._warn_cache), + ) + for message in cache + ) + raise SpecGenerationFailed( + f"The generator reported problems, so the spec would describe an " + f"API nobody implements:\n{diagnostics}" + ) + + off_prefix = [ + path + for path in schema["paths"] + if not path.startswith(f"/{PUBLISHED_PATH_PREFIX}/") + ] + if off_prefix: + raise SpecGenerationFailed( + f"Generated paths are not under /{PUBLISHED_PATH_PREFIX}/: " + f"{', '.join(sorted(off_prefix))}. Unset API_DEPLOYMENT_PATH_PREFIX " + f"and regenerate." + ) + + # Hand-written fragments (path parameter schemas, security schemes) reach + # the output verbatim, so nothing above would notice a typo in one. + try: + validate_schema(schema) + except Exception as error: + raise SpecGenerationFailed(f"The generated spec is not valid OpenAPI: {error}") + + # Sorted keys are what make the committed artifact a usable drift signal. + return json.dumps(schema, indent=2, sort_keys=True) + "\n" + + +class Command(BaseCommand): + help = "Generate the API deployment OpenAPI spec." + + def add_arguments(self, parser: Any) -> None: + parser.add_argument("--out", type=Path, default=DEFAULT_OUT) + parser.add_argument( + "--check", + action="store_true", + help="Fail if the file on disk differs, instead of writing it.", + ) + + def handle(self, *args: Any, **options: Any) -> None: + rendered = render_spec() + + out: Path = options["out"] + if options["check"]: + current = out.read_text() if out.exists() else "" + if current != rendered: + raise CommandError( + f"{out} is out of date. Run `{REGENERATE}` from `backend/` " + f"and commit the result.\n\n{DOWNSTREAM}" + ) + self.stdout.write(f"{out} is up to date") + return + + out.parent.mkdir(parents=True, exist_ok=True) + out.write_text(rendered) + schema = json.loads(rendered) + operations = sum( + 1 + for methods in schema["paths"].values() + for method in methods + if method in {"get", "post", "put", "patch", "delete"} + ) + self.stdout.write( + f"{out}: {len(schema['paths'])} paths, {operations} operations, " + f"{len(schema.get('components', {}).get('schemas', {}))} schemas" + ) diff --git a/backend/api_v2/openapi_schema.py b/backend/api_v2/openapi_schema.py new file mode 100644 index 0000000000..d3376276a0 --- /dev/null +++ b/backend/api_v2/openapi_schema.py @@ -0,0 +1,244 @@ +"""OpenAPI annotations for the API deployment endpoints. + +The serializers here shape the published spec only; none of them is used to +parse a request or build a response. They live outside ``serializers.py`` so +that nothing at request time imports one by accident. + +Their docstrings are published as the client-facing model descriptions, so +they are written for the caller rather than the maintainer. +""" + +from drf_spectacular.utils import ( + OpenApiParameter, + OpenApiResponse, + extend_schema, + extend_schema_serializer, + extend_schema_view, +) +from rest_framework import serializers + +from api_v2.serializers import ( + APIExecutionResponseSerializer, + ExecutionQuerySerializer, + ExecutionRequestSerializer, +) + + +# Declares no field of its own, so a change to the real serializer moves the +# spec. It exists to carry a caller-facing description and a stable name. +@extend_schema_serializer(component_name="ExecuteRequest") +class ExecuteRequest(ExecutionRequestSerializer): + """The documents to run, and the options that shape the result. + + Supply `files`, `presigned_urls`, or both. + """ + + +class FileResult(serializers.Serializer): + """One input document's outcome. + + Every key is present on every item; the ones that depend on the request + options or on the outcome are sent as `null` when they do not apply. + """ + + file = serializers.CharField() + file_execution_id = serializers.CharField(required=False, allow_null=True) + status = serializers.CharField(required=False) + result = serializers.JSONField(required=False, allow_null=True) + metadata = serializers.JSONField(required=False, allow_null=True) + extracted_text = serializers.CharField( + required=False, + allow_null=True, + help_text="The document's full extracted text. Sent only when the " + "request set `include_extracted_text`.", + ) + error = serializers.CharField(required=False, allow_null=True) + + +class ExecutionMessage(APIExecutionResponseSerializer): + """The execution's identity and, once it has finished, its per-file + results. + """ + + # The three fields below are restated because the real serializer declares + # them as required and non-nullable while the dataclass behind it coerces + # every falsy value to None, so the happy path would contradict the spec. + status_api = serializers.CharField(required=False, allow_null=True) + error = serializers.CharField(required=False, allow_null=True) + result = FileResult(many=True, required=False, allow_null=True) + + +class ExecuteResponse(serializers.Serializer): + message = ExecutionMessage() + + +class StatusResponse(serializers.Serializer): + status = serializers.CharField() + message = FileResult(many=True, required=False, allow_null=True) + + +class AcknowledgedResponse(serializers.Serializer): + """The execution's result was handed to an earlier call and discarded.""" + + status = serializers.CharField() + message = serializers.CharField() + + +class ErrorDetail(serializers.Serializer): + """One problem found with the request.""" + + code = serializers.CharField(help_text="Machine-readable problem identifier.") + detail = serializers.CharField(help_text="Human-readable description.") + attr = serializers.CharField( + allow_null=True, + help_text="The request field the problem belongs to, when it belongs to one.", + ) + + +#: Named so the generated enum is not called after the field that holds it. +ERROR_TYPES = ("validation_error", "client_error", "server_error") + + +class ErrorResponse(serializers.Serializer): + """The body of a rejected request. + + Produced by the project-wide exception handler, so its shape is the same + for every failure listed against an operation. + """ + + # `code` is left free-form rather than enumerated: the deployment + # exceptions carry DRF's default code, not the per-status codes the + # standardized-errors package assumes. + type = serializers.ChoiceField(choices=ERROR_TYPES) + errors = ErrorDetail(many=True) + + +# Restates the route's own pattern so a client rejects a mistyped identifier +# without a round trip. +PATH_SEGMENT = {"type": "string", "pattern": r"^[\w-]+$"} + +DEPLOYMENT_PATH_PARAMETERS = [ + OpenApiParameter( + "org_name", + PATH_SEGMENT, + OpenApiParameter.PATH, + description="Organization identifier.", + ), + OpenApiParameter( + "api_name", + PATH_SEGMENT, + OpenApiParameter.PATH, + description="API deployment name.", + ), +] + + +DEPLOYMENT_AUTH = [{"deploymentKey": []}] + +# A client generated without these treats an authentication or authorization +# response as an unknown status and has nothing to branch on. The descriptions +# name what the caller can act on rather than a single cause, because a +# document store consulted during the call can surface its own status here. +DEPLOYMENT_ERRORS = { + 400: OpenApiResponse(ErrorResponse, description="The request failed validation."), + 401: OpenApiResponse( + ErrorResponse, description="No usable API key was supplied for the deployment." + ), + 403: OpenApiResponse( + ErrorResponse, description="The request was refused as unauthorized." + ), + 404: OpenApiResponse( + ErrorResponse, + description="No active deployment, or a referenced document, was found.", + ), +} + +# Only the execution endpoint fetches documents and takes a rate-limit slot, so +# these cannot arise on the status read. +EXECUTE_ERRORS = { + 413: OpenApiResponse( + ErrorResponse, description="A referenced document is larger than the limit." + ), + 429: OpenApiResponse( + ErrorResponse, description="Too many concurrent executions; retry later." + ), + 502: OpenApiResponse( + ErrorResponse, description="A referenced document could not be fetched." + ), + 504: OpenApiResponse( + ErrorResponse, description="Fetching a referenced document timed out." + ), +} + +EXECUTE_DESCRIPTION = ( + "Execute an API deployment against one or more documents.\n\n" + "Supply the documents either as `files` (multipart upload) or as " + "`presigned_urls` (HTTPS S3 URLs), or both — a request carrying neither is " + f"rejected, and the two together may not exceed " + f"{ExecutionRequestSerializer.MAX_FILES_ALLOWED} documents.\n\n" + "With the default `timeout` of -1 the call returns as soon as the " + "execution is queued; read the outcome from the status endpoint." +) + +STATUS_DESCRIPTION = ( + "Read the result of a previously started execution.\n\n" + "This read is one-shot: the first call that observes a completed execution " + "acknowledges it and the stored result is discarded, so every later call " + "for that execution answers 406. Poll while the execution is pending, and " + "keep the payload of the call that returns it — it cannot be fetched again." + "\n\nA still-running execution answers 422 carrying its current `status`, " + "so a polling loop should treat 422 as the normal reply and stop on 200. " + "Clients that raise on any non-2xx need to allow for that." +) + + +# Generated clients take their command names, module paths and request shapes +# from here, so this is part of the public API surface. +DEPLOYMENT_EXECUTION_SCHEMA = extend_schema_view( + post=extend_schema( + operation_id="execute", + tags=["deployment"], + auth=DEPLOYMENT_AUTH, + parameters=DEPLOYMENT_PATH_PARAMETERS, + request={"multipart/form-data": ExecuteRequest}, + responses={ + 200: ExecuteResponse, + 422: OpenApiResponse( + ExecuteResponse, description="The execution finished with an error." + ), + 500: OpenApiResponse( + ExecuteResponse, + description="The deployment could not be run; the body carries the " + "execution that failed.", + ), + **DEPLOYMENT_ERRORS, + **EXECUTE_ERRORS, + }, + description=EXECUTE_DESCRIPTION, + ), + get=extend_schema( + operation_id="status", + tags=["deployment"], + auth=DEPLOYMENT_AUTH, + parameters=DEPLOYMENT_PATH_PARAMETERS + [ExecutionQuerySerializer], + responses={ + 200: StatusResponse, + 406: OpenApiResponse( + AcknowledgedResponse, + description="The result was already consumed by an earlier call.", + ), + 422: OpenApiResponse( + StatusResponse, + description="The execution is still running, or it finished with an " + "error; read `status` to tell them apart.", + ), + 500: OpenApiResponse( + StatusResponse, + description="The execution could not be completed; the body carries " + "its last known state.", + ), + **DEPLOYMENT_ERRORS, + }, + description=STATUS_DESCRIPTION, + ), +) diff --git a/backend/api_v2/serializers.py b/backend/api_v2/serializers.py index 3db7f53db6..a8703f01d1 100644 --- a/backend/api_v2/serializers.py +++ b/backend/api_v2/serializers.py @@ -6,6 +6,8 @@ from django.apps import apps from django.core.validators import RegexValidator +from drf_spectacular.types import OpenApiTypes +from drf_spectacular.utils import extend_schema_field from pipeline_v2.models import Pipeline from prompt_studio.prompt_profile_manager_v2.models import ProfileManager from rest_framework import serializers @@ -218,6 +220,13 @@ def to_representation(self, instance: APIKey) -> OrderedDict[str, Any]: return representation +@extend_schema_field(OpenApiTypes.BINARY) +class UploadField(FileField): + """A bare ``FileField`` maps to ``format: uri`` -- correct on output, wrong + for a multipart upload, and generators emit ``str`` for it. + """ + + class ExecutionRequestSerializer(TagParamsSerializer): """Execution request serializer. @@ -256,8 +265,27 @@ class ExecutionRequestSerializer(TagParamsSerializer): presigned_urls = ListField(child=URLField(), required=False) llm_profile_id = CharField(required=False, allow_null=True, allow_blank=True) - hitl_queue_name = CharField(required=False, allow_null=True, allow_blank=True) - hitl_packet_id = CharField(required=False, allow_null=True, allow_blank=True) + # Help text is published as the client-facing description of these fields. + hitl_queue_name = CharField( + required=False, + allow_null=True, + allow_blank=True, + help_text=( + "Document class name for the manual review queue. Requires the " + "enterprise manual-review capability; an installation without it " + "rejects the request with 400." + ), + ) + hitl_packet_id = CharField( + required=False, + allow_null=True, + allow_blank=True, + help_text=( + "Groups documents reviewed together into one packet. Requires the " + "enterprise manual-review capability; an installation without it " + "rejects the request with 400." + ), + ) custom_data = JSONField(required=False, allow_null=True) def validate_hitl_queue_name(self, value: str | None) -> str | None: @@ -320,7 +348,7 @@ def validate_custom_data(self, value): return value files = ListField( - child=FileField(), + child=UploadField(), required=False, allow_empty=True, ) diff --git a/backend/api_v2/tests/test_docstudio_spec.py b/backend/api_v2/tests/test_docstudio_spec.py new file mode 100644 index 0000000000..218975c969 --- /dev/null +++ b/backend/api_v2/tests/test_docstudio_spec.py @@ -0,0 +1,256 @@ +"""The committed spec is the contract the published clients are generated from. + +A route, serializer or schema-annotation change that is not regenerated ships a +spec describing an API the server no longer serves, so drift fails here rather +than in a client repo. + +Drift alone would pass on a spec that is uniformly wrong, so the tests below +also anchor the parts a client breaks on -- the upload encoding, the nullable +result, the error body -- to the code that produces them. +""" + +import dataclasses +import json + +import pytest +from django.core.management import call_command +from django.core.management.base import CommandError +from django.urls import resolve, reverse +from drf_spectacular.drainage import warn +from drf_spectacular.generators import SchemaGenerator +from middleware.exception import drf_logging_exc_handler +from rest_framework.exceptions import APIException, ValidationError +from rest_framework.test import APIRequestFactory +from workflow_manager.endpoint_v2.dto import FileExecutionResult +from workflow_manager.workflow_v2.dto import ExecutionResponse + +from api_v2.management.commands.generate_docstudio_spec import ( + DEFAULT_OUT, + DOWNSTREAM, + REGENERATE, + SpecGenerationFailed, + render_spec, +) +from api_v2.serializers import APIExecutionResponseSerializer + +#: Keys under a path item that are operations. The rest -- `parameters`, +#: `summary`, vendor extensions -- describe the path, not a call. +_METHODS = ("get", "put", "post", "delete", "options", "head", "patch", "trace") + +#: Documented on a file result but absent from the DTO: the workflow copies it +#: up from the extraction metadata when the request asks for it. +_PROMOTED_FILE_RESULT_FIELDS = {"extracted_text"} + + +def _committed() -> dict: + return json.loads(DEFAULT_OUT.read_text()) + + +def _schema(name: str) -> dict: + return _committed()["components"]["schemas"][name] + + +def _operations(spec: dict) -> list[tuple[str, str, dict]]: + """Every (path, method, operation) the spec documents. + + The spec grows an endpoint at a time, and a check written against exactly + one of them fails on the next addition without anything being wrong. + """ + operations = [ + (path, method, operation) + for path, path_item in spec["paths"].items() + for method, operation in path_item.items() + if method in _METHODS + ] + assert operations, "the spec documents no operation at all" + return operations + + +def test_committed_spec_matches_the_code() -> None: + assert DEFAULT_OUT.exists(), f"{DEFAULT_OUT} is missing" + assert DEFAULT_OUT.read_text() == render_spec(), ( + f"{DEFAULT_OUT} is out of date. Run `{REGENERATE}` from `backend/` and " + f"commit the result.\n\n{DOWNSTREAM}" + ) + + +def test_a_generator_diagnostic_fails_generation(monkeypatch) -> None: + """An operation spectacular could not resolve is published empty rather + than dropped, so the drift comparison would certify the gap. + """ + + def guessing_generator(self, request=None, public=False) -> dict: + warn("unable to guess serializer") + return {"openapi": "3.0.3", "paths": {}} + + monkeypatch.setattr(SchemaGenerator, "get_schema", guessing_generator) + + with pytest.raises(SpecGenerationFailed, match="unable to guess serializer"): + render_spec() + + +def test_spec_paths_are_the_urls_the_server_serves() -> None: + """Resolves the real mount rather than restating it: a spec generated for + URLs the server does not serve is the failure this file exists to catch. + """ + served = reverse( + "api_deployment_execution", kwargs={"org_name": "ORG", "api_name": "API"} + ) + documented = [ + path.replace("{org_name}", "ORG").replace("{api_name}", "API") + for path in _committed()["paths"] + ] + + assert served.rstrip("/") in [path.rstrip("/") for path in documented] + for path in documented: + # Raises Resolver404 if the spec documents a URL nothing answers. + resolve(path if path.endswith("/") else f"{path}/") + + +def test_spec_documents_the_deployment_operations() -> None: + spec = _committed() + documented = {operation["operationId"] for _, _, operation in _operations(spec)} + + assert {"execute", "status"} <= documented + assert "deployment" in [tag["name"] for tag in spec["tags"]] + + +def test_operations_require_the_deployment_key() -> None: + """Without this the unset DRF authentication default is published as + though it were a decision, and no generated client can authenticate. + """ + spec = _committed() + scheme = spec["components"]["securitySchemes"]["deploymentKey"] + + assert (scheme["type"], scheme["scheme"]) == ("http", "bearer") + for path, method, operation in _operations(spec): + assert operation["security"] == [{"deploymentKey": []}], f"{method} {path}" + + +def test_clients_can_branch_on_every_failure_they_will_see() -> None: + for path, method, operation in _operations(_committed()): + assert {"400", "401", "403", "404", "500"} <= set( + operation["responses"] + ), f"{method} {path}" + + +def test_only_the_execution_endpoint_documents_the_statuses_only_it_returns() -> None: + """Fetching a document and taking a rate-limit slot happen on the execute + call alone, so declaring them on the status read hands clients branches + that can never be taken. + """ + fetch_and_rate_limit = {"413", "429", "502", "504"} + for _, _, operation in _operations(_committed()): + declared = fetch_and_rate_limit & set(operation["responses"]) + if operation["operationId"] == "execute": + assert declared == fetch_and_rate_limit + else: + assert not declared + + +def test_the_one_shot_read_is_documented_where_a_client_will_see_it() -> None: + """The semantics that a status read destroys the result must reach the + generated client, not live in a source comment. + """ + reads = [ + operation + for _, _, operation in _operations(_committed()) + if operation["operationId"] == "status" + ] + + assert reads + for status_op in reads: + assert "one-shot" in status_op["description"] + # A pending poll answers 422, so a client that raises on non-2xx needs + # to be told before it wraps this endpoint in a loop. + assert "422" in status_op["description"] + assert status_op["responses"]["406"]["description"].strip() + + +def test_documents_are_uploaded_as_binary_not_as_urls() -> None: + """A bare DRF FileField documents as `format: uri`, which generators turn + into a string parameter and no multipart upload. + """ + files = _schema("ExecuteRequest")["properties"]["files"] + + assert files["items"] == {"type": "string", "format": "binary"} + + +def test_the_result_a_pending_execution_omits_is_documented_nullable() -> None: + """Both endpoints send `result: null` until the execution finishes, and a + generated deserialiser iterates that field. + """ + assert _schema("ExecutionMessage")["properties"]["result"]["nullable"] is True + assert _schema("StatusResponse")["properties"]["message"]["nullable"] is True + + +def test_the_documented_response_fields_are_ones_the_code_produces() -> None: + """`APIExecutionResponseSerializer` builds the live execute response, so a + field documented here that the DTO no longer carries reaches clients as a + field the server never sends. + """ + documented = set(APIExecutionResponseSerializer().get_fields()) + produced = {field.name for field in dataclasses.fields(ExecutionResponse)} + + assert documented <= produced, documented - produced + + +def test_the_documented_file_result_fields_are_ones_the_code_produces() -> None: + documented = set(_schema("FileResult")["properties"]) + produced = { + field.name for field in dataclasses.fields(FileExecutionResult) + } | _PROMOTED_FILE_RESULT_FIELDS + + assert documented <= produced, documented - produced + + +def test_the_status_read_documents_the_two_keys_it_returns() -> None: + """The status view builds its body literally, so the spec is the only + place the pair is written down. + """ + status_response = _schema("StatusResponse") + + assert set(status_response["properties"]) == {"status", "message"} + assert status_response["properties"]["message"]["items"]["$ref"].endswith( + "/FileResult" + ) + + +@pytest.mark.parametrize( + "exc", + [APIException("Unauthorized"), ValidationError("at least one file is required")], +) +def test_the_documented_error_body_is_the_one_the_handler_sends(exc) -> None: + """The error shape comes from the project-wide exception handler, not from + any view, so nothing else in the spec moves when that handler changes. + """ + request = APIRequestFactory().post("/deployment/api/org/api/") + response = drf_logging_exc_handler(exc=exc, context={"request": request}) + + error_response = _schema("ErrorResponse") + error_detail = _schema("ErrorDetail") + + assert set(response.data) == set(error_response["required"]) + assert response.data["type"] in _schema("ErrorType")["enum"] + for error in response.data["errors"]: + assert set(error) == set(error_detail["required"]) + + +def test_the_check_flag_passes_on_the_committed_spec() -> None: + call_command("generate_docstudio_spec", "--check") + + +def test_the_check_flag_fails_on_a_drifted_spec(tmp_path) -> None: + drifted = tmp_path / "drifted.json" + drifted.write_text("{}\n") + + with pytest.raises(CommandError, match="out of date"): + call_command("generate_docstudio_spec", "--check", "--out", str(drifted)) + + +def test_writing_the_spec_reproduces_the_committed_file(tmp_path) -> None: + written = tmp_path / "nested" / "spec.json" + + call_command("generate_docstudio_spec", "--out", str(written)) + + assert written.read_text() == DEFAULT_OUT.read_text() diff --git a/backend/backend/public_urls.py b/backend/backend/public_urls.py index 2ca815442e..3d9a8130a2 100644 --- a/backend/backend/public_urls.py +++ b/backend/backend/public_urls.py @@ -28,8 +28,6 @@ path(f"{path_prefix}/", include("account.urls")), # Connector OAuth path(f"{path_prefix}/", include("connector_auth.urls")), - # Docs - path(f"{path_prefix}/", include("docs.urls")), # API deployment path(f"{api_path_prefix}/", include("api.urls")), path(f"{api_path_prefix}/pipeline/", include("pipeline.public_api_urls")), diff --git a/backend/backend/public_urls_v2.py b/backend/backend/public_urls_v2.py index 7034e86141..336ea9cdbc 100644 --- a/backend/backend/public_urls_v2.py +++ b/backend/backend/public_urls_v2.py @@ -25,8 +25,6 @@ path("", include("account_v2.urls")), # Connector OAuth path("", include("connector_auth_v2.urls")), - # Docs - path("", include("docs.urls")), # Feature flags path("flags/", include("feature_flag.urls")), # Pipeline diff --git a/backend/backend/settings/base.py b/backend/backend/settings/base.py index d14f87b304..6edee88d73 100644 --- a/backend/backend/settings/base.py +++ b/backend/backend/settings/base.py @@ -371,9 +371,6 @@ def filter(self, record): # Connector OAuth # "connector_auth", "social_django", - # Doc generator - "drf_yasg", - "docs", # Plugins "plugins.apps.PluginsConfig", "feature_flag", @@ -653,6 +650,44 @@ def filter(self, record): "DEFAULT_VERSION": "v1", "ALLOWED_VERSIONS": ["v1"], "VERSION_PARAM": "version", + # The standardized-errors variant, because EXCEPTION_HANDLER above + # delegates to that package: it is the schema class that knows the error + # bodies these views actually return. + "DEFAULT_SCHEMA_CLASS": "drf_standardized_errors.openapi.AutoSchema", +} + +# Read only while generating the OpenAPI spec +# (``manage.py generate_docstudio_spec``); no effect at request time. +SPECTACULAR_SETTINGS = { + "TITLE": "Unstract API", + "VERSION": "v1", + "PREPROCESSING_HOOKS": ["drf_spectacular.hooks.preprocess_exclude_path_format"], + "SERVE_INCLUDE_SCHEMA": False, + # Declared, because DRF's unset authentication default is otherwise + # introspected as a decision and publishes auth these endpoints reject. + "APPEND_COMPONENTS": { + "securitySchemes": { + "deploymentKey": { + "type": "http", + "scheme": "bearer", + "description": "The API deployment's own key.", + } + } + }, + # Without this the enum component is named after the field that holds it, + # and generated clients get a class called `TypeEnum`. + "ENUM_NAME_OVERRIDES": {"ErrorType": "api_v2.openapi_schema.ERROR_TYPES"}, + # Group descriptions generated clients show in their help; without this + # the spec has no root `tags` array for the text to live in. + "TAGS": [ + { + "name": "deployment", + "description": ( + "Run an API deployment against one or more documents and poll " + "the result." + ), + } + ], } # These paths will work without authentication @@ -677,13 +712,6 @@ def filter(self, record): # These path will work without organization in request ORGANIZATION_MIDDLEWARE_WHITELISTED_PATHS = [] -# API Doc Generator Settings -# https://drf-yasg.readthedocs.io/en/stable/settings.html -REDOC_SETTINGS = { - "PATH_IN_MIDDLE": True, - "REQUIRED_PROPS_FIRST": True, -} - # Social Auth Settings SOCIAL_AUTH_LOGIN_REDIRECT_URL = f"{WEB_APP_ORIGIN_URL}/oauth-status/?status=success" SOCIAL_AUTH_LOGIN_ERROR_URL = f"{WEB_APP_ORIGIN_URL}/oauth-status/?status=error" diff --git a/backend/docs/__init__.py b/backend/docs/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/backend/docs/urls.py b/backend/docs/urls.py deleted file mode 100644 index 83260b01db..0000000000 --- a/backend/docs/urls.py +++ /dev/null @@ -1,20 +0,0 @@ -from django.urls import path -from drf_yasg import openapi -from drf_yasg.views import get_schema_view - -schema_view = get_schema_view( - openapi.Info( - title="Unstract APIs", - default_version="v1", - description="", - ), - public=False, -) - -urlpatterns = [ - path( - "doc/", - schema_view.with_ui("redoc", cache_timeout=0), - name="schema-redoc", - ), -] diff --git a/backend/mcp_server/views.py b/backend/mcp_server/views.py index 53ef1f4781..1ff6015646 100644 --- a/backend/mcp_server/views.py +++ b/backend/mcp_server/views.py @@ -14,6 +14,7 @@ from typing import Any from api_v2.deployment_helper import DeploymentHelper +from drf_spectacular.utils import extend_schema from rest_framework.request import Request from mcp_server.context import MCPContext @@ -23,6 +24,10 @@ logger = logging.getLogger(__name__) +# MCP speaks JSON-RPC over one POST, so it has no REST surface worth +# describing; leaving it in would fail spec generation, which treats any +# generator diagnostic as fatal and cannot resolve a serializer for this view. +@extend_schema(exclude=True) class MCPServerView(BaseMCPView): """MCP JSON-RPC endpoint for a single API deployment. diff --git a/backend/pyproject.toml b/backend/pyproject.toml index 7eee250b9b..c1ca5b9ed4 100644 --- a/backend/pyproject.toml +++ b/backend/pyproject.toml @@ -27,7 +27,9 @@ dependencies = [ "django-redis==5.4.0", "django-tenants==3.5.0", "drf-standardized-errors>=0.12.6", - "drf-yasg>=1.21.8", # For API docs + # Pinned: its rendering is the committed spec, so an upgrade rewrites the + # contract published clients are generated from. + "drf-spectacular==0.30.0", "psycopg2-binary==2.9.9", "python-dotenv==1.2.2", "python-magic==0.4.27", # For file upload/download diff --git a/backend/uv.lock b/backend/uv.lock index 8faed9138c..5f7fe242e7 100644 --- a/backend/uv.lock +++ b/backend/uv.lock @@ -901,34 +901,33 @@ wheels = [ ] [[package]] -name = "drf-standardized-errors" -version = "0.15.0" +name = "drf-spectacular" +version = "0.30.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "django" }, { name = "djangorestframework" }, + { name = "inflection" }, + { name = "jsonschema" }, + { name = "pyyaml" }, + { name = "uritemplate" }, ] -sdist = { url = "https://files.pythonhosted.org/packages/ea/5d/9301be05081261cebdc000f9fbad51dc2b2732f9decd8da693f7c2daae29/drf_standardized_errors-0.15.0.tar.gz", hash = "sha256:83112d072e751eb444c2f16ab4618273b912cffc07f12b81998060fdfa2eb655", size = 60729 } +sdist = { url = "https://files.pythonhosted.org/packages/50/43/41d25039a6a53545420ebc98eb9f877ec9fe30c7bd03fefabcaf9b953af7/drf_spectacular-0.30.0.tar.gz", hash = "sha256:53e79e7ba00e240441b63c32273754a5368e4c2ab44a19f2595277cc1cd559c9", size = 252311 } wheels = [ - { url = "https://files.pythonhosted.org/packages/62/94/4e7721ff51cb10aa826cb27f3bf015e8d94d7f898c19c2b650d822019e5b/drf_standardized_errors-0.15.0-py3-none-any.whl", hash = "sha256:75dcfec11433a16c81f8c5948a5cd2932cd5b02f426f64ca82020a78c155b263", size = 25673 }, + { url = "https://files.pythonhosted.org/packages/c3/56/74dd7b45bbde6d24494220b98d6961cb1200b63a1800332b430daa2c4551/drf_spectacular-0.30.0-py3-none-any.whl", hash = "sha256:006cf5921ebe20a9bd24f7c846261ebbf78780be5961b0d6e87afaa82afd62ff", size = 111150 }, ] [[package]] -name = "drf-yasg" -version = "1.21.15" +name = "drf-standardized-errors" +version = "0.15.0" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "django" }, { name = "djangorestframework" }, - { name = "inflection" }, - { name = "packaging" }, - { name = "pytz" }, - { name = "pyyaml" }, - { name = "uritemplate" }, ] -sdist = { url = "https://files.pythonhosted.org/packages/4a/88/345135459b9cbaff0e8ee3270819e89ca92064a35a0a94a1cfce41c084db/drf_yasg-1.21.15.tar.gz", hash = "sha256:ef86838c4ef10dcd3ac1ebf2be601cbe02978b999671caa43667f7c9db961468", size = 5153419 } +sdist = { url = "https://files.pythonhosted.org/packages/ea/5d/9301be05081261cebdc000f9fbad51dc2b2732f9decd8da693f7c2daae29/drf_standardized_errors-0.15.0.tar.gz", hash = "sha256:83112d072e751eb444c2f16ab4618273b912cffc07f12b81998060fdfa2eb655", size = 60729 } wheels = [ - { url = "https://files.pythonhosted.org/packages/f9/a4/400b0565cf25395f1d5e1a24e5d18dab8f4199e4212174341fea6f05747c/drf_yasg-1.21.15-py3-none-any.whl", hash = "sha256:7c7a7ab9feb0e13cdd6e25147d99adb0500a68bd96509ffd8f8cf7efd4bdc77e", size = 4856209 }, + { url = "https://files.pythonhosted.org/packages/62/94/4e7721ff51cb10aa826cb27f3bf015e8d94d7f898c19c2b650d822019e5b/drf_standardized_errors-0.15.0-py3-none-any.whl", hash = "sha256:75dcfec11433a16c81f8c5948a5cd2932cd5b02f426f64ca82020a78c155b263", size = 25673 }, ] [[package]] @@ -3709,8 +3708,8 @@ dependencies = [ { name = "django-redis" }, { name = "django-tenants" }, { name = "djangorestframework" }, + { name = "drf-spectacular" }, { name = "drf-standardized-errors" }, - { name = "drf-yasg" }, { name = "google-cloud-recaptcha-enterprise" }, { name = "gunicorn" }, { name = "httpx" }, @@ -3776,8 +3775,8 @@ requires-dist = [ { name = "django-redis", specifier = "==5.4.0" }, { name = "django-tenants", specifier = "==3.5.0" }, { name = "djangorestframework", specifier = "==3.17.1" }, + { name = "drf-spectacular", specifier = "==0.30.0" }, { name = "drf-standardized-errors", specifier = ">=0.12.6" }, - { name = "drf-yasg", specifier = ">=1.21.8" }, { name = "google-cloud-recaptcha-enterprise", specifier = ">=1.28.2" }, { name = "gunicorn", specifier = ">=23.0.0" }, { name = "httpx", specifier = ">=0.27.0" }, diff --git a/specs/docstudio-oss.json b/specs/docstudio-oss.json new file mode 100644 index 0000000000..c7f8ebb4b0 --- /dev/null +++ b/specs/docstudio-oss.json @@ -0,0 +1,722 @@ +{ + "components": { + "schemas": { + "AcknowledgedResponse": { + "description": "The execution's result was handed to an earlier call and discarded.", + "properties": { + "message": { + "type": "string" + }, + "status": { + "type": "string" + } + }, + "required": [ + "message", + "status" + ], + "type": "object" + }, + "ErrorDetail": { + "description": "One problem found with the request.", + "properties": { + "attr": { + "description": "The request field the problem belongs to, when it belongs to one.", + "nullable": true, + "type": "string" + }, + "code": { + "description": "Machine-readable problem identifier.", + "type": "string" + }, + "detail": { + "description": "Human-readable description.", + "type": "string" + } + }, + "required": [ + "attr", + "code", + "detail" + ], + "type": "object" + }, + "ErrorResponse": { + "description": "The body of a rejected request.\n\nProduced by the project-wide exception handler, so its shape is the same\nfor every failure listed against an operation.", + "properties": { + "errors": { + "items": { + "$ref": "#/components/schemas/ErrorDetail" + }, + "type": "array" + }, + "type": { + "$ref": "#/components/schemas/ErrorType" + } + }, + "required": [ + "errors", + "type" + ], + "type": "object" + }, + "ErrorType": { + "description": "* `validation_error` - validation_error\n* `client_error` - client_error\n* `server_error` - server_error", + "enum": [ + "validation_error", + "client_error", + "server_error" + ], + "type": "string" + }, + "ExecuteRequest": { + "description": "The documents to run, and the options that shape the result.\n\nSupply `files`, `presigned_urls`, or both.", + "properties": { + "custom_data": { + "nullable": true + }, + "files": { + "items": { + "format": "binary", + "type": "string" + }, + "type": "array" + }, + "hitl_packet_id": { + "description": "Groups documents reviewed together into one packet. Requires the enterprise manual-review capability; an installation without it rejects the request with 400.", + "nullable": true, + "type": "string" + }, + "hitl_queue_name": { + "description": "Document class name for the manual review queue. Requires the enterprise manual-review capability; an installation without it rejects the request with 400.", + "nullable": true, + "type": "string" + }, + "include_extracted_text": { + "default": false, + "type": "boolean" + }, + "include_metadata": { + "default": false, + "type": "boolean" + }, + "include_metrics": { + "default": false, + "type": "boolean" + }, + "llm_profile_id": { + "nullable": true, + "type": "string" + }, + "presigned_urls": { + "items": { + "format": "uri", + "type": "string" + }, + "type": "array" + }, + "tags": { + "default": "", + "description": "Comma-separated list of tag names (EX:'tag1,tag2-name,tag3_name')", + "type": "string" + }, + "timeout": { + "default": -1, + "maximum": 300, + "minimum": -1, + "type": "integer" + }, + "use_file_history": { + "default": false, + "type": "boolean" + } + }, + "type": "object" + }, + "ExecuteResponse": { + "properties": { + "message": { + "$ref": "#/components/schemas/ExecutionMessage" + } + }, + "required": [ + "message" + ], + "type": "object" + }, + "ExecutionMessage": { + "description": "The execution's identity and, once it has finished, its per-file\nresults.", + "properties": { + "error": { + "nullable": true, + "type": "string" + }, + "execution_id": { + "type": "string" + }, + "execution_status": { + "type": "string" + }, + "result": { + "items": { + "$ref": "#/components/schemas/FileResult" + }, + "nullable": true, + "type": "array" + }, + "status_api": { + "nullable": true, + "type": "string" + } + }, + "required": [ + "execution_id", + "execution_status" + ], + "type": "object" + }, + "FileResult": { + "description": "One input document's outcome.\n\nEvery key is present on every item; the ones that depend on the request\noptions or on the outcome are sent as `null` when they do not apply.", + "properties": { + "error": { + "nullable": true, + "type": "string" + }, + "extracted_text": { + "description": "The document's full extracted text. Sent only when the request set `include_extracted_text`.", + "nullable": true, + "type": "string" + }, + "file": { + "type": "string" + }, + "file_execution_id": { + "nullable": true, + "type": "string" + }, + "metadata": { + "nullable": true + }, + "result": { + "nullable": true + }, + "status": { + "type": "string" + } + }, + "required": [ + "file" + ], + "type": "object" + }, + "StatusResponse": { + "properties": { + "message": { + "items": { + "$ref": "#/components/schemas/FileResult" + }, + "nullable": true, + "type": "array" + }, + "status": { + "type": "string" + } + }, + "required": [ + "status" + ], + "type": "object" + } + }, + "securitySchemes": { + "deploymentKey": { + "description": "The API deployment's own key.", + "scheme": "bearer", + "type": "http" + } + } + }, + "info": { + "title": "Unstract API", + "version": "v1" + }, + "openapi": "3.0.3", + "paths": { + "/deployment/api/{org_name}/{api_name}/": { + "get": { + "description": "Read the result of a previously started execution.\n\nThis read is one-shot: the first call that observes a completed execution acknowledges it and the stored result is discarded, so every later call for that execution answers 406. Poll while the execution is pending, and keep the payload of the call that returns it \u2014 it cannot be fetched again.\n\nA still-running execution answers 422 carrying its current `status`, so a polling loop should treat 422 as the normal reply and stop on 200. Clients that raise on any non-2xx need to allow for that.", + "operationId": "status", + "parameters": [ + { + "description": "API deployment name.", + "in": "path", + "name": "api_name", + "required": true, + "schema": { + "pattern": "^[\\w-]+$", + "type": "string" + } + }, + { + "in": "query", + "name": "execution_id", + "required": true, + "schema": { + "minLength": 1, + "type": "string" + } + }, + { + "in": "query", + "name": "include_extracted_text", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "in": "query", + "name": "include_metadata", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "in": "query", + "name": "include_metrics", + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Organization identifier.", + "in": "path", + "name": "org_name", + "required": true, + "schema": { + "pattern": "^[\\w-]+$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StatusResponse" + } + } + }, + "description": "" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "The request failed validation." + }, + "401": { + "content": { + "application/json": { + "examples": { + "AuthenticationFailed": { + "value": { + "errors": [ + { + "attr": null, + "code": "authentication_failed", + "detail": "Incorrect authentication credentials." + } + ], + "type": "client_error" + } + }, + "NotAuthenticated": { + "value": { + "errors": [ + { + "attr": null, + "code": "not_authenticated", + "detail": "Authentication credentials were not provided." + } + ], + "type": "client_error" + } + } + }, + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "No usable API key was supplied for the deployment." + }, + "403": { + "content": { + "application/json": { + "examples": { + "PermissionDenied": { + "value": { + "errors": [ + { + "attr": null, + "code": "permission_denied", + "detail": "You do not have permission to perform this action." + } + ], + "type": "client_error" + } + } + }, + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "The request was refused as unauthorized." + }, + "404": { + "content": { + "application/json": { + "examples": { + "NotFound": { + "value": { + "errors": [ + { + "attr": null, + "code": "not_found", + "detail": "Not found." + } + ], + "type": "client_error" + } + } + }, + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "No active deployment, or a referenced document, was found." + }, + "406": { + "content": { + "application/json": { + "examples": { + "NotAcceptable": { + "value": { + "errors": [ + { + "attr": null, + "code": "not_acceptable", + "detail": "Could not satisfy the request Accept header." + } + ], + "type": "client_error" + } + } + }, + "schema": { + "$ref": "#/components/schemas/AcknowledgedResponse" + } + } + }, + "description": "The result was already consumed by an earlier call." + }, + "422": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StatusResponse" + } + } + }, + "description": "The execution is still running, or it finished with an error; read `status` to tell them apart." + }, + "500": { + "content": { + "application/json": { + "examples": { + "APIException": { + "value": { + "errors": [ + { + "attr": null, + "code": "error", + "detail": "A server error occurred." + } + ], + "type": "server_error" + } + } + }, + "schema": { + "$ref": "#/components/schemas/StatusResponse" + } + } + }, + "description": "The execution could not be completed; the body carries its last known state." + } + }, + "security": [ + { + "deploymentKey": [] + } + ], + "tags": [ + "deployment" + ] + }, + "post": { + "description": "Execute an API deployment against one or more documents.\n\nSupply the documents either as `files` (multipart upload) or as `presigned_urls` (HTTPS S3 URLs), or both \u2014 a request carrying neither is rejected, and the two together may not exceed 32 documents.\n\nWith the default `timeout` of -1 the call returns as soon as the execution is queued; read the outcome from the status endpoint.", + "operationId": "execute", + "parameters": [ + { + "description": "API deployment name.", + "in": "path", + "name": "api_name", + "required": true, + "schema": { + "pattern": "^[\\w-]+$", + "type": "string" + } + }, + { + "description": "Organization identifier.", + "in": "path", + "name": "org_name", + "required": true, + "schema": { + "pattern": "^[\\w-]+$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "$ref": "#/components/schemas/ExecuteRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExecuteResponse" + } + } + }, + "description": "" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "The request failed validation." + }, + "401": { + "content": { + "application/json": { + "examples": { + "AuthenticationFailed": { + "value": { + "errors": [ + { + "attr": null, + "code": "authentication_failed", + "detail": "Incorrect authentication credentials." + } + ], + "type": "client_error" + } + }, + "NotAuthenticated": { + "value": { + "errors": [ + { + "attr": null, + "code": "not_authenticated", + "detail": "Authentication credentials were not provided." + } + ], + "type": "client_error" + } + } + }, + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "No usable API key was supplied for the deployment." + }, + "403": { + "content": { + "application/json": { + "examples": { + "PermissionDenied": { + "value": { + "errors": [ + { + "attr": null, + "code": "permission_denied", + "detail": "You do not have permission to perform this action." + } + ], + "type": "client_error" + } + } + }, + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "The request was refused as unauthorized." + }, + "404": { + "content": { + "application/json": { + "examples": { + "NotFound": { + "value": { + "errors": [ + { + "attr": null, + "code": "not_found", + "detail": "Not found." + } + ], + "type": "client_error" + } + } + }, + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "No active deployment, or a referenced document, was found." + }, + "413": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "A referenced document is larger than the limit." + }, + "422": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExecuteResponse" + } + } + }, + "description": "The execution finished with an error." + }, + "429": { + "content": { + "application/json": { + "examples": { + "Throttled": { + "value": { + "errors": [ + { + "attr": null, + "code": "throttled", + "detail": "Request was throttled." + } + ], + "type": "client_error" + } + } + }, + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "Too many concurrent executions; retry later." + }, + "500": { + "content": { + "application/json": { + "examples": { + "APIException": { + "value": { + "errors": [ + { + "attr": null, + "code": "error", + "detail": "A server error occurred." + } + ], + "type": "server_error" + } + } + }, + "schema": { + "$ref": "#/components/schemas/ExecuteResponse" + } + } + }, + "description": "The deployment could not be run; the body carries the execution that failed." + }, + "502": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "A referenced document could not be fetched." + }, + "504": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + }, + "description": "Fetching a referenced document timed out." + } + }, + "security": [ + { + "deploymentKey": [] + } + ], + "tags": [ + "deployment" + ] + } + } + }, + "tags": [ + { + "description": "Run an API deployment against one or more documents and poll the result.", + "name": "deployment" + } + ] +}