swagger-api / swagger-api/swagger.io-docs

Publish JSON schemas on swagger.io

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

Nobody has claimed this yet.

Dominant language
Astro
Stars
1.6k
Forks
407
Avg merge
2m
Merged PRs (30d)
2

Description

It would be useful to have canonical URIs for JSON schemas for Swagger specifications.
I propose http://swagger.io/schemas/v{version}/schema.json (same path as in the swagger-spec repo).

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 by reviewing how the swagger-spec repository currently exposes schema files and how swagger.io-docs publishes content. Confirm the proposed http://swagger.io/schemas/v{version}/schema.json paths for each supported version, then verify that the schemas are reachable at those canonical URIs.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
documentation
Issue type
Feature
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.