Skip to content

Update extensions spec #612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jcarter3 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update extensions spec #612

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions extensions/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,13 @@ _notice_: All new `/extensions/_<extention>.md` docs MUST be added to this table
Extension names MUST be unique.
Extensions recorded in this distribution-spec are considered canonical definitions.

Extensions are specified by extension name (`<extension>`) aligning with the project, followed by the `<component>`, and last by by the `<module>`.
This constitutes the URI segments of the extension endpoint.
Extensions are specified by an underscore followed by the extension name (`_<extension>`) aligning with the project.
The rest of the URI segments are defined by the extension.
They MUST be defined in a way that prevents clashes between routes on the same extension.
Additional options may be passed as parameters to the endpoint.

The following is an example of a potential extension:

```http
_<extension>/<component>/<module>[?<key>=<value>&...]
```
Expand Down
Loading