OAI / OAI/Outreach

Tutorial content ideas for helping users migrate to OAS 3.1

Open
#34 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
5
Forks
5
PR merge metrics
No merged PRs in 30d

Description

  • Clarify which JSON Schema properties most normal people care about vs ones for metaschema writers.
  • Describe what new capabilities JSON Schema 2019-09 brings to OAS users.

Contributor guide

No contributing guide indexed for this repository

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 two requested migration topics: practical JSON Schema properties and the JSON Schema 2019-09 capabilities relevant to OAS users. The issue names no file, test, or tutorial location; done means producing tutorial guidance that clearly covers both topics for users migrating to OAS 3.1.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.