Skip to content

Commit

Permalink
content: development: extensions: more register_service fields
Browse files Browse the repository at this point in the history
  • Loading branch information
ES-Alexander committed Dec 17, 2024
1 parent 42924d4 commit 6f97686
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions content/development/extensions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,10 +267,20 @@ To do so requires the Extension to run a HTTP server[^1], at which it must serve
- The official URL for the extension
- `"api"`
- The official URL for the extension's API
- `"extra_query"` (optional)
- A string of extra query parameters to include when the extension is accessed through the sidebar
- `"avoid_iframes"` (optional)
- Boolean (`true`/`false`) specifying whether to avoid embedding the extension interface in an iframe.
- `"new_page"` (optional)
- Boolean (`true`/`false`) specifying whether to open the extension in a new page instead of in a BlueOS frame
- `"works_in_relative_paths"` (optional)
- Boolean (`true`/`false`) specifying whether the extension can be served at an arbitrary base URL
(i.e. it does not access its resources using absolute paths)
- This is required for extensions to be accessible remotely (e.g. via a cloud proxy), and is recommended for all extensions
- Makes the extension available at `/extensionv2/<sanitizeed_name>/`
- The sanitized name is the `name` field in lowercase, with all non alphanumeric characters removed
- `"extras"` (optional)
- A dictionary of string keys and values, intended for convenience use (e.g. for simplifying integration with other extensions)

As an example:
```json
Expand Down

0 comments on commit 6f97686

Please sign in to comment.