Skip to content
Ona API Reference
Ona Docs
API Reference

Editors

ListEditors
editors.list(EditorListParams**kwargs) -> SyncEditorsPage[Editor]
POST/gitpod.v1.EditorService/ListEditors
ResolveEditorURL
editors.resolve_url(EditorResolveURLParams**kwargs) -> EditorResolveURLResponse
POST/gitpod.v1.EditorService/ResolveEditorURL
GetEditor
editors.retrieve(EditorRetrieveParams**kwargs) -> EditorRetrieveResponse
POST/gitpod.v1.EditorService/GetEditor
ModelsExpand Collapse
class Editor: …
id: str
formatuuid
installation_instructions: str
name: str
url_template: str
alias: Optional[str]
icon_url: Optional[str]
short_description: Optional[str]
versions: Optional[List[EditorVersion]]

versions contains the list of available versions for this editor

version: str

version is the version string of the editor Examples for JetBrains: 2025.2

class EditorVersion: …
version: str

version is the version string of the editor Examples for JetBrains: 2025.2

class EditorResolveURLResponse: …
url: str

url is the resolved editor URL

class EditorRetrieveResponse: …
editor: Editor

editor contains the editor

id: str
formatuuid
installation_instructions: str
name: str
url_template: str
alias: Optional[str]
icon_url: Optional[str]
short_description: Optional[str]
versions: Optional[List[EditorVersion]]

versions contains the list of available versions for this editor

version: str

version is the version string of the editor Examples for JetBrains: 2025.2