OAI / OAI/Arazzo-Specification

Enhance the Data Types section to link the OAI Formats Registry

Open
#96 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

As per feedback comment, it would be good to enhance the Section Data Types: link to the Formats Registry, ideally per format.

This likely also needs a review of the wording within the specific format registries to be inclusive of the Workflows Specification.

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 the Data Types section in versions/1.0.0.md and compare its specific formats with the OAI Formats Registry at spec.openapis.org/registry/format/index.html. Link each applicable format and review the registry wording for inclusion of the Workflows Specification. Done means the section links to the relevant registry entries and the wording is consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.