docs/devops/project-samples-data-model/index.html - gerrit/www.eclipse.org/che - Git at Google



 <!-- jQuery Eclipse IP approval https://dev.eclipse.org/ipzilla/show_bug.cgi?id=10801 -->
 <script type="text/javascript" charset="utf8" src="../../../docs/assets/scripts/jquery-1.8.1.min.js"></script>

 <script type="text/javascript" charset="utf8">
   $(document).ready(function(){
     var images = document.getElementsByTagName('img');
     for (var i = 0; i < images.length; i++) {
       var image = images[i];
       var parentElement = image.parentElement;
       var a = document.createElement('a');
       if (! image.getAttribute('src').includes("logo-codenvy.svg") && ! image.getAttribute('src').includes("codenvy-contribute.svg") ){
           a.href = image.getAttribute('src');
           a.target = "_blank";
           a.appendChild(image);
           parentElement.appendChild(a);
       }
     }
   });
 </script>
 <!DOCTYPE HTML>
 <html lang="en-US">
 <head>
   <title>Project Samples Data Model -

       Docs
      - Eclipse Che</title>
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width,initial-scale=1">
   <meta name="generator" content="Jekyll v3.5.1">
   <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
   <link rel="stylesheet" href="../../../docs/assets/css/screen.css">
   <link rel="icon" type="image/x-icon" href="../../../docs/assets/imgs/favicon.ico">
   <!--[if lt IE 9]>
   <script src="/js/html5shiv.min.js"></script>
   <script src="/js/respond.min.js"></script>
   <![endif]-->
 </head>


 <body class="wrap">


 <header>
   <nav class="mobile-nav show-on-mobiles">
     <ul>

   <li class="current">
     <a href="../../../docs/index.html">Docs</a>
   </li>
   <li class="">
     <a href="../../../docs/tutorials/multi-machine/index.html">Tutorials</a>
   </li>
   <li class="">
     <a href="../../../docs/openshift/config/index.html">OpenShift</a>
   </li>
   <li>
     <a href="https://github.com/eclipse/che-docs/tree/master/src/main">GitHub</a>
   </li>
 </ul>

   </nav>
   <div class="grid">
     <div class="unit one-third center-on-mobiles">
         <a href="https://eclipse.org/che/">
           <span class="sr-only">Eclipse Che</span>
           <img src="../../../docs/assets/imgs/logo-eclipseche.svg" alt="Eclipse Che Logo"  width="249" height="115">
         </a>
     </div>
     <nav class="main-nav unit two-thirds hide-on-mobiles">
       <ul>

   <li class="current">
     <a href="../../../docs/index.html">Docs</a>
   </li>
   <li class="">
     <a href="../../../docs/tutorials/multi-machine/index.html">Tutorials</a>
   </li>
   <li class="">
     <a href="../../../docs/openshift/config/index.html">OpenShift</a>
   </li>
   <li>
     <a href="https://github.com/eclipse/che-docs/tree/master/src/main">GitHub</a>
   </li>
 </ul>

     </nav>
   </div>
 </header>


     <section class="docs">
     <div class="grid">

       <div class="docs-nav-mobile unit whole show-on-mobiles">
   <select onchange="if (this.value) window.location.href=this.value">
     <option value="">Navigate the docs…</option>


     <optgroup label="SETUP">


 <ul>


     <option value="../../../docs/index.html">Introduction</option>


     <option value="../../../docs/setup/getting-started/index.html">Getting Started&#58 Local</option>


     <option value="../../../docs/setup/getting-started-saas-cloud/index.html">Getting Started&#58 SaaS Cloud</option>


     <option value="../../../docs/setup/configuration/index.html">Configuration</option>


     <option value="../../../docs/setup/managing/index.html">Managing</option>


     <option value="../../../docs/setup/cli/index.html">CLI Reference</option>


     <option value="../../../docs/setup/glossary/index.html">Glossary</option>


     <option value="../../../docs/setup/docker/index.html">Docker Installation</option>


     <option value="../../../docs/setup/openshift/index.html">OpenShift Installation</option>


     <option value="../../../docs/setup/selenium/index.html">How to run selenium tests</option>


 </ul>


 <ul>


     <li class=""><a href="../../../docs/index.html">Introduction</a></li>


     <li class=""><a href="../../../docs/setup/getting-started/index.html">Getting Started&#58 Local</a></li>


     <li class=""><a href="../../../docs/setup/getting-started-saas-cloud/index.html">Getting Started&#58 SaaS Cloud</a></li>


     <li class=""><a href="../../../docs/setup/configuration/index.html">Configuration</a></li>


     <li class=""><a href="../../../docs/setup/managing/index.html">Managing</a></li>


     <li class=""><a href="../../../docs/setup/cli/index.html">CLI Reference</a></li>


     <li class=""><a href="../../../docs/setup/glossary/index.html">Glossary</a></li>


     <li class=""><a href="../../../docs/setup/docker/index.html">Docker Installation</a></li>


     <li class=""><a href="../../../docs/setup/openshift/index.html">OpenShift Installation</a></li>


     <li class=""><a href="../../../docs/setup/selenium/index.html">How to run selenium tests</a></li>


 </ul>


     </optgroup>


     <optgroup label="WORKSPACE ADMINISTRATION">


 <ul>


     <option value="../../../docs/devops/intro/index.html">Introduction</option>


     <option value="../../../docs/devops/runtime-stacks/index.html">Runtime Stacks</option>


     <option value="../../../docs/devops/runtime-recipes/index.html">Runtime Recipes</option>


     <option value="../../../docs/devops/project-samples/index.html">Project Samples</option>


     <option value="../../../docs/devops/runtime-machines/index.html">Runtime Machines</option>


     <option value="../../../docs/devops/volume-mounts/index.html">Volume Mounts</option>


     <option value="../../../docs/devops/ws-agents/index.html">Workspace Agents</option>


     <option value="../../../docs/devops/workspaces-data-model/index.html">Workspace Data Model</option>


     <option value="../../../docs/devops/runtime-stacks-data-model/index.html">Runtime Stacks Data Model</option>


     <option value="../../../docs/devops/project-samples-data-model/index.html">Project Samples Data Model</option>


 </ul>


 <ul>


     <li class=""><a href="../../../docs/devops/intro/index.html">Introduction</a></li>


     <li class=""><a href="../../../docs/devops/runtime-stacks/index.html">Runtime Stacks</a></li>


     <li class=""><a href="../../../docs/devops/runtime-recipes/index.html">Runtime Recipes</a></li>


     <li class=""><a href="../../../docs/devops/project-samples/index.html">Project Samples</a></li>


     <li class=""><a href="../../../docs/devops/runtime-machines/index.html">Runtime Machines</a></li>


     <li class=""><a href="../../../docs/devops/volume-mounts/index.html">Volume Mounts</a></li>


     <li class=""><a href="../../../docs/devops/ws-agents/index.html">Workspace Agents</a></li>


     <li class=""><a href="../../../docs/devops/workspaces-data-model/index.html">Workspace Data Model</a></li>


     <li class=""><a href="../../../docs/devops/runtime-stacks-data-model/index.html">Runtime Stacks Data Model</a></li>


     <li class="current"><a href="../../../docs/devops/project-samples-data-model/index.html">Project Samples Data Model</a></li>


 </ul>


     </optgroup>


     <optgroup label="USER GUIDE">


 <ul>


     <option value="../../../docs/ide/projects/index.html">Projects</option>


     <option value="../../../docs/ide/import-a-project/index.html">Import</option>


     <option value="../../../docs/ide/ssh/index.html">SSH</option>


     <option value="../../../docs/ide/sync/index.html">Local IDE Sync</option>


     <option value="../../../docs/ide/editor-settings/index.html">Editor</option>


     <option value="../../../docs/ide/intellisense/index.html">Intellisense</option>


     <option value="../../../docs/ide/commands/index.html">Commands</option>


     <option value="../../../docs/ide/git-svn/index.html">Git and SVN</option>


     <option value="../../../docs/ide/previews/index.html">Previews</option>


     <option value="../../../docs/ide/build/index.html">Build</option>


     <option value="../../../docs/ide/run/index.html">Run</option>


     <option value="../../../docs/ide/sharing/index.html">Share</option>


     <option value="../../../docs/ide/debug/index.html">Debug</option>


     <option value="../../../docs/ide/docker/index.html">Docker</option>


     <option value="../../../docs/ide/electron/index.html">Install Che Desktop Client</option>


 </ul>


 <ul>


     <li class=""><a href="../../../docs/ide/projects/index.html">Projects</a></li>


     <li class=""><a href="../../../docs/ide/import-a-project/index.html">Import</a></li>


     <li class=""><a href="../../../docs/ide/ssh/index.html">SSH</a></li>


     <li class=""><a href="../../../docs/ide/sync/index.html">Local IDE Sync</a></li>


     <li class=""><a href="../../../docs/ide/editor-settings/index.html">Editor</a></li>


     <li class=""><a href="../../../docs/ide/intellisense/index.html">Intellisense</a></li>


     <li class=""><a href="../../../docs/ide/commands/index.html">Commands</a></li>


     <li class=""><a href="../../../docs/ide/git-svn/index.html">Git and SVN</a></li>


     <li class=""><a href="../../../docs/ide/previews/index.html">Previews</a></li>


     <li class=""><a href="../../../docs/ide/build/index.html">Build</a></li>


     <li class=""><a href="../../../docs/ide/run/index.html">Run</a></li>


     <li class=""><a href="../../../docs/ide/sharing/index.html">Share</a></li>


     <li class=""><a href="../../../docs/ide/debug/index.html">Debug</a></li>


     <li class=""><a href="../../../docs/ide/docker/index.html">Docker</a></li>


     <li class=""><a href="../../../docs/ide/electron/index.html">Install Che Desktop Client</a></li>


 </ul>


     </optgroup>


     <optgroup label="PORTABLE WORKSPACES">


 <ul>


     <option value="../../../docs/chedir/getting-started/index.html">Chedir - Getting Started</option>


     <option value="../../../docs/chedir/why/index.html">Chedir - Why Chedir?</option>


     <option value="../../../docs/chedir/installation/index.html">Chedir - Installation</option>


     <option value="../../../docs/chedir/project-setup/index.html">Chedir - Project Setup</option>


     <option value="../../../docs/chedir/up-and-down/index.html">Chedir - Up and Down</option>


     <option value="../../../docs/chedir/chefiles/index.html">Chedir - Chefile</option>


     <option value="../../../docs/chedir/ssh/index.html">Chedir - SSH</option>


     <option value="../../../docs/chedir/factories/index.html">Chedir - Factories</option>


     <option value="">Error Generating Page Link. Contact Maintainer./docs/factory-getting-started/</option>


     <option value="">Error Generating Page Link. Contact Maintainer./docs/factory-creating/</option>


     <option value="">Error Generating Page Link. Contact Maintainer./docs/factory-json-reference/</option>


 </ul>


 <ul>


     <li class=""><a href="../../../docs/chedir/getting-started/index.html">Chedir - Getting Started</a></li>


     <li class=""><a href="../../../docs/chedir/why/index.html">Chedir - Why Chedir?</a></li>


     <li class=""><a href="../../../docs/chedir/installation/index.html">Chedir - Installation</a></li>


     <li class=""><a href="../../../docs/chedir/project-setup/index.html">Chedir - Project Setup</a></li>


     <li class=""><a href="../../../docs/chedir/up-and-down/index.html">Chedir - Up and Down</a></li>


     <li class=""><a href="../../../docs/chedir/chefiles/index.html">Chedir - Chefile</a></li>


     <li class=""><a href="../../../docs/chedir/ssh/index.html">Chedir - SSH</a></li>


     <li class=""><a href="../../../docs/chedir/factories/index.html">Chedir - Factories</a></li>


     <li class=""><a href="../../../docs/factory/getting-started/index.html">Factory - Getting Started</a></li>


     <li class=""><a href="../../../docs/factory/creating/index.html">Factory - Creating</a></li>


     <li class=""><a href="../../../docs/factory/json-reference/index.html">Factory - JSON Reference</a></li>


 </ul>


     </optgroup>


     <optgroup label="DEVELOPER GUIDE - REST API">


 <ul>


     <option value="../../../docs/assemblies/intro/index.html">Introduction</option>


     <option value="../../../docs/assemblies/archetype/index.html">Archetype</option>


     <option value="../../../docs/assemblies/assembly-lifecycle/index.html">Assembly Dev Lifecycle</option>


     <option value="../../../docs/assemblies/plugin-lifecycle/index.html">Plugin Lifecycle</option>


     <option value="../../../docs/assemblies/sdk-rest-apis/index.html">SDK REST APIs</option>


     <option value="../../../docs/assemblies/sdk-class-reference/index.html">SDK Class Reference</option>


     <option value="../../../docs/assemblies/sdk-dependency-injection/index.html">SDK Dependency Injection</option>


     <option value="../../../docs/assemblies/sdk-dto/index.html">SDK DTOs</option>


     <option value="../../../docs/assemblies/sdk-properties/index.html">SDK Properties</option>


     <option value="../../../docs/assemblies/sdk-code-editors/index.html">SDK Editors</option>


     <option value="../../../docs/assemblies/sdk-embed-htmljs/index.html">SDK Embedded JavaScript</option>


     <option value="../../../docs/assemblies/sdk-project-types/index.html">SDK Project Types</option>


     <option value="../../../docs/assemblies/sdk-actions/index.html">SDK Actions</option>


     <option value="../../../docs/assemblies/sdk-services/index.html">SDK Services</option>


     <option value="../../../docs/assemblies/sdk-parts/index.html">SDK Parts</option>


     <option value="../../../docs/assemblies/sdk-themes/index.html">SDK Themes</option>


     <option value="../../../docs/assemblies/sdk-custom-agents/index.html">SDK Custom Agents</option>


     <option value="../../../docs/assemblies/sdk-language-server-protocol/index.html">SDK Language Server Protocol</option>


     <option value="../../../docs/assemblies/sdk-workspace/index.html">SDK Workspace</option>


 </ul>


 <ul>


     <li class=""><a href="../../../docs/assemblies/intro/index.html">Introduction</a></li>


     <li class=""><a href="../../../docs/assemblies/archetype/index.html">Archetype</a></li>


     <li class=""><a href="../../../docs/assemblies/assembly-lifecycle/index.html">Assembly Dev Lifecycle</a></li>


     <li class=""><a href="../../../docs/assemblies/plugin-lifecycle/index.html">Plugin Lifecycle</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-rest-apis/index.html">SDK REST APIs</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-class-reference/index.html">SDK Class Reference</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-dependency-injection/index.html">SDK Dependency Injection</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-dto/index.html">SDK DTOs</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-properties/index.html">SDK Properties</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-code-editors/index.html">SDK Editors</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-embed-htmljs/index.html">SDK Embedded JavaScript</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-project-types/index.html">SDK Project Types</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-actions/index.html">SDK Actions</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-services/index.html">SDK Services</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-parts/index.html">SDK Parts</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-themes/index.html">SDK Themes</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-custom-agents/index.html">SDK Custom Agents</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-language-server-protocol/index.html">SDK Language Server Protocol</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-workspace/index.html">SDK Workspace</a></li>


 </ul>


     </optgroup>


   </select>
 </div>


       <div class="unit four-fifths">
         <article>
           <div class="improve right hide-on-mobiles">
             <a href="https://github.com/codenvy/che-docs/blob/master/src/main/_docs/devops/devops-project-samples-data-model.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>
             <!--<a href="https://github.com/eclipse/che/blob/master/docs/_docs/devops/devops-project-samples-data-model.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>-->
           </div>
           <div class="doc-title">
             <h1>Project Samples Data Model</h1>
             <div class="doc-title-border">
             </div>
           </div>

 <p>Users can add additional code-based project samples that are cloned into a workspace during workspace activation or by a project wizard. The <code class="highlighter-rouge">samples</code> JSON object defines a code sample and commands that can be used to bootstrap the content of a new project.</p>

 <h1 id="samples-object">Samples Object</h1>
 <p>Project samples (code snippets to be converted with a project type) are defined in JSON:</p>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="err">samples</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
   </span><span class="nt">"name"</span><span class="w">        </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">  </span><span class="err">#</span><span class="w"> </span><span class="err">Name</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">project</span><span class="w">
   </span><span class="nt">"displayName"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">  </span><span class="err">#</span><span class="w"> </span><span class="err">Name</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">project</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">be</span><span class="w"> </span><span class="err">displayed</span><span class="w"> </span><span class="err">in</span><span class="w"> </span><span class="err">wizard</span><span class="w">
   </span><span class="nt">"path"</span><span class="w">        </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">  </span><span class="err">#</span><span class="w"> </span><span class="err">Path</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">project</span><span class="w"> </span><span class="err">in</span><span class="w"> </span><span class="err">a</span><span class="w"> </span><span class="err">workspace</span><span class="w">  </span><span class="err">behaviors</span><span class="w">
   </span><span class="nt">"description"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">  </span><span class="err">#</span><span class="w"> </span><span class="err">Description</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">project</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">appear</span><span class="w"> </span><span class="err">on</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">dashboard</span><span class="w">
   </span><span class="nt">"projectType"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">  </span><span class="err">#</span><span class="w"> </span><span class="err">Project</span><span class="w"> </span><span class="err">type.</span><span class="w"> </span><span class="err">Projects</span><span class="w"> </span><span class="err">type</span><span class="w"> </span><span class="err">descriptions</span><span class="w"> </span><span class="err">are</span><span class="w"> </span><span class="err">in</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">Factory</span><span class="w"> </span><span class="err">docs</span><span class="w">
   </span><span class="nt">"mixins"</span><span class="w">      </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">      </span><span class="err">#</span><span class="w"> </span><span class="err">Mixins</span><span class="w"> </span><span class="err">add</span><span class="w"> </span><span class="err">sets</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">behavior</span><span class="w"> </span><span class="err">attributes</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">a</span><span class="w"> </span><span class="err">project.</span><span class="w">
   </span><span class="nt">"attributes"</span><span class="w">  </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">      </span><span class="err">#</span><span class="w"> </span><span class="err">List</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">project</span><span class="w"> </span><span class="err">type</span><span class="w"> </span><span class="err">attributes.</span><span class="w"> </span><span class="err">List</span><span class="w"> </span><span class="err">varies</span><span class="w"> </span><span class="err">by</span><span class="w"> </span><span class="err">type</span><span class="w"> </span><span class="err">selected</span><span class="w">
   </span><span class="nt">"modules"</span><span class="w">     </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">      </span><span class="err">#</span><span class="w"> </span><span class="err">(Optional)</span><span class="w"> </span><span class="err">Project</span><span class="w"> </span><span class="err">components.</span><span class="w"> </span><span class="err">Set</span><span class="w"> </span><span class="err">by</span><span class="w"> </span><span class="err">server</span><span class="w">
   </span><span class="nt">"problems"</span><span class="w">    </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">      </span><span class="err">#</span><span class="w"> </span><span class="err">(Optional)</span><span class="w"> </span><span class="err">Errors</span><span class="w"> </span><span class="err">occurred</span><span class="w"> </span><span class="err">in</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">project.</span><span class="w"> </span><span class="err">Set</span><span class="w"> </span><span class="err">by</span><span class="w"> </span><span class="err">server</span><span class="w">
   </span><span class="nt">"source"</span><span class="w">      </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">      </span><span class="err">#</span><span class="w"> </span><span class="err">The</span><span class="w"> </span><span class="err">source</span><span class="w"> </span><span class="err">code</span><span class="w"> </span><span class="err">imported</span><span class="w">  </span><span class="err">attributes</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">a</span><span class="w"> </span><span class="err">project</span><span class="w">
   </span><span class="nt">"commands"</span><span class="w">    </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">      </span><span class="err">#</span><span class="w"> </span><span class="err">Set</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">commands</span><span class="w"> </span><span class="err">available</span><span class="w"> </span><span class="err">for</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">project.</span><span class="w">
   </span><span class="nt">"links"</span><span class="w">       </span><span class="p">:</span><span class="w"> </span><span class="p">{},</span><span class="w">      </span><span class="err">#</span><span class="w"> </span><span class="err">List</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">method</span><span class="w"> </span><span class="err">links</span><span class="w">
   </span><span class="nt">"category"</span><span class="w">    </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">  </span><span class="err">#</span><span class="w"> </span><span class="err">Category</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">be</span><span class="w"> </span><span class="err">displayed</span><span class="w"> </span><span class="err">in</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">IDE</span><span class="w"> </span><span class="err">Create</span><span class="w"> </span><span class="err">Project</span><span class="w"> </span><span class="err">wizard</span><span class="w">
   </span><span class="nt">"tags"</span><span class="w">        </span><span class="p">:</span><span class="w"> </span><span class="err">ARRAY</span><span class="w">    </span><span class="err">#</span><span class="w"> </span><span class="err">Values</span><span class="w"> </span><span class="err">used</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">filter</span><span class="w"> </span><span class="err">samples</span><span class="w">
 </span><span class="p">}</span><span class="w">

 </span></code></pre>
 </div>

 <h2 id="source">Source</h2>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="err">samples.source</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
   </span><span class="nt">"type"</span><span class="w">       </span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="err">git</span><span class="w"> </span><span class="err">|</span><span class="w"> </span><span class="err">svn</span><span class="w"> </span><span class="err">|</span><span class="w"> </span><span class="err">zip</span><span class="p">],</span><span class="w">  </span><span class="err">#</span><span class="w"> </span><span class="err">Version</span><span class="w"> </span><span class="err">control</span><span class="w"> </span><span class="err">system</span><span class="w">
   </span><span class="nt">"location"</span><span class="w">   </span><span class="p">:</span><span class="w"> </span><span class="err">URL</span><span class="p">,</span><span class="w">                </span><span class="err">#</span><span class="w"> </span><span class="err">Location</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">version</span><span class="w"> </span><span class="err">control</span><span class="w"> </span><span class="err">or</span><span class="w"> </span><span class="err">ZIP</span><span class="w"> </span><span class="err">archive</span><span class="w">
   </span><span class="nt">"parameters"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{}</span><span class="w">                  </span><span class="err">#</span><span class="w"> </span><span class="err">(Optional)</span><span class="w"> </span><span class="err">Configure</span><span class="w"> </span><span class="err">location</span><span class="w"> </span><span class="err">access</span><span class="w"> </span><span class="err">-</span><span class="w"> </span><span class="err">varies</span><span class="w"> </span><span class="err">by</span><span class="w"> </span><span class="err">type</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>

 <p>When using <code class="highlighter-rouge">source.type</code> with <code class="highlighter-rouge">git</code> or <code class="highlighter-rouge">svn</code>, the <code class="highlighter-rouge">source.location</code> should be URL of a publicly available repo. Referencing private repos over HTTPS will result in clone failure unless credentials are provided in the URL itself. Using SSH URLs is possible, however, a user will need ssh key to complete this operation, therefore, it is recommended to use HTTPS URLs to public repos.</p>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"source"</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
   </span><span class="nt">"type"</span><span class="w">       </span><span class="p">:</span><span class="w"> </span><span class="s2">"git"</span><span class="p">,</span><span class="w">
   </span><span class="nt">"location"</span><span class="w">   </span><span class="p">:</span><span class="w"> </span><span class="s2">"https://github.com/tomitribe/tomee-jaxrs-angular-starter-project.git"</span><span class="p">,</span><span class="w">
   </span><span class="nt">"parameters"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{}</span><span class="w">
 </span><span class="p">}</span><span class="err">,</span><span class="w">
 </span></code></pre>
 </div>

 <p><code class="highlighter-rouge">zip</code> archives are referenced as URLs to remotely hosted archives that are publicly available i.e. require no login/password to be downloaded. It is not possible to reference local URLs unless you run a local server to host them (in this case a local IP is used e.g. <code class="highlighter-rouge">http://192.168.0.10/projecs/myproject.zip</code>).</p>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="s2">"source"</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
   </span><span class="nt">"type"</span><span class="w">       </span><span class="p">:</span><span class="w"> </span><span class="s2">"zip"</span><span class="p">,</span><span class="w">
   </span><span class="nt">"location"</span><span class="w">   </span><span class="p">:</span><span class="w"> </span><span class="s2">"http://192.168.0.10/projecs/myproject.zip"</span><span class="p">,</span><span class="w">
   </span><span class="nt">"parameters"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{}</span><span class="w">
 </span><span class="p">}</span><span class="err">,</span><span class="w">
 </span></code></pre>
 </div>

 <h3 id="parameters">Parameters</h3>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="err">samples.source.parameters</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">{</span><span class="w">
   </span><span class="nt">"branch"</span><span class="w">   </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">           </span><span class="err">#</span><span class="w"> </span><span class="err">Clone</span><span class="w"> </span><span class="err">from</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">branch</span><span class="w">
   </span><span class="nt">"keepVcs"</span><span class="w">  </span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="kc">true</span><span class="w"> </span><span class="err">|</span><span class="w"> </span><span class="kc">false</span><span class="p">],</span><span class="w">   </span><span class="err">#</span><span class="w"> </span><span class="err">Keep</span><span class="w"> </span><span class="err">the</span><span class="w"> </span><span class="err">.git</span><span class="w"> </span><span class="err">folder</span><span class="w"> </span><span class="err">after</span><span class="w"> </span><span class="err">clone.</span><span class="w">
   </span><span class="nt">"commitId"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">           </span><span class="err">#</span><span class="w"> </span><span class="err">Clone</span><span class="w"> </span><span class="err">from</span><span class="w"> </span><span class="err">a</span><span class="w"> </span><span class="err">commit</span><span class="w"> </span><span class="err">point.</span><span class="w"> </span><span class="err">Branch</span><span class="w"> </span><span class="err">precedes</span><span class="w"> </span><span class="err">this</span><span class="w"> </span><span class="err">property</span><span class="w">
   </span><span class="nt">"keepDir"</span><span class="w">  </span><span class="p">:</span><span class="w"> </span><span class="err">STRING</span><span class="p">,</span><span class="w">           </span><span class="err">#</span><span class="w"> </span><span class="err">Sparse</span><span class="w"> </span><span class="err">Checkout</span><span class="w"> </span><span class="err">to</span><span class="w"> </span><span class="err">clone</span><span class="w"> </span><span class="err">only</span><span class="w"> </span><span class="err">sub-directory</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">repository</span><span class="w">
   </span><span class="nt">"fetch"</span><span class="w">    </span><span class="p">:</span><span class="w"> </span><span class="err">REF-SPEC</span><span class="w">          </span><span class="err">#</span><span class="w"> </span><span class="err">Clone</span><span class="w"> </span><span class="err">from</span><span class="w"> </span><span class="err">patch</span><span class="w"> </span><span class="err">set</span><span class="w"> </span><span class="err">of</span><span class="w"> </span><span class="err">provided</span><span class="w"> </span><span class="err">ref-spec</span><span class="w">
 </span><span class="p">}</span><span class="w">
 </span></code></pre>
 </div>

 <h2 id="commands">Commands</h2>
 <p>You can add predefined sets of commands that will appear in the command selector for any user that creates a project from this sample.</p>

 <p>Refer to the following documentation for <a href="../../../docs/devops/runtime-stacks-data-model/index.html#Commands">Commands JSON object reference</a>.</p>

 <h2 id="tags">Tags</h2>
 <p>Tags are used for stacks and samples objects. Those values are used to determine if a sample is compatible with a stack. Tags are used to filter the list of project samples that a user can choose when selecting a stack in the user dashboard.</p>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="err">samples.tags</span><span class="w"> </span><span class="err">:</span><span class="w"> </span><span class="p">[{</span><span class="w">
   </span><span class="nt">"tag1"</span><span class="w">
   </span><span class="nt">"tag2"</span><span class="w">
   </span><span class="nt">"..."</span><span class="w">
 </span><span class="err">}</span><span class="p">]</span><span class="w">
 </span></code></pre>
 </div>

 <h1 id="samples-reference">Samples Reference</h1>

 <div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">[</span><span class="w">
   </span><span class="p">{</span><span class="w">
     </span><span class="nt">"name"</span><span class="p">:</span><span class="s2">"web-javaee-jaxrs"</span><span class="p">,</span><span class="w">
     </span><span class="nt">"displayName"</span><span class="p">:</span><span class="s2">"web-javaee-jaxrs"</span><span class="p">,</span><span class="w">
     </span><span class="nt">"path"</span><span class="p">:</span><span class="s2">"/web-javaee-jaxrs"</span><span class="p">,</span><span class="w">
     </span><span class="nt">"description"</span><span class="p">:</span><span class="s2">"A basic example demonstrating JAXRS running on Apache TomEE"</span><span class="p">,</span><span class="w">
     </span><span class="nt">"projectType"</span><span class="p">:</span><span class="s2">"maven"</span><span class="p">,</span><span class="w">
     </span><span class="nt">"mixins"</span><span class="p">:[],</span><span class="w">
     </span><span class="nt">"attributes"</span><span class="p">:{</span><span class="w">
       </span><span class="nt">"language"</span><span class="p">:[</span><span class="w">
         </span><span class="s2">"java"</span><span class="w">
       </span><span class="p">]</span><span class="w">
     </span><span class="p">},</span><span class="w">
     </span><span class="nt">"modules"</span><span class="p">:[],</span><span class="w">
     </span><span class="nt">"problems"</span><span class="p">:[],</span><span class="w">
     </span><span class="nt">"source"</span><span class="p">:{</span><span class="w">
       </span><span class="nt">"type"</span><span class="p">:</span><span class="s2">"git"</span><span class="p">,</span><span class="w">
       </span><span class="nt">"location"</span><span class="p">:</span><span class="s2">"https://github.com/tomitribe/tomee-jaxrs-angular-starter-project.git"</span><span class="p">,</span><span class="w">
       </span><span class="nt">"parameters"</span><span class="p">:{}</span><span class="w">
     </span><span class="p">},</span><span class="w">
     </span><span class="nt">"commands"</span><span class="p">:[</span><span class="w">
       </span><span class="p">{</span><span class="w">
         </span><span class="nt">"name"</span><span class="p">:</span><span class="s2">"build"</span><span class="p">,</span><span class="w">
         </span><span class="nt">"type"</span><span class="p">:</span><span class="s2">"mvn"</span><span class="p">,</span><span class="w">
         </span><span class="nt">"commandLine"</span><span class="p">:</span><span class="s2">"mvn -f ${current.project.path} clean install
                            &amp;&amp; cp ${current.project.path}/target/*.war $TOMEE_HOME/webapps/ROOT.war"</span><span class="p">,</span><span class="w">
         </span><span class="nt">"attributes"</span><span class="p">:{</span><span class="w">
           </span><span class="nt">"previewUrl"</span><span class="p">:</span><span class="s2">""</span><span class="w">
         </span><span class="p">}</span><span class="w">
       </span><span class="p">},</span><span class="w">
       </span><span class="p">{</span><span class="w">
         </span><span class="nt">"name"</span><span class="p">:</span><span class="s2">"run tomee"</span><span class="p">,</span><span class="w">
         </span><span class="nt">"type"</span><span class="p">:</span><span class="s2">"custom"</span><span class="p">,</span><span class="w">
         </span><span class="nt">"commandLine"</span><span class="p">:</span><span class="s2">"$TOMEE_HOME/bin/catalina.sh run"</span><span class="p">,</span><span class="w">
         </span><span class="nt">"attributes"</span><span class="p">:{</span><span class="w">
           </span><span class="nt">"previewUrl"</span><span class="p">:</span><span class="s2">"http://${server.port.8080}"</span><span class="w">
         </span><span class="p">}</span><span class="w">
       </span><span class="p">},</span><span class="w">
       </span><span class="p">{</span><span class="w">
         </span><span class="nt">"name"</span><span class="p">:</span><span class="s2">"stop tomee"</span><span class="p">,</span><span class="w">
         </span><span class="nt">"type"</span><span class="p">:</span><span class="s2">"custom"</span><span class="p">,</span><span class="w">
         </span><span class="nt">"commandLine"</span><span class="p">:</span><span class="s2">"$TOMEE_HOME/bin/catalina.sh stop"</span><span class="p">,</span><span class="w">
         </span><span class="nt">"attributes"</span><span class="p">:{</span><span class="w">
           </span><span class="nt">"previewUrl"</span><span class="p">:</span><span class="s2">""</span><span class="w">
         </span><span class="p">}</span><span class="w">
       </span><span class="p">},</span><span class="w">
       </span><span class="p">{</span><span class="w">
         </span><span class="nt">"name"</span><span class="p">:</span><span class="s2">"build and run"</span><span class="p">,</span><span class="w">
         </span><span class="nt">"type"</span><span class="p">:</span><span class="s2">"mvn"</span><span class="p">,</span><span class="w">
         </span><span class="nt">"commandLine"</span><span class="p">:</span><span class="s2">"mvn -f ${current.project.path} clean install
                            &amp;&amp; cp ${current.project.path}/target/*.war $TOMEE_HOME/webapps/ROOT.war
                            &amp;&amp; $TOMEE_HOME/bin/catalina.sh run"</span><span class="p">,</span><span class="w">
         </span><span class="nt">"attributes"</span><span class="p">:{</span><span class="w">
            </span><span class="nt">"previewUrl"</span><span class="p">:</span><span class="s2">"http://${server.port.8080}"</span><span class="w">
         </span><span class="p">}</span><span class="w">
       </span><span class="p">},</span><span class="w">
       </span><span class="p">{</span><span class="w">
         </span><span class="nt">"name"</span><span class="p">:</span><span class="s2">"debug"</span><span class="p">,</span><span class="w">
         </span><span class="nt">"type"</span><span class="p">:</span><span class="s2">"mvn"</span><span class="p">,</span><span class="w">
         </span><span class="nt">"commandLine"</span><span class="p">:</span><span class="s2">"mvn -f ${current.project.path} clean install
                            &amp;&amp; cp ${current.project.path}/target/*.war $TOMEE_HOME/webapps/ROOT.war
                            &amp;&amp; $TOMEE_HOME/bin/catalina.sh jpda run"</span><span class="p">,</span><span class="w">
         </span><span class="nt">"attributes"</span><span class="p">:{</span><span class="w">
           </span><span class="nt">"previewUrl"</span><span class="p">:</span><span class="s2">"http://${server.port.8080}"</span><span class="w">
         </span><span class="p">}</span><span class="w">
       </span><span class="p">}</span><span class="w">
     </span><span class="p">],</span><span class="w">
     </span><span class="nt">"links"</span><span class="p">:[],</span><span class="w">
     </span><span class="nt">"category"</span><span class="p">:</span><span class="s2">"Samples"</span><span class="p">,</span><span class="w">
     </span><span class="nt">"tags"</span><span class="p">:[</span><span class="s2">"maven"</span><span class="p">,</span><span class="s2">"java"</span><span class="p">,</span><span class="s2">"javaee"</span><span class="p">,</span><span class="s2">"jaxrs"</span><span class="p">]</span><span class="w">
   </span><span class="p">}</span><span class="w">
 </span><span class="p">]</span><span class="w">
 </span></code></pre>
 </div>

         </article>
       </div>

       <div class="unit one-fifth hide-on-mobiles">
   <aside>


     <h4>SETUP</h4>


 <ul>


     <li class=""><a href="../../../docs/index.html">Introduction</a></li>


     <li class=""><a href="../../../docs/setup/getting-started/index.html">Getting Started&#58 Local</a></li>


     <li class=""><a href="../../../docs/setup/getting-started-saas-cloud/index.html">Getting Started&#58 SaaS Cloud</a></li>


     <li class=""><a href="../../../docs/setup/configuration/index.html">Configuration</a></li>


     <li class=""><a href="../../../docs/setup/managing/index.html">Managing</a></li>


     <li class=""><a href="../../../docs/setup/cli/index.html">CLI Reference</a></li>


     <li class=""><a href="../../../docs/setup/glossary/index.html">Glossary</a></li>


     <li class=""><a href="../../../docs/setup/docker/index.html">Docker Installation</a></li>


     <li class=""><a href="../../../docs/setup/openshift/index.html">OpenShift Installation</a></li>


     <li class=""><a href="../../../docs/setup/selenium/index.html">How to run selenium tests</a></li>


 </ul>


     <h4>WORKSPACE ADMINISTRATION</h4>


 <ul>


     <li class=""><a href="../../../docs/devops/intro/index.html">Introduction</a></li>


     <li class=""><a href="../../../docs/devops/runtime-stacks/index.html">Runtime Stacks</a></li>


     <li class=""><a href="../../../docs/devops/runtime-recipes/index.html">Runtime Recipes</a></li>


     <li class=""><a href="../../../docs/devops/project-samples/index.html">Project Samples</a></li>


     <li class=""><a href="../../../docs/devops/runtime-machines/index.html">Runtime Machines</a></li>


     <li class=""><a href="../../../docs/devops/volume-mounts/index.html">Volume Mounts</a></li>


     <li class=""><a href="../../../docs/devops/ws-agents/index.html">Workspace Agents</a></li>


     <li class=""><a href="../../../docs/devops/workspaces-data-model/index.html">Workspace Data Model</a></li>


     <li class=""><a href="../../../docs/devops/runtime-stacks-data-model/index.html">Runtime Stacks Data Model</a></li>


     <li class="current"><a href="../../../docs/devops/project-samples-data-model/index.html">Project Samples Data Model</a></li>


 </ul>


     <h4>USER GUIDE</h4>


 <ul>


     <li class=""><a href="../../../docs/ide/projects/index.html">Projects</a></li>


     <li class=""><a href="../../../docs/ide/import-a-project/index.html">Import</a></li>


     <li class=""><a href="../../../docs/ide/ssh/index.html">SSH</a></li>


     <li class=""><a href="../../../docs/ide/sync/index.html">Local IDE Sync</a></li>


     <li class=""><a href="../../../docs/ide/editor-settings/index.html">Editor</a></li>


     <li class=""><a href="../../../docs/ide/intellisense/index.html">Intellisense</a></li>


     <li class=""><a href="../../../docs/ide/commands/index.html">Commands</a></li>


     <li class=""><a href="../../../docs/ide/git-svn/index.html">Git and SVN</a></li>


     <li class=""><a href="../../../docs/ide/previews/index.html">Previews</a></li>


     <li class=""><a href="../../../docs/ide/build/index.html">Build</a></li>


     <li class=""><a href="../../../docs/ide/run/index.html">Run</a></li>


     <li class=""><a href="../../../docs/ide/sharing/index.html">Share</a></li>


     <li class=""><a href="../../../docs/ide/debug/index.html">Debug</a></li>


     <li class=""><a href="../../../docs/ide/docker/index.html">Docker</a></li>


     <li class=""><a href="../../../docs/ide/electron/index.html">Install Che Desktop Client</a></li>


 </ul>


     <h4>PORTABLE WORKSPACES</h4>


 <ul>


     <li class=""><a href="../../../docs/chedir/getting-started/index.html">Chedir - Getting Started</a></li>


     <li class=""><a href="../../../docs/chedir/why/index.html">Chedir - Why Chedir?</a></li>


     <li class=""><a href="../../../docs/chedir/installation/index.html">Chedir - Installation</a></li>


     <li class=""><a href="../../../docs/chedir/project-setup/index.html">Chedir - Project Setup</a></li>


     <li class=""><a href="../../../docs/chedir/up-and-down/index.html">Chedir - Up and Down</a></li>


     <li class=""><a href="../../../docs/chedir/chefiles/index.html">Chedir - Chefile</a></li>


     <li class=""><a href="../../../docs/chedir/ssh/index.html">Chedir - SSH</a></li>


     <li class=""><a href="../../../docs/chedir/factories/index.html">Chedir - Factories</a></li>


     <li class=""><a href="../../../docs/factory/getting-started/index.html">Factory - Getting Started</a></li>


     <li class=""><a href="../../../docs/factory/creating/index.html">Factory - Creating</a></li>


     <li class=""><a href="../../../docs/factory/json-reference/index.html">Factory - JSON Reference</a></li>


 </ul>


     <h4>DEVELOPER GUIDE - REST API</h4>


 <ul>


     <li class=""><a href="../../../docs/assemblies/intro/index.html">Introduction</a></li>


     <li class=""><a href="../../../docs/assemblies/archetype/index.html">Archetype</a></li>


     <li class=""><a href="../../../docs/assemblies/assembly-lifecycle/index.html">Assembly Dev Lifecycle</a></li>


     <li class=""><a href="../../../docs/assemblies/plugin-lifecycle/index.html">Plugin Lifecycle</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-rest-apis/index.html">SDK REST APIs</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-class-reference/index.html">SDK Class Reference</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-dependency-injection/index.html">SDK Dependency Injection</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-dto/index.html">SDK DTOs</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-properties/index.html">SDK Properties</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-code-editors/index.html">SDK Editors</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-embed-htmljs/index.html">SDK Embedded JavaScript</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-project-types/index.html">SDK Project Types</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-actions/index.html">SDK Actions</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-services/index.html">SDK Services</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-parts/index.html">SDK Parts</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-themes/index.html">SDK Themes</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-custom-agents/index.html">SDK Custom Agents</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-language-server-protocol/index.html">SDK Language Server Protocol</a></li>


     <li class=""><a href="../../../docs/assemblies/sdk-workspace/index.html">SDK Workspace</a></li>


 </ul>


   </aside>
 </div>


       <div class="clear"></div>

     </div>
   </section>


   <script>
   var anchorForId = function (id) {
     var anchor = document.createElement("a");
     anchor.className = "header-link";
     anchor.href      = "#" + id;
     anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
     anchor.title = "Permalink";
     return anchor;
   };

   var linkifyAnchors = function (level, containingElement) {
     var headers = containingElement.getElementsByTagName("h" + level);
     for (var h = 0; h < headers.length; h++) {
       var header = headers[h];

       if (typeof header.id !== "undefined" && header.id !== "") {
         header.appendChild(anchorForId(header.id));
       }
     }
   };

   document.onreadystatechange = function () {
     if (this.readyState === "complete") {
       var contentBlock = document.getElementsByClassName("artik")[0] || document.getElementsByClassName("openshift")[0] || document.getElementsByClassName("tutorials")[0] || document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
       if (!contentBlock) {
         return;
       }
       for (var level = 1; level <= 6; level++) {
         linkifyAnchors(level, contentBlock);
       }
     }
   };
 </script>


 </body>
 </html>