Skip to content

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 

Repository files navigation

Roadmap

Planned and in-flight work across the API Commons organization.

This repo holds no code. It is the one place to see what is on the table across all 60+ repos — so work that spans several of them has somewhere to live, instead of being filed against whichever repo it happened to touch first.

How this is organized

Every item is an issue. Issues carry labels for the kind of work and where it sits:

Label Meaning
coverage Extending what API Commons covers — new schemas, bases, starters, rulesets
debt Known problems in what already exists
blocked Real work that cannot proceed until something specific is resolved
decision Waiting on a call, not on effort
quality Verification, CI, and keeping published things honest

Where work actually happens

Issues here describe what and why. The change lands in the repo it belongs to, and the issue links to the PR. Repo-specific work stays in its own repo — this is for anything org-wide or cross-cutting.

Three issues live in the hub rather than here, because they predate this repo and are scoped to the site:

Principles the roadmap is held to

Nothing ships ungrounded. Every ruleset quotes the specification it comes from, with a documentationUrl pointing at the section. If the primary source cannot be reached, the work is blocked — not approximated. See api-commons#10 for what that looks like in practice.

Say what is not covered. Every ruleset and schema states its residuals in the README and in the registry entry. A rule that only appears to cover something is worse than an admitted gap.

Artifacts are CC BY-NC-SA 4.0, code is Apache-2.0. Repos carrying both ship both.

Part of API Commons

The roadmap for API Commons — open specifications, schemas, and browser-first tools for the APIs you produce and consume. See everything at apicommons.org and the tools at apicommons.org/tools.

License

The artifacts in this repository — the schemas, examples, and API descriptions — are licensed CC BY-NC-SA 4.0 (Attribution–NonCommercial–ShareAlike).

API Commons licenses artifacts under CC BY-NC-SA 4.0 and code under Apache-2.0.

About

Planned and in-flight work across the API Commons organization — the one place cross-cutting work lives.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors