External import supports binary base type

[ferozco]

Closes #579

Before this PR

After this PR

==COMMIT_MSG==
External imports can have binary as their base type
==COMMIT_MSG==

Possible downsides?

[changelog-app]

Generate changelog in changelog/@unreleased

Type

• Feature
• Improvement
• Fix
• Break
• Deprecation
• Manual task
• Migration

Description

External imports can have binary as their base type

Check the box to generate changelog(s)

• Generate changelog entry

[carterkozak]

This would be easy to misuse. We have a ton of special handling for binary streaming around dealiasing that may or may not work as expected with external type imports.

[iamdanfox]

Ok so in order to enable @mglazer to write:

types:
  imports:
    Response:
      base-type: binary
      external:
        java: javax.ws.rs.core.Response

I think we'd need to do some special-casing in the dialogue generator to just ignore external imports with base-type: binary and just code-generate InputStream instead... this feels a bit odd because everywhere else we've respected people's external imports.

[carterkozak]

It breaks conjure-undertow as well

[iamdanfox]

I think this is just what happens when you rely on things that are not inside the conjure ecosystem unfortunately :/. @mglazer is there any feasibility to use just a binary response type instead of the jaxrs one?

[mglazer]

So the reason why I switched to javax.ws.rs.Response in the first place is that I needed to set a Content-Disposition header so this particularly endpoint would be treated as an attachment endpoint. I agree this shouldn't have been made into a conjure endpoint in the first place if it's just serving an arbitrary file, but this is where we are.

What I've done for now that seems to be the only thing that works is setting jerseyBinaryAsResponse as a conjure option, which seems to work pretty well, but I suspect if we ever stop using the Jersey endpoints, something will break?

[stale]

This PR has been automatically marked as stale because it has not been touched in the last 14 days. If you'd like to keep it open, please leave a comment or add the 'long-lived' label, otherwise it'll be closed in 7 days.