OAI / OAI/Arazzo-Specification

Add additional event handler capabilities to the specification

Open
#46 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Having the following event handlers could be advantageous for steps and workflows

  • onNext
  • onCompletion

The addition would likely negate the creation of vendor specific extensions to cover similar capabilities.

Sample use-case:

  • An onNext handler could allow for pre and post step or workflow logic

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

Start by reviewing the current Arazzo specification structure and the event-handler proposal in this issue. Determine the intended semantics and scope for onNext and onCompletion, including the pre/post step or workflow use case. Done means the specification defines the capabilities consistently and resolves whether they replace vendor-specific extensions.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.