Skip to content

Describe how Arazzo handles API responses that contain files. #492

@DmitryAnansky

Description

@DmitryAnansky

Hey everyone!
I’m wondering whether the Arazzo community has already discussed how the specification should handle file responses from APIs.
I couldn’t find any open discussions on this topic so far.

There could be a variety of formats and approaches involved here.
Some file types could potentially already be consumed and processed using existing descriptions, such as .csv or .json files.
Some of the criterion object already can be applied to verify success or failure.

But overall, it seems that the specification currently lacks guidance around handling file responses.

For example:

  • How should files be treated within workflows?
  • Which file formats are expected or officially supported?
  • Should tooling decide on its own whether file contents can or should be processed?
  • Should success/failure criteria be applicable to file contents as well?

Looking forward to hearing your thoughts on this topic.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions