OAI / OAI/Overlay-Specification

Multi-target support

Open
#267 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
121
Forks
38
Avg merge
53m
Merged PRs (30d)
6

Description

While using this specification, we imperatively found out that it may become too verbose. Being able to define an array of targets would greatly simplify some use cases. Was it considered?

Example

Current state:

overlay: 1.1.0
info:
  title: Targeted Overlay
  version: 1.0.0
actions:
  - target: $.paths['/foo'].get.description
    update: This is the updated description
  - target: $.paths['/bar'].get.description
    update: This is the updated description
  - target: $.paths['/baz'].get.description
    update: This is the updated description

Possible variation:

overlay: 1.1.0
info:
  title: Targeted Overlay
  version: 1.0.0
actions:
  - target:
    - $.paths['/foo'].get.description
    - $.paths['/bar'].get.description
    - $.paths['/baz'].get.description
    update: This is the new description

Disclaimer: the example above is intentionally artificial for simplicity reasons.

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 with issue #267's current and proposed YAML examples, then review the existing Overlay action and target rules to determine whether one action may contain an array of targets. Done means an agreed specification change or explicit decision, with the syntax and validation behavior documented; no file or test is named in the issue.

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.