Skip to content

Commit 6f97686

Browse files
committed
content: development: extensions: more register_service fields
1 parent 42924d4 commit 6f97686

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

content/development/extensions/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,10 +267,20 @@ To do so requires the Extension to run a HTTP server[^1], at which it must serve
267267
- The official URL for the extension
268268
- `"api"`
269269
- The official URL for the extension's API
270+
- `"extra_query"` (optional)
271+
- A string of extra query parameters to include when the extension is accessed through the sidebar
270272
- `"avoid_iframes"` (optional)
271273
- Boolean (`true`/`false`) specifying whether to avoid embedding the extension interface in an iframe.
272274
- `"new_page"` (optional)
273275
- Boolean (`true`/`false`) specifying whether to open the extension in a new page instead of in a BlueOS frame
276+
- `"works_in_relative_paths"` (optional)
277+
- Boolean (`true`/`false`) specifying whether the extension can be served at an arbitrary base URL
278+
(i.e. it does not access its resources using absolute paths)
279+
- This is required for extensions to be accessible remotely (e.g. via a cloud proxy), and is recommended for all extensions
280+
- Makes the extension available at `/extensionv2/<sanitizeed_name>/`
281+
- The sanitized name is the `name` field in lowercase, with all non alphanumeric characters removed
282+
- `"extras"` (optional)
283+
- A dictionary of string keys and values, intended for convenience use (e.g. for simplifying integration with other extensions)
274284

275285
As an example:
276286
```json

0 commit comments

Comments
 (0)