OAI / OAI/Arazzo-Specification

1.1 schema: expression-type-object requires `version`, contradicting its own description

Open Beginner friendly
#558 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

The Expression Type Object's required array still lists version, even though the description text for both the object and the version field itself say version should be optional with a type-based default:

An object used to describe the type and version of an expression used within a Criterion Object or Selector Object. If the version is omitted, a default value is assumed based on the expression type

A short hand string representing the version of the expression type. If omitted, the default for the selected type will be used.

But the schema has:

"required": ["type", "version"]

so a strictly schema-valid document can never actually omit version, even though the spec text says it should be able to. This appears to be carried over unchanged from the 1.0 schema, where version genuinely was unconditionally required — the 1.1 description text was updated to describe the new optional-with-default behavior, but required wasn't updated to match.

Suggested fix: drop "version" from expression-type-object's required array (type alone stays required).

Schema: https://spec.openapis.org/arazzo/1.1/schema/2026-04-15

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

Open the Arazzo 1.1 schema at the linked specification URL and locate the expression-type-object definition. Check its required array against the descriptions of version and the expression type object. Done means version can be omitted while type remains required, with schema validation reflecting the documented default behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
api, documentation
Issue type
Bug
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
88/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.