Skip to content
This repository has been archived by the owner on Feb 22, 2021. It is now read-only.

Commit

Permalink
Remove JavaScript samples and update board members
Browse files Browse the repository at this point in the history
Removed JavaScript samples as they are not well maintained. Updated board
members to include correct people as previous members are no longer on
this project.

Signed-off-by: J.R. Garcia <jrg@vmware.com>
  • Loading branch information
J.R. Garcia committed Apr 28, 2020
1 parent f1c238e commit c297f91
Show file tree
Hide file tree
Showing 63 changed files with 10 additions and 2,495 deletions.
50 changes: 0 additions & 50 deletions .gitignore
@@ -1,52 +1,2 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# node-waf configuration
.lock-wscript

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules
jspm_packages

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# .DS_Store
.DS_Store
6 changes: 0 additions & 6 deletions .travis.yml

This file was deleted.

4 changes: 2 additions & 2 deletions LICENSE.txt
@@ -1,9 +1,9 @@
The MIT License

Copyright 2017 VMware Inc.
Copyright 2017-2020 VMware Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
53 changes: 8 additions & 45 deletions README.md
Expand Up @@ -4,10 +4,6 @@
- [Abstract](#abstract)
- [Intended Audience](#intended-audience)
- [What’s in the SDK?](#whats-in-the-sdk)
- [Quick Start Guide for JavaScript Samples Using NodeJS](#quick-start-guide-for-javascript-samples-using-nodejs)
- [Requirements](#requirements)
- [Samples Setup](#samples-setup)
- [Running JavaScript Samples](#running-javascript-samples)
- [Submitting samples](#submitting-samples)
- [Required Information](#required-information)
- [Suggested Information](#suggested-information)
Expand All @@ -24,60 +20,27 @@
- [VMware Resources](#vmware-resources)

## Abstract
The VMware vSphere Automation SDK for REST enables programmatic access to vSphere. The SDK includes JavaScript samples to demonstrate how to invoke APIs for Tagging and Virtual Machine Operations as well as [Postman](https://www.getpostman.com/) examples.
The VMware vSphere Automation SDK for REST enables programmatic access to vSphere. The SDK includes [Postman](https://www.getpostman.com/) examples.

## Supported vCenter Releases:

All samples support vCenter 6.5. Tagging samples also support vCenter 6.0.
All samples support vCenter 6.7. Tagging samples also support vCenter 6.0.

## Intended Audience

The VMware vSphere Automation SDK for REST is intended for the following audiences:

* Developers who create clients that connect to the vAPI endpoint to use VMware vSphere Automation SDK for REST Services.
* Developers looking for REST samples for the REST APIs

## What’s in the SDK?

The VMware vSphere Automation SDK for REST provides a client SDK that contains samples that demonstrate how to use the vSphere Automation REST API and sample code. The following table contains a brief description of the contents of the vSphere Automation SDK for REST.

Directory structure (under VMware-vSphere-Automation-SDK-REST):

|Directory |Contents |
|---------------------------------|------------------------------------------------------------------------------------|
|[samples/javascript/tagging](samples/javascript/tagging)| Javascript samples that demonstrate how to construct REST API requests for Tagging.|
|[samples/javascript/vcenter](samples/javascript/vcenter)| Javascript samples that demonstrate how to construct REST API requests for Virtual Machine Operations |
|[samples/postman](samples/postman) | Postman samples that demonstrate how to construct REST API requests for Virtual Machine Operations. |

## Quick Start Guide for JavaScript Samples Using NodeJS
These steps will walk you through getting the NodeJS-based JavaScript samples running.

### Requirements
* [Node 4+](https://nodejs.org/)
* [NPM 3+](https://www.npmjs.com/)

If you don't already have NodeJS installed you will need to download and install it from [here](https://nodejs.org/en/). Additionally, the samples leverage various Open Source NodeJS which must be installed using the Node Package Manager (npm) which you can install from [here](https://www.npmjs.com/).

### Samples Setup
To run the JavaScript samples you must first install the required node packages referenced in javascript/vcenter/package.json using *npm* file as follows:

cd samples/javascript/vcenter
npm install

You may also use the ./build.sh script included at the root of the SDK. This script will run npm install on both
tagging and vcenter samples so as well as execute any tests specified in the respective package.json files.

### Running JavaScript Samples
For a complete list of included samples refer to the "scripts" section of the javascript/vcenter/package.json file. To run a sample use npm as follows:

npm run <sample_name>

Ex:

npm run host-connect

For a list of samples run:

npm run
|Directory |Contents |
|-----------------------------------|-----------------------------------------------------------------------------------------------------|
|[samples/postman](samples/postman) | Postman samples that demonstrate how to construct REST API requests for Virtual Machine Operations. |

## Submitting samples

Expand Down Expand Up @@ -130,8 +93,8 @@ Sample Exchange can be allowed to access your GitHub resources, by way of a link
Board members are volunteers from the SDK community and VMware staff members, board members are not held responsible for any issues which may occur from running of samples from this repository.

Members:
* Steve Trefethen (VMware)
* Alan Renouf (VMware)
* Ravi Chadalawada (VMware)
* J.R. Garcia (VMware)

### Approval of Additions
Items added to the repository, including items from the Board members, require 2 votes from the board members before being added to the repository. The approving members will have ideally downloaded and tested the item. When two “Approved for Merge” comments are added from board members, the pull can then be committed to the repository.
Expand Down
8 changes: 0 additions & 8 deletions build.sh

This file was deleted.

51 changes: 0 additions & 51 deletions samples/javascript/tagging/README.md

This file was deleted.

69 changes: 0 additions & 69 deletions samples/javascript/tagging/login.js

This file was deleted.

27 changes: 0 additions & 27 deletions samples/javascript/tagging/msg.js

This file was deleted.

14 changes: 0 additions & 14 deletions samples/javascript/tagging/package.json

This file was deleted.

14 changes: 0 additions & 14 deletions samples/javascript/tagging/settings.js

This file was deleted.

0 comments on commit c297f91

Please sign in to comment.