OAI / OAI/Overlay-Specification
Clearer `action` syntax
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 121
- Forks
- 38
- Avg merge
- 53m
- Merged PRs (30d)
- 6
Description
Currently the action fields are:
targetdescriptionupdateremove
Having update and remove as siblings isn't great because if remove is "true" then update does nothing, they're quite exclusive. I'm sure there's a reason it was done like this, but I really can't tell what the reason is so I'm proposing that we instead do something like:
target(as before)description(as before)typewhich can be "update" or "remove"update(as before, but only valid if type is update)
Feedback is very welcome on this idea!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named; begin by locating the current definition of the action fields. Review how the proposed type, update, and remove syntax would affect the specification, then confirm that the syntax decision and its rationale are documented.
Written by the indexing model from the issue text.
Assessment
- Domain
- backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100