Ash.Type.File support - Githubissues

ash-project / ash_json_api

The JSON:API extension for the Ash Framework

https://hexdocs.pm/ash_json_api

MIT License

56 stars 40 forks source link

Ash.Type.File support #214

Closed maennchen closed 1 month ago

maennchen commented 1 month ago

Continuation of ash-project/ash#1337 ~~Based on ash main, needs a release to be merged.~~

Features

File can be provided as Base64 string in JSON body
File can be sent as part of a multipart request and referenced in JSON body

Issues

Swagger UI can't deal with additionalProperties in multipart
Swagger UI can't deal with content type that is not exactly multipart/form-data
Support is probably not great in generated clients for multipart

Future tasks

Igniter add parser to endpoint on setup

Contributor checklist

[ ] Bug fixes include regression tests
[x] Features include unit/acceptance tests

zachdaniel commented 1 month ago

Very excited about this, will take a look on Monday 🙇

zachdaniel commented 1 month ago

I think we can merge this even w/ the current issues that you've pointed out. I'm thinking the issues laid out would be things we could go forward on as opposed to requiring reworking. For example:

1 & 2. SwaggerUI - the only way forward I can think of here is for this to be resolved on swagger UIs end. We can't accept everything as multipart/form-data

we'll have to cross that bridge when we come to it.

Had one comment for discussion, and we can merge once that is settled.

zachdaniel commented 1 month ago

Alright, I think we're good to merge, and we'll roll forward on the swagger UI/codegen issues as people need to leverage these things and/or run into issues. Sound good @maennchen ?

maennchen commented 1 month ago

@zachdaniel Agreed :+1: