readme

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.0.3 (Jan 14, 2020)
+
+*  Update the README documentation
+
 ## 1.0.2 (Jan 4, 2021)
 * Update to sailor version 2.6.21
 * Update to version 14 of node

README.md

@@ -1,38 +1,54 @@
-# petstore-component-nodejs
-> Petstore Node.js component template for the [elastic.io platform](http://www.elastic.io "elastic.io platform")
+# Petstore Component Node.js
 
-This is a component template which we commonly refer as **the first step of the development** for creating a component to deploy into our platform. This component comes with a basic architecture which can be used on our platform. You can clone it and use it. However, **if you plan to deploy it into [elastic.io platform](https://www.elastic.io "elastic.io platform") you must follow sets of instructions to succeed**.
+## Description
 
-## Before you Begin
+A fully working and operational component template to use for starting development of your
+own component for the [elastic.io platform](http://www.elastic.io "elastic.io platform").
+This component comes with a basic architecture which you can use on the platform.
 
-Before you can deploy any code into our system **you must be a registered elastic.io platform user**. Please see our home page at [https://www.elastic.io](https://www.elastic.io) to learn how.
+The component interacts with the [petstore sample server](https://petstore.elastic.io/docs/).
 
-> Any attempt to deploy a code into our platform without a registration would be rejected.
+Our documentation on [building components in nodejs](https://docs.elastic.io/guides/building-nodejs-component)
+has more about each including file and their function.
 
-After the registration and opening of the account you must **[upload your SSH Key](http://go2.elastic.io/manage-ssh-keys)** into our platform.
+## Requirements
 
-> If you fail to upload you SSH Key you will get **permission denied** error during the deployment.
+To use this component you must be registered platform user. Please see our home
+page at [https://www.elastic.io](https://www.elastic.io) to learn how to register.
 
-## Getting Started
+### Authentication
 
-After registration and uploading of your SSH Key you can proceed to deploy it into our system. At this stage we suggest you to:
-* [Create a team](http://go2.elastic.io/manage-teams) to work on your new component. This is not required but will be automatically created using random naming by our system so we suggest you name your team accordingly.
-* [Create a repository](http://go2.elastic.io/manage-repositories) where your new component is going to *reside* inside the team that you have just created.
+To authenticate use `secret` as an API key. For more details see the
+[Petstore API docs](https://petstore.elastic.io/docs/).
 
-```bash
-$ git clone https://github.com/elasticio/petstore-component-nodejs.git your-repository
+## Triggers
 
-$ cd your-repository
-```
-Now you can edit your version of **petstore-component-nodejs** component and build your desired component. Or you can just ``PUSH``it into our system to see the process in action:
+### Get Pets By Status
 
-```bash
-$ git remote add elasticio your-team@git.elastic.io:your-repository.git
+Retrieves pets from the Petstore API by given pet status using Dynamic or Static
+Data Sample. The difference is how these functions are made. However, both can have
+the following statuses defined by the Petstore API:
 
-$ git push elasticio master
-```
-Obviously the naming of your team and repository is entirely up-to you and if you do not put any corresponding naming our system will auto generate it for you but the naming might not entirely correspond to your project requirements.
+*   `Available` - select to get all pets with status `Available`.
+*   `Pending` - select for `Pending`.
+*   `Sold` - select for `Sold`.
+
+
+## Actions
+
+### Creates a new pet
+
+Creates a new Pet by making a `POST` to `/pet` endpoint of the API. The input
+fields are:
+
+*   `petId` (required) - the Id of the pet.
+*   `name` - the name of the pet.
+*   `status` - the status which can have one `Available`, `Pending` and `Sold` values.
 
 ## File Structure
 
-The structure of **petstore-component-nodejs** component is quite flexible. [elastic.io platform](https://www.elastic.io) expects only two files to be present in the main directory. These are the ``component.json`` and ``package.json``. Our documentation on [how to build a component in node.js](https://support.elastic.io/support/solutions/articles/14000027123-how-to-build-a-component-in-node-js) has more about each file and their function.
+The structure of **petstore-component-nodejs** component is quite flexible.
+[elastic.io platform](https://www.elastic.io) expects only two files to be present
+in the main directory. These are the ``component.json`` and ``package.json``. Our
+documentation on [how to build a component in node.js](https://docs.elastic.io/guides/building-nodejs-component)
+has more about each file and their function.

component.json

@@ -9,7 +9,7 @@
         "label": "API key",
         "required": true,
         "viewClass": "TextFieldWithNoteView",
-        "note": "Please use <b>elasticio</b> as API key. For more details see <a href='https://petstore.elastic.io/docs/' target='_blank'>Petstore API docs</a>."
+        "note": "Please use <b>secret</b> as API key. For more details see <a href='https://petstore.elastic.io/docs/' target='_blank'>Petstore API docs</a>."
       }
     }
   },

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@elasticio/petstore-component-nodejs",
-    "version": "1.0.2",
+    "version": "1.0.3",
     "description": "elastic.io component for the Petstore API",
     "scripts": {
         "test": "exit 0"