json-schema-org / json-schema-org/referencing

Clarify processing rules restrictions related to infinite recursion from reference cycles

Open
#8 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

jri
Dominant language
Makefile
Stars
9
Forks
1
PR merge metrics
No merged PRs in 30d

Description

The proposal in the handrews:jri PR contains:

## Guarding Against Infinite Recursion {#infinite}

An implementation MUST guard against infinite reference loops.

Processing rules for context specifications MAY make it safe to have cyclic references by creating conditions under which a reference will or will not be followed.

It seems problematic that and implementation MUST guard agains infinite reference loops (cycles),
but processing rules do not also have MUST make it safe. I think this needs more consideration.

If left as is, I suppose a rule could leave it unsafe (i.e. always follow references) and fall back on the implementation to guard against infinite recursion. If that is the intent, perhaps state that more explicitly.

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

Read the quoted “Guarding Against Infinite Recursion” section in the handrews:jri proposal linked from the issue. Determine whether processing rules should require safety or whether implementations alone should guard against cycles; done means the intended restriction is decided and the specification wording is updated to state it explicitly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.