Generates OpenAPI schemas for file upload and multipart/form-data requests.
This module handles the detection and schema generation for actions that accept file uploads, generating appropriate multipart/form-data request body schemas.
An action is considered to support file uploads if any of its arguments
have a type of Ash.Type.File or if the action is explicitly marked
for file upload.
For actions with file arguments, the request body includes both
application/vnd.api+json and multipart/form-data content types:
%{
requestBody: %{
content: %{
"application/vnd.api+json" => %{
schema: json_schema
},
"multipart/form-data" => %{
schema: multipart_schema
}
}
}
}The multipart schema uses standard OpenAPI binary format:
%{
type: :object,
properties: %{
file: %{
type: :string,
format: :binary,
description: "The file to upload"
},
data: %{
type: :object,
description: "JSON:API resource data"
}
}
}# Check if an action supports file uploads
MultipartSupport.has_file_upload?(action)
# Build multipart request body schema
request_body = MultipartSupport.build_request_body(action, resource, opts)
# Build just the multipart content schema
schema = MultipartSupport.build_multipart_schema(action, opts)Builds encoding hints for multipart fields.
Builds a complete multipart content specification with encoding.
Builds the multipart/form-data schema for an action.
Builds a complete request body schema with multipart support.
Gets the file arguments from an action.
Checks if an action has any file upload arguments.
Builds encoding hints for multipart fields.
OpenAPI 3.0+ supports encoding objects that specify how each field should be serialized in multipart requests.
action - The Ash action structA map of field names to encoding specifications.
iex> MultipartSupport.build_encoding(upload_action)
%{
"avatar" => %{contentType: "application/octet-stream"},
"data" => %{contentType: "application/json"}
}Builds a complete multipart content specification with encoding.
Returns a content object suitable for direct inclusion in a request body's content map.
action - The Ash action structopts - Options keyword listA map with schema and encoding for multipart/form-data.
iex> MultipartSupport.build_multipart_content(upload_action, [])
%{
schema: %{...},
encoding: %{...}
}Builds the multipart/form-data schema for an action.
Creates an OpenAPI schema that describes the multipart form structure, including file fields and JSON data fields.
action - The Ash action structopts - Options keyword listA map representing the OpenAPI schema for multipart encoding.
iex> MultipartSupport.build_multipart_schema(upload_action, [])
%{
type: :object,
properties: %{
file: %{type: :string, format: :binary},
data: %{type: :object}
}
}Builds a complete request body schema with multipart support.
If the action has file arguments, generates a request body that supports both JSON:API and multipart/form-data content types.
action - The Ash action structresource - The Ash resource moduleopts - Options keyword list:version - OpenAPI version ("3.0" or "3.1")A map representing the OpenAPI request body object.
iex> MultipartSupport.build_request_body(upload_action, MyApp.User, [])
%{
required: true,
content: %{
"application/vnd.api+json" => %{...},
"multipart/form-data" => %{...}
}
}Gets the file arguments from an action.
Returns a list of arguments that have file types.
action - The Ash action structList of argument structs with file types.
MultipartSupport.file_arguments(upload_action)
# => [%{name: :avatar, type: Ash.Type.File, ...}]Checks if an action has any file upload arguments.
Returns true if the action has any argument of type Ash.Type.File
or any embedded type containing a file.
action - The Ash action structBoolean indicating if the action accepts file uploads.
iex> MultipartSupport.has_file_upload?(upload_action)
true
iex> MultipartSupport.has_file_upload?(simple_create_action)
false