Skip to content

Commit

Permalink
extension proposal
Browse files Browse the repository at this point in the history
First draft

Mostly a conversation piece here, but I've sat on this for too long.

Fixes #74

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
  • Loading branch information
vbatts committed Oct 13, 2021
1 parent 8817eba commit b501a83
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 0 deletions.
49 changes: 49 additions & 0 deletions ext/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Extensions

The basis of the Extension API is described in a document which should be emulated for all extensions.

## Table of Contents

<!-- toc -->
* [Table](#table)
* [Name](#name)
* [Filename](#filename)
* [Detail](#detail)
* [Prior Art](#prior-art)
<!-- /toc -->

## Table

_notice_: All new `./ext/ext-$name.md` docs MUST be added to this table.

| `$name` (and definition) | Summary |
|:--:|:--:|
| [0](./ext-0.md) | Extensions discovering extensions on registry server |
| | |


## Name

Extension names MUST be unique.
Names SHOULD include a version.

Each extension's endpoints will be nested below its name.

```HTTP
GET /v2/ext/0/...
```

## Filename

XXX

## Detail

XXX acceptable error codes

## Prior Art

When considering the proposal structure for these extensions, the following processes were considered:

* [Python PEP](https://www.python.org/dev/peps/)
* [Kubernetes KEP](https://github.com/kubernetes/enhancements/tree/master/keps)
14 changes: 14 additions & 0 deletions ext/ext-0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# ext-0 -- Index of Distribution Extensions

## Table of Contents

<!-- toc -->
* [Summary](#summary)
* [Reference Explanation](#reference-explanation)
<!-- /toc -->

## Summary

This base extension is to return the array of names of the extensions.

## Reference Explanation

0 comments on commit b501a83

Please sign in to comment.