diff --git a/modules/administration-guide/pages/configuring-editors-definitions.adoc b/modules/administration-guide/pages/configuring-editors-definitions.adoc index 83d6cc2c6f..e2f8cedf9d 100644 --- a/modules/administration-guide/pages/configuring-editors-definitions.adoc +++ b/modules/administration-guide/pages/configuring-editors-definitions.adoc @@ -32,7 +32,7 @@ schemaVersion: 2.2.2 # Meta information of the editor metadata: # (MANDATORY) The editor name - name: EditorName + name: editorname displayName: Display Name description: Run Editor Foo on top of Eclipse Che # (OPTIONAL) Array of tags of the current editor. The Tech-Preview tag means the option is considered experimental and is not recommended for production environments. While it can include new features and improvements, it may still contain bugs or undergo significant changes before reaching a stable version. @@ -174,6 +174,19 @@ commands: . Refresh the {prod-short} Dashboard page to see new available editor. +== Retrieving the editor definition + +The editor definition is also served by the {prod-short} dashboard API from the following URL: + +`pass:c,a,q[{prod-url}]/dashboard/api/editors/devfile?che-editor=____` + +For the example from xref:configuring-editors-definitions.adoc[], the editor definition can be retrieved by accessing the following URL: + +`pass:c,a,q[{prod-url}]/dashboard/api/editors/devfile?che-editor=publisher/editorname/version` + +TIP: When retrieving the editor definition from within the {orch-name} cluster, the {prod-short} dashboard API can be accessed via the dashboard service: +`\http://che-dashboard.{prod-namespace}.svc.cluster.local:8080/dashboard/api/editors/devfile?che-editor=____` + .Additional resources * link:https://devfile.io/docs/2.2.2/what-is-a-devfile[Devfile documentation] diff --git a/modules/end-user-guide/partials/proc_creating-workspaces.adoc b/modules/end-user-guide/partials/proc_creating-workspaces.adoc index 138858ebda..be7a0bf296 100644 --- a/modules/end-user-guide/partials/proc_creating-workspaces.adoc +++ b/modules/end-user-guide/partials/proc_creating-workspaces.adoc @@ -72,7 +72,7 @@ spec: started: true#<3> contributions:#<4> - name: ide - uri: pass:c,a,q[{prod-url}]/plugin-registry/v3/plugins/che-incubator/che-code/latest/devfile.yaml + uri: http://che-dashboard.{prod-namespace}.svc.cluster.local:8080/dashboard/api/editors/devfile?che-editor=che-incubator/che-code/latest template: projects:#<5> - name: my-project-name @@ -87,7 +87,7 @@ spec: <1> Name of the `DevWorkspace` custom resource. This will be the name of the new workspace. <2> User namespace, which is the target {orch-namespace} for the new workspace. <3> Determines whether the workspace must be started when the `DevWorkspace` custom resource is created. -<4> URL reference to the link:https://github.com/microsoft/vscode[Microsoft Visual Studio Code - Open Source] IDE devfile from the plugin registry. +<4> URL reference to the link:https://github.com/microsoft/vscode[Microsoft Visual Studio Code - Open Source] IDE devfile. <5> Details about the Git repository to clone into the workspace when it starts. <6> List of components such as workspace containers and volume components. ====