K8s-like devfile naming

core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/workspace/devfile/Devfile.java

@@ -17,14 +17,13 @@
 /** Defines Devfile. */
 public interface Devfile {
 
-  /** Returns Specification Version. It is required. */
-  String getSpecVersion();
+  /** Returns the name of the devfile. Shortcut for {@code getMetadata().getName()}. */
+  default String getName() {
+    return getMetadata() == null ? null : getMetadata().getName();
+  }
 
-  /**
-   * Returns the name of the devfile. Workspaces created from devfile, will inherit this name. It is
-   * required.
-   */
-  String getName();
+  /** Returns Devfile API Version. It is required. */
+  String getApiVersion();
 
   /**
    * Returns projects configurations which are related to the devfile, when devfile doesn't contain
@@ -46,4 +45,7 @@ public interface Devfile {
 
   /** Returns devfile attributes. Devfile attributes must not contain null keys or values. */
   Map<String, String> getAttributes();
+
+  /** Returns the metadata of the devfile. */
+  Metadata getMetadata();
 }

core/che-core-api-model/src/main/java/org/eclipse/che/api/core/model/workspace/devfile/Metadata.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2012-2018 Red Hat, Inc.
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.che.api.core.model.workspace.devfile;
+
+/** Defines the metadata of a devfile. */
+public interface Metadata {
+
+  /** @return the name of the devfile */
+  String getName();
+}

dashboard/devfile.yaml

@@ -1,5 +1,6 @@
-specVersion: 0.0.1
-name: dashboard-in-che
+apiVersion: 1.0.0
+metadata:
+  name: dashboard-in-che
 projects:
   - name: che
     source:

dashboard/src/components/typings/che.d.ts

