OAI / OAI/Arazzo-Specification

Describe how Arazzo handles API responses that contain files.

Open
#492 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
JavaScript
Stars
471
Forks
69
Avg merge
17h 58m
Merged PRs (30d)
19

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are identified in the issue. Start by reviewing the Arazzo specification sections covering workflows, API responses, and criterion objects, then seek agreement on supported file-response behavior. Done means the agreed guidance is incorporated into the specification and its examples or validation expectations are updated.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.