OAI / OAI/Arazzo-Specification

Tighten extension model

Open
#202 12 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

It seems that Arazzo's extension model is a copy of OpenAPI:

It always seemed like OpenAPI's extension model should be tightened, and maybe at least for Arazzo we can still do it? Here are two things that I think should go into almost every extension model that tries to be both open and safe:

  • Extensions must always be safe to ignore, i.e. when interpreting or processing a description using an extension then it has to be safe to ignore the extension.
  • Extensions are not allow to alter the semantics for anything other than their own scope, i.e. they cannot change any semantics of the base specification and they also cannot change the semantics of other extensions.

In the end, I would argue that we're simply applying the principles of good API design to our own spec.

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 Arazzo's specification-extensions section and the linked OpenAPI specification-extensions section. Review the proposed safety and scope constraints alongside the 12-comment thread; done means the extension rules and resulting specification change have been explicitly decided and documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
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.