Skip to content

Commit b501a83

Browse files
committed
extension proposal
First draft Mostly a conversation piece here, but I've sat on this for too long. Fixes #74 Signed-off-by: Vincent Batts <[email protected]>
1 parent 8817eba commit b501a83

File tree

2 files changed

+63
-0
lines changed

2 files changed

+63
-0
lines changed

ext/README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Extensions
2+
3+
The basis of the Extension API is described in a document which should be emulated for all extensions.
4+
5+
## Table of Contents
6+
7+
<!-- toc -->
8+
* [Table](#table)
9+
* [Name](#name)
10+
* [Filename](#filename)
11+
* [Detail](#detail)
12+
* [Prior Art](#prior-art)
13+
<!-- /toc -->
14+
15+
## Table
16+
17+
_notice_: All new `./ext/ext-$name.md` docs MUST be added to this table.
18+
19+
| `$name` (and definition) | Summary |
20+
|:--:|:--:|
21+
| [0](./ext-0.md) | Extensions discovering extensions on registry server |
22+
| | |
23+
24+
25+
## Name
26+
27+
Extension names MUST be unique.
28+
Names SHOULD include a version.
29+
30+
Each extension's endpoints will be nested below its name.
31+
32+
```HTTP
33+
GET /v2/ext/0/...
34+
```
35+
36+
## Filename
37+
38+
XXX
39+
40+
## Detail
41+
42+
XXX acceptable error codes
43+
44+
## Prior Art
45+
46+
When considering the proposal structure for these extensions, the following processes were considered:
47+
48+
* [Python PEP](https://www.python.org/dev/peps/)
49+
* [Kubernetes KEP](https://github.com/kubernetes/enhancements/tree/master/keps)

ext/ext-0.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# ext-0 -- Index of Distribution Extensions
2+
3+
## Table of Contents
4+
5+
<!-- toc -->
6+
* [Summary](#summary)
7+
* [Reference Explanation](#reference-explanation)
8+
<!-- /toc -->
9+
10+
## Summary
11+
12+
This base extension is to return the array of names of the extensions.
13+
14+
## Reference Explanation

0 commit comments

Comments
 (0)