mirror
/
tiangolo.fastapi
mirror of https://github.com/tiangolo/fastapi
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Update schema for UploadFile (add `format: binary`)

pull/15069/head
Yurii Motov 4 months ago
parent
627c10a293
commit
506d278db7
12 changed files with 303 additions and 221 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 2
      fastapi/_compat/v2.py
  2. 6
      fastapi/datastructures.py
  3. 29
      tests/test_request_params/test_file/test_list.py
  4. 49
      tests/test_request_params/test_file/test_optional.py
  5. 29
      tests/test_request_params/test_file/test_optional_list.py
  6. 29
      tests/test_request_params/test_file/test_required.py
  7. 2
      tests/test_tutorial/test_request_files/test_tutorial001.py
  8. 2
      tests/test_tutorial/test_request_files/test_tutorial001_02.py
  9. 2
      tests/test_tutorial/test_request_files/test_tutorial001_03.py
  10. 2
      tests/test_tutorial/test_request_files/test_tutorial002.py
  11. 2
      tests/test_tutorial/test_request_files/test_tutorial003.py
  12. 2
      tests/test_tutorial/test_request_forms_and_files/test_tutorial001.py

2
fastapi/_compat/v2.py
View File

@ -53,6 +53,8 @@ class GenerateJsonSchema(_GenerateJsonSchema):
) )
if bytes_mode == "base64": if bytes_mode == "base64":
json_schema["contentEncoding"] = "base64" json_schema["contentEncoding"] = "base64"
else:
json_schema["format"] = "binary" # For compatibility with OAS 3.0
self.update_with_validations(json_schema, schema, self.ValidationsMapping.bytes) self.update_with_validations(json_schema, schema, self.ValidationsMapping.bytes)
return json_schema return json_schema

6
fastapi/datastructures.py
View File

@ -139,7 +139,11 @@ class UploadFile(StarletteUploadFile):
def __get_pydantic_json_schema__( def __get_pydantic_json_schema__(
cls, core_schema: Mapping[str, Any], handler: GetJsonSchemaHandler cls, core_schema: Mapping[str, Any], handler: GetJsonSchemaHandler
) -> dict[str, Any]: ) -> dict[str, Any]:
return {"type": "string", "contentMediaType": "application/octet-stream"} return {
"type": "string",
"format": "binary", # For compatibility with OAS 3.0
"contentMediaType": "application/octet-stream",
}
@classmethod @classmethod
def __get_pydantic_core_schema__( def __get_pydantic_core_schema__(

29
tests/test_request_params/test_file/test_list.py
View File

@ -3,6 +3,7 @@ from typing import Annotated
import pytest import pytest
from fastapi import FastAPI, File, UploadFile from fastapi import FastAPI, File, UploadFile
from fastapi.testclient import TestClient from fastapi.testclient import TestClient
from inline_snapshot import Is, snapshot
from .utils import get_body_model_name from .utils import get_body_model_name
@ -33,21 +34,24 @@ def test_list_schema(path: str):
openapi = app.openapi() openapi = app.openapi()
body_model_name = get_body_model_name(openapi, path) body_model_name = get_body_model_name(openapi, path)
assert app.openapi()["components"]["schemas"][body_model_name] == { assert app.openapi()["components"]["schemas"][body_model_name] == snapshot(
{
"properties": { "properties": {
"p": { "p": {
"type": "array", "type": "array",
"items": { "items": {
"type": "string", "type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
"title": "P", "title": "P",
}, },
}, },
"required": ["p"], "required": ["p"],
"title": body_model_name, "title": Is(body_model_name),
"type": "object", "type": "object",
} }
)
@pytest.mark.parametrize( @pytest.mark.parametrize(
@ -114,21 +118,24 @@ def test_list_alias_schema(path: str):
openapi = app.openapi() openapi = app.openapi()
body_model_name = get_body_model_name(openapi, path) body_model_name = get_body_model_name(openapi, path)
assert app.openapi()["components"]["schemas"][body_model_name] == { assert app.openapi()["components"]["schemas"][body_model_name] == snapshot(
{
"properties": { "properties": {
"p_alias": { "p_alias": {
"type": "array", "type": "array",
"items": { "items": {
"type": "string", "type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
"title": "P Alias", "title": "P Alias",
}, },
}, },
"required": ["p_alias"], "required": ["p_alias"],
"title": body_model_name, "title": Is(body_model_name),
"type": "object", "type": "object",
} }
)
@pytest.mark.parametrize( @pytest.mark.parametrize(
@ -223,21 +230,24 @@ def test_list_validation_alias_schema(path: str):
openapi = app.openapi() openapi = app.openapi()
body_model_name = get_body_model_name(openapi, path) body_model_name = get_body_model_name(openapi, path)
assert app.openapi()["components"]["schemas"][body_model_name] == { assert app.openapi()["components"]["schemas"][body_model_name] == snapshot(
{
"properties": { "properties": {
"p_val_alias": { "p_val_alias": {
"type": "array", "type": "array",
"items": { "items": {
"type": "string", "type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
"title": "P Val Alias", "title": "P Val Alias",
}, },
}, },
"required": ["p_val_alias"], "required": ["p_val_alias"],
"title": body_model_name, "title": Is(body_model_name),
"type": "object", "type": "object",
} }
)
@pytest.mark.parametrize( @pytest.mark.parametrize(
@ -343,21 +353,24 @@ def test_list_alias_and_validation_alias_schema(path: str):
openapi = app.openapi() openapi = app.openapi()
body_model_name = get_body_model_name(openapi, path) body_model_name = get_body_model_name(openapi, path)
assert app.openapi()["components"]["schemas"][body_model_name] == { assert app.openapi()["components"]["schemas"][body_model_name] == snapshot(
{
"properties": { "properties": {
"p_val_alias": { "p_val_alias": {
"type": "array", "type": "array",
"items": { "items": {
"type": "string", "type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
"title": "P Val Alias", "title": "P Val Alias",
}, },
}, },
"required": ["p_val_alias"], "required": ["p_val_alias"],
"title": body_model_name, "title": Is(body_model_name),
"type": "object", "type": "object",
} }
)
@pytest.mark.parametrize( @pytest.mark.parametrize(

49
tests/test_request_params/test_file/test_optional.py
View File

@ -3,6 +3,7 @@ from typing import Annotated
import pytest import pytest
from fastapi import FastAPI, File, UploadFile from fastapi import FastAPI, File, UploadFile
from fastapi.testclient import TestClient from fastapi.testclient import TestClient
from inline_snapshot import Is, snapshot
from .utils import get_body_model_name from .utils import get_body_model_name
@ -33,19 +34,25 @@ def test_optional_schema(path: str):
openapi = app.openapi() openapi = app.openapi()
body_model_name = get_body_model_name(openapi, path) body_model_name = get_body_model_name(openapi, path)
assert app.openapi()["components"]["schemas"][body_model_name] == { assert app.openapi()["components"]["schemas"][body_model_name] == snapshot(
{
"properties": { "properties": {
"p": { "p": {
"anyOf": [ "anyOf": [
{"type": "string", "contentMediaType": "application/octet-stream"}, {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
},
{"type": "null"}, {"type": "null"},
], ],
"title": "P", "title": "P",
} }
}, },
"title": body_model_name, "title": Is(body_model_name),
"type": "object", "type": "object",
} }
)
@pytest.mark.parametrize( @pytest.mark.parametrize(
@ -105,19 +112,25 @@ def test_optional_alias_schema(path: str):
openapi = app.openapi() openapi = app.openapi()
body_model_name = get_body_model_name(openapi, path) body_model_name = get_body_model_name(openapi, path)
assert app.openapi()["components"]["schemas"][body_model_name] == { assert app.openapi()["components"]["schemas"][body_model_name] == snapshot(
{
"properties": { "properties": {
"p_alias": { "p_alias": {
"anyOf": [ "anyOf": [
{"type": "string", "contentMediaType": "application/octet-stream"}, {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
},
{"type": "null"}, {"type": "null"},
], ],
"title": "P Alias", "title": "P Alias",
} }
}, },
"title": body_model_name, "title": Is(body_model_name),
"type": "object", "type": "object",
} }
)
@pytest.mark.parametrize( @pytest.mark.parametrize(
@ -196,19 +209,25 @@ def test_optional_validation_alias_schema(path: str):
openapi = app.openapi() openapi = app.openapi()
body_model_name = get_body_model_name(openapi, path) body_model_name = get_body_model_name(openapi, path)
assert app.openapi()["components"]["schemas"][body_model_name] == { assert app.openapi()["components"]["schemas"][body_model_name] == snapshot(
{
"properties": { "properties": {
"p_val_alias": { "p_val_alias": {
"anyOf": [ "anyOf": [
{"type": "string", "contentMediaType": "application/octet-stream"}, {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
},
{"type": "null"}, {"type": "null"},
], ],
"title": "P Val Alias", "title": "P Val Alias",
} }
}, },
"title": body_model_name, "title": Is(body_model_name),
"type": "object", "type": "object",
} }
)
@pytest.mark.parametrize( @pytest.mark.parametrize(
@ -292,19 +311,25 @@ def test_optional_alias_and_validation_alias_schema(path: str):
openapi = app.openapi() openapi = app.openapi()
body_model_name = get_body_model_name(openapi, path) body_model_name = get_body_model_name(openapi, path)
assert app.openapi()["components"]["schemas"][body_model_name] == { assert app.openapi()["components"]["schemas"][body_model_name] == snapshot(
{
"properties": { "properties": {
"p_val_alias": { "p_val_alias": {
"anyOf": [ "anyOf": [
{"type": "string", "contentMediaType": "application/octet-stream"}, {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
},
{"type": "null"}, {"type": "null"},
], ],
"title": "P Val Alias", "title": "P Val Alias",
} }
}, },
"title": body_model_name, "title": Is(body_model_name),
"type": "object", "type": "object",
} }
)
@pytest.mark.parametrize( @pytest.mark.parametrize(

29
tests/test_request_params/test_file/test_optional_list.py
View File

@ -3,6 +3,7 @@ from typing import Annotated
import pytest import pytest
from fastapi import FastAPI, File, UploadFile from fastapi import FastAPI, File, UploadFile
from fastapi.testclient import TestClient from fastapi.testclient import TestClient
from inline_snapshot import Is, snapshot
from .utils import get_body_model_name from .utils import get_body_model_name
@ -35,7 +36,8 @@ def test_optional_list_schema(path: str):
openapi = app.openapi() openapi = app.openapi()
body_model_name = get_body_model_name(openapi, path) body_model_name = get_body_model_name(openapi, path)
assert app.openapi()["components"]["schemas"][body_model_name] == { assert app.openapi()["components"]["schemas"][body_model_name] == snapshot(
{
"properties": { "properties": {
"p": { "p": {
"anyOf": [ "anyOf": [
@ -43,6 +45,7 @@ def test_optional_list_schema(path: str):
"type": "array", "type": "array",
"items": { "items": {
"type": "string", "type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
}, },
@ -51,9 +54,10 @@ def test_optional_list_schema(path: str):
"title": "P", "title": "P",
} }
}, },
"title": body_model_name, "title": Is(body_model_name),
"type": "object", "type": "object",
} }
)
@pytest.mark.parametrize( @pytest.mark.parametrize(
@ -113,7 +117,8 @@ def test_optional_list_alias_schema(path: str):
openapi = app.openapi() openapi = app.openapi()
body_model_name = get_body_model_name(openapi, path) body_model_name = get_body_model_name(openapi, path)
assert app.openapi()["components"]["schemas"][body_model_name] == { assert app.openapi()["components"]["schemas"][body_model_name] == snapshot(
{
"properties": { "properties": {
"p_alias": { "p_alias": {
"anyOf": [ "anyOf": [
@ -121,6 +126,7 @@ def test_optional_list_alias_schema(path: str):
"type": "array", "type": "array",
"items": { "items": {
"type": "string", "type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
}, },
@ -129,9 +135,10 @@ def test_optional_list_alias_schema(path: str):
"title": "P Alias", "title": "P Alias",
} }
}, },
"title": body_model_name, "title": Is(body_model_name),
"type": "object", "type": "object",
} }
)
@pytest.mark.parametrize( @pytest.mark.parametrize(
@ -205,7 +212,8 @@ def test_optional_validation_alias_schema(path: str):
openapi = app.openapi() openapi = app.openapi()
body_model_name = get_body_model_name(openapi, path) body_model_name = get_body_model_name(openapi, path)
assert app.openapi()["components"]["schemas"][body_model_name] == { assert app.openapi()["components"]["schemas"][body_model_name] == snapshot(
{
"properties": { "properties": {
"p_val_alias": { "p_val_alias": {
"anyOf": [ "anyOf": [
@ -213,6 +221,7 @@ def test_optional_validation_alias_schema(path: str):
"type": "array", "type": "array",
"items": { "items": {
"type": "string", "type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
}, },
@ -221,9 +230,10 @@ def test_optional_validation_alias_schema(path: str):
"title": "P Val Alias", "title": "P Val Alias",
} }
}, },
"title": body_model_name, "title": Is(body_model_name),
"type": "object", "type": "object",
} }
)
@pytest.mark.parametrize( @pytest.mark.parametrize(
@ -304,7 +314,8 @@ def test_optional_list_alias_and_validation_alias_schema(path: str):
openapi = app.openapi() openapi = app.openapi()
body_model_name = get_body_model_name(openapi, path) body_model_name = get_body_model_name(openapi, path)
assert app.openapi()["components"]["schemas"][body_model_name] == { assert app.openapi()["components"]["schemas"][body_model_name] == snapshot(
{
"properties": { "properties": {
"p_val_alias": { "p_val_alias": {
"anyOf": [ "anyOf": [
@ -312,6 +323,7 @@ def test_optional_list_alias_and_validation_alias_schema(path: str):
"type": "array", "type": "array",
"items": { "items": {
"type": "string", "type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
}, },
@ -320,9 +332,10 @@ def test_optional_list_alias_and_validation_alias_schema(path: str):
"title": "P Val Alias", "title": "P Val Alias",
} }
}, },
"title": body_model_name, "title": Is(body_model_name),
"type": "object", "type": "object",
} }
)
@pytest.mark.parametrize( @pytest.mark.parametrize(

29
tests/test_request_params/test_file/test_required.py
View File

@ -3,6 +3,7 @@ from typing import Annotated
import pytest import pytest
from fastapi import FastAPI, File, UploadFile from fastapi import FastAPI, File, UploadFile
from fastapi.testclient import TestClient from fastapi.testclient import TestClient
from inline_snapshot import Is, snapshot
from .utils import get_body_model_name from .utils import get_body_model_name
@ -33,18 +34,21 @@ def test_required_schema(path: str):
openapi = app.openapi() openapi = app.openapi()
body_model_name = get_body_model_name(openapi, path) body_model_name = get_body_model_name(openapi, path)
assert app.openapi()["components"]["schemas"][body_model_name] == { assert app.openapi()["components"]["schemas"][body_model_name] == snapshot(
{
"properties": { "properties": {
"p": { "p": {
"title": "P", "title": "P",
"format": "binary",
"type": "string", "type": "string",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
}, },
"required": ["p"], "required": ["p"],
"title": body_model_name, "title": Is(body_model_name),
"type": "object", "type": "object",
} }
)
@pytest.mark.parametrize( @pytest.mark.parametrize(
@ -111,18 +115,21 @@ def test_required_alias_schema(path: str):
openapi = app.openapi() openapi = app.openapi()
body_model_name = get_body_model_name(openapi, path) body_model_name = get_body_model_name(openapi, path)
assert app.openapi()["components"]["schemas"][body_model_name] == { assert app.openapi()["components"]["schemas"][body_model_name] == snapshot(
{
"properties": { "properties": {
"p_alias": { "p_alias": {
"title": "P Alias", "title": "P Alias",
"format": "binary",
"type": "string", "type": "string",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
}, },
"required": ["p_alias"], "required": ["p_alias"],
"title": body_model_name, "title": Is(body_model_name),
"type": "object", "type": "object",
} }
)
@pytest.mark.parametrize( @pytest.mark.parametrize(
@ -219,18 +226,21 @@ def test_required_validation_alias_schema(path: str):
openapi = app.openapi() openapi = app.openapi()
body_model_name = get_body_model_name(openapi, path) body_model_name = get_body_model_name(openapi, path)
assert app.openapi()["components"]["schemas"][body_model_name] == { assert app.openapi()["components"]["schemas"][body_model_name] == snapshot(
{
"properties": { "properties": {
"p_val_alias": { "p_val_alias": {
"title": "P Val Alias", "title": "P Val Alias",
"format": "binary",
"type": "string", "type": "string",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
}, },
"required": ["p_val_alias"], "required": ["p_val_alias"],
"title": body_model_name, "title": Is(body_model_name),
"type": "object", "type": "object",
} }
)
@pytest.mark.parametrize( @pytest.mark.parametrize(
@ -332,18 +342,21 @@ def test_required_alias_and_validation_alias_schema(path: str):
openapi = app.openapi() openapi = app.openapi()
body_model_name = get_body_model_name(openapi, path) body_model_name = get_body_model_name(openapi, path)
assert app.openapi()["components"]["schemas"][body_model_name] == { assert app.openapi()["components"]["schemas"][body_model_name] == snapshot(
{
"properties": { "properties": {
"p_val_alias": { "p_val_alias": {
"title": "P Val Alias", "title": "P Val Alias",
"type": "string", "type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
}, },
"required": ["p_val_alias"], "required": ["p_val_alias"],
"title": body_model_name, "title": Is(body_model_name),
"type": "object", "type": "object",
} }
)
@pytest.mark.parametrize( @pytest.mark.parametrize(

2
tests/test_tutorial/test_request_files/test_tutorial001.py
View File

@ -162,6 +162,7 @@ def test_openapi_schema(client: TestClient):
"properties": { "properties": {
"file": { "file": {
"title": "File", "title": "File",
"format": "binary",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
"type": "string", "type": "string",
} }
@ -174,6 +175,7 @@ def test_openapi_schema(client: TestClient):
"properties": { "properties": {
"file": { "file": {
"title": "File", "title": "File",
"format": "binary",
"type": "string", "type": "string",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
} }

2
tests/test_tutorial/test_request_files/test_tutorial001_02.py
View File

@ -136,6 +136,7 @@ def test_openapi_schema(client: TestClient):
"anyOf": [ "anyOf": [
{ {
"type": "string", "type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
{"type": "null"}, {"type": "null"},
@ -152,6 +153,7 @@ def test_openapi_schema(client: TestClient):
"anyOf": [ "anyOf": [
{ {
"type": "string", "type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
{"type": "null"}, {"type": "null"},

2
tests/test_tutorial/test_request_files/test_tutorial001_03.py
View File

@ -121,6 +121,7 @@ def test_openapi_schema(client: TestClient):
"properties": { "properties": {
"file": { "file": {
"title": "File", "title": "File",
"format": "binary",
"type": "string", "type": "string",
"description": "A file read as bytes", "description": "A file read as bytes",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
@ -134,6 +135,7 @@ def test_openapi_schema(client: TestClient):
"properties": { "properties": {
"file": { "file": {
"title": "File", "title": "File",
"format": "binary",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
"type": "string", "type": "string",
"description": "A file read as UploadFile", "description": "A file read as UploadFile",

2
tests/test_tutorial/test_request_files/test_tutorial002.py
View File

@ -197,6 +197,7 @@ def test_openapi_schema(client: TestClient):
"type": "array", "type": "array",
"items": { "items": {
"type": "string", "type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
} }
@ -212,6 +213,7 @@ def test_openapi_schema(client: TestClient):
"type": "array", "type": "array",
"items": { "items": {
"type": "string", "type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
} }

2
tests/test_tutorial/test_request_files/test_tutorial003.py
View File

@ -167,6 +167,7 @@ def test_openapi_schema(client: TestClient):
"type": "array", "type": "array",
"items": { "items": {
"type": "string", "type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
"description": "Multiple files as bytes", "description": "Multiple files as bytes",
@ -183,6 +184,7 @@ def test_openapi_schema(client: TestClient):
"type": "array", "type": "array",
"items": { "items": {
"type": "string", "type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
"description": "Multiple files as UploadFile", "description": "Multiple files as UploadFile",

2
tests/test_tutorial/test_request_forms_and_files/test_tutorial001.py
View File

@ -197,11 +197,13 @@ def test_openapi_schema(client: TestClient):
"properties": { "properties": {
"file": { "file": {
"title": "File", "title": "File",
"format": "binary",
"type": "string", "type": "string",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
}, },
"fileb": { "fileb": {
"title": "Fileb", "title": "Fileb",
"format": "binary",
"contentMediaType": "application/octet-stream", "contentMediaType": "application/octet-stream",
"type": "string", "type": "string",
}, },

Write Preview
Loading…
Cancel
Save