Skip to content

Commit 6fd88c3

Browse files
mnltejaswinivbatts
authored andcommitted
Updated the extensions spec with the new discover routes
Signed-off-by: Tejaswini Duggaraju <[email protected]> Signed-off-by: Vincent Batts <[email protected]>
1 parent 0e4c0e6 commit 6fd88c3

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

ext/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ be emulated for all extensions.
1010

1111
## Table
1212

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

15-
| `$name` | Summary |
15+
| `$ns-$name` | Summary |
1616
|:------------------------:|:----------------------------------------------------:|
1717
| [ext](./ext.md) | Extensions discovering extensions on registry server |
1818

1919
## Name
2020

2121
Extension names MUST be unique. Extensions are specified by
22-
`namespace` aligning with the project, followed by the `extension` provided by the project and last by by the `component`. This constitues the URI segments
22+
`namespace` aligning with the project, followed by the `extension` provided by the project and last by by the `component`. This constitutes the URI segments
2323
of the extension endpoint. Additional options may be passed as parameters to the endpoint.
2424

2525
```http
@@ -49,8 +49,8 @@ GET /v2/<name>/_<ns>/<ext>/<component>[?<key>=<value>&...]
4949

5050
## Filename
5151

52-
Extention definitions SHOULD be placed under `./ext/`. Extension files
53-
SHOULD follow the `ext-$name.md`. Refer [ext.md](./ext.md) for more details.
52+
Extension definitions SHOULD be placed under `./ext/`. Extension files
53+
SHOULD follow the `ext-$ns-$name.md`. Refer [ext.md](./ext.md) for more details.
5454

5555
## Detail
5656

ext/ext.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Summary
44

5-
This base extension is used to discover and return an array of extensions.
5+
This base extension namespace is used to discover and return an array of extensions.
66

77
## Reference Explanation
88

@@ -12,13 +12,13 @@ extensions.
1212
Registry level extensions may be discovered with a standard GET as follows.
1313

1414
```HTTP
15-
GET /v2/_ext/
15+
GET /v2/_ext/discover
1616
```
1717

1818
Repository level extensions may be discovered with a standard GET as follows.
1919

2020
```HTTP
21-
GET /v2/{name}/_ext/
21+
GET /v2/{name}/_ext/discover
2222
```
2323

2424
The base extension returns an array of supported extensions with details of the
@@ -31,14 +31,16 @@ Content-Type: application/json
3131
3232
{
3333
"extensions: [
34-
"_<ns>/<ext>/<component>",
34+
{
35+
"name": "_<ns>/<ext>/<component>"
36+
},
3537
]
3638
}
3739
```
3840

3941
### *Extensions* Property Descriptions
4042

41-
- **`extensions`** *array of strings*
43+
- **`extensions`** *array of extension objects with properties like `name`*
4244

4345
This REQUIRED property contains a list of supported extension endpoints.
4446

0 commit comments

Comments
 (0)