@@ -333,12 +333,15 @@ declare namespace che {
   }
 
   export interface IWorkspaceDevfile {
-    specVersion: string;
+    apiVersion: string;
     name: string;
     components: Array<any>;
     projects?: Array <any>;
     commands?: Array <any>;
     attributes?: che.IWorkspaceConfigAttributes;
+    metadata: {
+      name: string
+    }
   }
 
   export interface IWorkspaceEnvironment {

devfile.yaml

@@ -1,5 +1,6 @@
-specVersion: 0.0.1
-name: che-in-che
+apiVersion: 1.0.0
+metadata:
+  name: che-in-che
 projects:
   - name: che
     source:

workspace-loader/devfile.yaml

@@ -1,5 +1,6 @@
-specVersion: 0.0.1
-name: workspace-loader
+apiVersion: 1.0.0
+metadata:
+  name: workspace-loader
 projects:
   - name: che
     source:

wsmaster/che-core-api-factory/src/test/java/org/eclipse/che/api/factory/server/DefaultFactoryParameterResolverTest.java

@@ -55,8 +55,9 @@ public class DefaultFactoryParameterResolverTest {
 
   private static final String DEVFILE =
       ""
-          + "specVersion: 0.0.1\n"
-          + "name: test\n"
+          + "apiVersion: 1.0.0\n"
+          + "metadata:\n"
+          + "  name: test\n"
           + "components:\n"
           + "- type: kubernetes\n"
           + "  alias: component\n"

wsmaster/che-core-api-workspace-shared/src/main/java/org/eclipse/che/api/workspace/shared/dto/devfile/DevfileDto.java

@@ -20,18 +20,11 @@
 @DTO
 public interface DevfileDto extends Devfile {
   @Override
-  String getSpecVersion();
+  String getApiVersion();
 
-  void setSpecVersion(String specVersion);
+  void setApiVersion(String apiVersion);
 
-  DevfileDto withSpecVersion(String specVersion);
-
-  @Override
-  String getName();
-
-  void setName(String name);
-
-  DevfileDto withName(String name);
+  DevfileDto withApiVersion(String apiVersion);
 
   @Override
   List<ProjectDto> getProjects();
@@ -60,4 +53,11 @@ public interface DevfileDto extends Devfile {
   void setAttributes(Map<String, String> attributes);
 
   DevfileDto withAttributes(Map<String, String> attributes);
+
+  @Override
+  MetadataDto getMetadata();
+
+  void setMetadata(MetadataDto metadata);
+
+  DevfileDto withMetadata(MetadataDto metadata);
 }

wsmaster/che-core-api-workspace-shared/src/main/java/org/eclipse/che/api/workspace/shared/dto/devfile/MetadataDto.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2012-2018 Red Hat, Inc.
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.che.api.workspace.shared.dto.devfile;
+
+import org.eclipse.che.api.core.model.workspace.devfile.Metadata;
+import org.eclipse.che.dto.shared.DTO;
+
+@DTO
+public interface MetadataDto extends Metadata {
+
+  @Override
+  String getName();
+
+  void setName(String name);
+
+  MetadataDto withName(String name);
+}

wsmaster/che-core-api-workspace/README-devfile.md

@@ -23,8 +23,9 @@ Example of the minimal devfile with project and standard plugins set (Theia edit
 ```
 
 ---
-specVersion: 0.0.1
-name: petclinic-dev-environment
+apiVersion: 0.0.1
+metadata:
+  name: petclinic-dev-environment
 projects:
   - name: petclinic
     source:
@@ -74,8 +75,9 @@ cloned to.
 As an example, consider this devfile:
 
 ```yaml
-specVersion: 0.0.1
-name: example-devfile
+apiVersion: 0.0.1
+metadata:
+  name: example-devfile
 projects:
 - name: frontend
   source:
@@ -278,8 +280,9 @@ If editor is not specified Devfile then default one will be provided. In case wh
 Default value is `false` and means that Devfile needs default editor to be provisioned if no one is defined.
 Example of Devfile without editor
 ```yaml
-specVersion: 0.0.1
-name: petclinic-dev-environment
+apiVersion: 0.0.1
+metadata:
+  name: petclinic-dev-environment
 components:
   - alias: myApp
     type: kubernetes
@@ -294,8 +297,9 @@ Sometimes it may be needed to disable data persistence for some reasons, like wh
 To achieve it the `persistVolumes` devfile attribute should be used. Default value is `true`, and in case of `false` `emptyDir` volumes will be used for configured volumes and PVC.
 Example of Devfile with ephemeral mode enabled
 ```yaml
-specVersion: 0.0.1
-name: petclinic-dev-environment
+apiVersion: 0.0.1
+metadata:
+  name: petclinic-dev-environment
 projects:
   - name: petclinic
     source:

wsmaster/che-core-api-workspace/src/main/java/org/eclipse/che/api/workspace/server/DtoConverter.java

@@ -34,6 +34,7 @@
 import org.eclipse.che.api.core.model.workspace.devfile.Endpoint;
 import org.eclipse.che.api.core.model.workspace.devfile.Entrypoint;
 import org.eclipse.che.api.core.model.workspace.devfile.Env;
+import org.eclipse.che.api.core.model.workspace.devfile.Metadata;
 import org.eclipse.che.api.core.model.workspace.devfile.Project;
 import org.eclipse.che.api.core.model.workspace.devfile.Source;
 import org.eclipse.che.api.core.model.workspace.runtime.Machine;
@@ -63,6 +64,7 @@
 import org.eclipse.che.api.workspace.shared.dto.devfile.EndpointDto;
 import org.eclipse.che.api.workspace.shared.dto.devfile.EntrypointDto;
 import org.eclipse.che.api.workspace.shared.dto.devfile.EnvDto;
+import org.eclipse.che.api.workspace.shared.dto.devfile.MetadataDto;
 import org.eclipse.che.api.workspace.shared.dto.devfile.ProjectDto;
 import org.eclipse.che.api.workspace.shared.dto.devfile.SourceDto;
 import org.eclipse.che.api.workspace.shared.dto.stack.StackComponentDto;
@@ -110,12 +112,12 @@ private static DevfileDto asDto(Devfile devfile) {
     List<ProjectDto> projects =
         devfile.getProjects().stream().map(DtoConverter::asDto).collect(toList());
     return newDto(DevfileDto.class)
-        .withName(devfile.getName())
-        .withSpecVersion(devfile.getSpecVersion())
+        .withApiVersion(devfile.getApiVersion())
         .withCommands(commands)
         .withComponents(components)
         .withProjects(projects)
-        .withAttributes(devfile.getAttributes());
+        .withAttributes(devfile.getAttributes())
+        .withMetadata(asDto(devfile.getMetadata()));
   }
 
   private static ProjectDto asDto(Project project) {
@@ -416,5 +418,10 @@ public static MachineDto asDto(Machine machine) {
     return machineDto;
   }
 
+  /** Converts {@link Metadata} to {@link MetadataDto}. */
+  public static MetadataDto asDto(Metadata metadata) {
+    return newDto(MetadataDto.class).withName(metadata.getName());
+  }
+
   private DtoConverter() {}
 }

wsmaster/che-core-api-workspace/src/main/java/org/eclipse/che/api/workspace/server/devfile/Constants.java

@@ -17,7 +17,7 @@ private Constants() {}
 
   public static final String SCHEMA_LOCATION = "schema/devfile.json";
 
-  public static final String CURRENT_SPEC_VERSION = "0.0.1";
+  public static final String CURRENT_API_VERSION = "1.0.0";
 
   public static final String EDITOR_COMPONENT_TYPE = "cheEditor";
 

wsmaster/che-core-api-workspace/src/main/java/org/eclipse/che/api/workspace/server/devfile/convert/DevfileConverter.java

@@ -13,9 +13,10 @@
 
 import static com.google.common.base.Preconditions.checkArgument;
 import static java.lang.String.format;
+import static java.util.Collections.singleton;
 import static java.util.stream.Collectors.toCollection;
 import static org.eclipse.che.api.workspace.server.devfile.Components.getIdentifiableComponentName;
-import static org.eclipse.che.api.workspace.server.devfile.Constants.CURRENT_SPEC_VERSION;
+import static org.eclipse.che.api.workspace.server.devfile.Constants.CURRENT_API_VERSION;
 
 import com.google.common.base.Strings;
 import java.util.ArrayList;
@@ -90,7 +91,7 @@ public DevfileImpl workspaceToDevFile(WorkspaceConfigImpl wsConfig)
     }
 
     DevfileImpl devfile = new DevfileImpl();
-    devfile.setSpecVersion(CURRENT_SPEC_VERSION);
+    devfile.setApiVersion(CURRENT_API_VERSION);
     devfile.setName(wsConfig.getName());
 
     // Manage projects
@@ -180,12 +181,15 @@ public WorkspaceConfigImpl devFileToWorkspaceConfig(
   }
 
   private static void validateCurrentVersion(Devfile devFile) throws DevfileFormatException {
-    if (Strings.isNullOrEmpty(devFile.getSpecVersion())) {
-      throw new DevfileFormatException("Provided Devfile has no spec version specified");
+    if (Strings.isNullOrEmpty(devFile.getApiVersion())) {
+      throw new DevfileFormatException("Provided Devfile has no API version specified");
     }
-    if (!CURRENT_SPEC_VERSION.equals(devFile.getSpecVersion())) {
+    if (!CURRENT_API_VERSION.equals(devFile.getApiVersion())) {
       throw new DevfileFormatException(
-          format("Provided Devfile has unsupported version '%s'", devFile.getSpecVersion()));
+          format(
+              "Provided Devfile has unsupported version '%s'. The following versions are"
+                  + " supported: %s",
+              devFile.getApiVersion(), singleton(CURRENT_API_VERSION)));
     }
   }
 }

wsmaster/che-core-api-workspace/src/main/java/org/eclipse/che/api/workspace/server/model/impl/WorkspaceImpl.java

@@ -220,7 +220,7 @@ public String getNamespace() {
   /** Returns the name of workspace. It can be stored by workspace config or devfile. */
   public String getName() {
     if (devfile != null) {
-      return devfile.getName();
+      return devfile.getMetadata().getName();
     } else if (config != null) {
       return config.getName();
     } else {