• Update structure with Ben's notes.
• Update all 10 APIs with consistent parameters.
• Add the success and failed responses to the 10 APIs.
• Press out unclear language in the explanations.

The ruby_sdk tutorial requires the end-user to create a users object by passing environment and credentials , this leads to the missing param environment error. Following code from repo requires end-user to also pass api_spec as an argument, this is missing in the documentation.

• api-spec is a boolean but the purpose is not clear. Add this to the documentation.

Quick feedback for fixes on dev.stagingost.com

• 1. https://dev.ost.com/docs/kit.html has "OST⍺" but https://dev.ost.com/docs/api.html has "$OST⍺".
• 2. https://dev.ost.com/ostkit-restful-api/docs/user.html still points to an deprecated user.md file. Can we take the deprecated pages out?
• 3. https://dev.ost.com/docs/api_authentication.html "NodeJS Authentication Example" is usually styled. "Node.js"
• 4. https://dev.ost.com/docs/api_airdrop_drop.html /api_airdrop_status.html and https://dev.ost.com/docs/api_transaction-types_status.html all have non-link type POST/GET full request uri section.
• 5. https://dev.ost.com/docs/api_airdrop_status.html the Title reads "OST KIT⍺ API Aidrop Status" spelled Airdrop usually.
• 6. https://dev.ost.com/docs/api_airdrop_status.html sorted links has a /users/airdrop/status?airdrop_uuid=AIRDROP_UUID&api_key=API_KEY&request_timestamp=EPOCH_TIME_SEC trailing C on the next line
• 7. Styling on previous pages for heading is something like OST KIT⍺ | ....text... but styling on these pages https://dev.ost.com/docs/api_airdrop_drop.html https://dev.ost.com/docs/api_airdrop_status.html isn't.
• 8. https://dev.ost.com/docs/api_transaction-types_list.html in the https://dev.ost.com/docs/api_transaction-types_list.html#client-tokens-object-attributes section the "_token_erc20_address" is missing an underscore in the .md file hence italics
• 9. https://dev.ost.com/docs/api_airdrop_status.html says "GET" at the top but in the uri section says POST
• 10. both https://dev.ost.com/docs/api_airdrop_drop.html and https://dev.ost.com/docs/api_airdrop_status.html have headings with "####" where we use "###" in all other documents.
• 11. All /users documentation has a " https://dev.ost.com/docs/api_users_create.html#user-object-attributes", "User Object Attributes:" heading that has an extra ":" ##
• 12. https://dev.ost.com/docs/api_transaction-types_list.html and https://dev.ost.com/docs/api_transaction-types_execute.html both have an "Input Parameters" heading with a "####" while other documents have a "###"
• 13. On https://dev.stagingost.com/ the button at the right bottom "Tokenize your Application" takes user to a 404 page. It takes to -> "https://dev.stagingost.com/tokenize.html" should take to -> https://dev.stagingost.com/docs/tokenize.html
  Happens first time on the page load.
• 14. "KITα" on https://dev.ost.com/docs/alpha.html is different from the "KIT⍺" on the other pages .

Hi, Please create a branch - off master, following the convention
name/gh#/title and push the updated collection ostKIT Api collections here.

passing an empty name string ("") as value to name param in transaction-types/edit leads to a success with new name as "", but does not actually change the name to "" in the db

• Add in the header that "application/x-www-form-urlencoded"
• plus no space encoding for generating the signature as described here

OST KIT alpha - authentication:

• API signature
• shared secret API key(s)

• execution of company-involved actions does not require the inclusion of company uuid (this is a change that has just been ticketed)

the documentation should let users know to install dependency - rack
with sudo gem install rack

• gem install --user ost-sdk-rub for sdk babies.

Fix the color schema on the mobile view for the menu bar (default docusaurus color showing up)

restructure docusaurus as root of docupony

1. Fix the call format for sample code curls for

• users/create
• users/edit
• users/list
• users/airdrop/drop
• users/airdrop/status
• transaction-types/edit
• transaction-types/list
• transaction-types/status

2. Explicitly state the flags for sample code curls

• users/create
• users/edit
• users/list
• airdrop/drop
• transaction-types/edit
• transaction-types/list
• transaction-types/status

OST KIT alpha: Transaction APIs

needs correction? /kind -> /type
needs alignment? /users -> /user or /transaction -> /transactions

• /transaction/kind/create
• /transaction/kind/get-all
• /transaction/kind/edit (align with users/update)
• /transaction/execute
• /transaction/list -> pagination over block number; filtered per token?
• /transaction/status -> either ?transaction_uuid or ?transaction_hash; drop transaction_

unimplemented

• /transaction/type/remove
• /transaction/type/get

The default for order_by filter is mentioned as name, however on not giving any params for this api call, order_by is called with creation_time.

the failure response is not found in the documentation.

• Input parameters section is missing the 'client_id' input
• mandatoriness of the parameters is missing

https://ost.freshdesk.com/a/tickets/4200

• Plural is missing in this sentence (compared to sample response):
  "On calling /actions the data.result_type is the string "action" and the key data.action
  is an array containing the requested action objects."
  ie. data.actions is the array not data.action

• /transaction/list Typo. There is a double // in the GET pink request example:
  GET - "https://sandboxapi.ost.com/v1//transactions/?..."

• There is no explicit mention anywhere in the API docs that the timestamp value is in milliseconds (trailing 000s) which was a cause for initial confusion as to why timestamp values where not saving/converting properly.

• Across the list API docs make it clear that "optional_filters" is not a parameter as this is misleading

• Checkout Develop branch and add last commit from pranay/gh3/website-build to new branch

OST KIT alpha: User APIs

• /users/create
• /users/update
• /users/list
• /users/airdrop/initiate
• /users/airdrop/get-status

unimplemented

• /users/remove ?
• /users/get ?

the input params are not declared mandatory or optional

OST KIT alpha error codes

• 200
• 400
• 401
• 404
• 500
• 501
• 502
• 503
• 504

• explanation of user token balance, it DOES reflect PCC and hence should be included in the documentation.

Let's start from the APIs; link pr per page here

Getting Started

Welcome

Tokenize Your Application

Alpha roadmap

OST KIT alpha

Propose Branded Token

Stake and Mint

Quick Start guide

Tutorials

Create users and upvote

Jump start economy with Airdrop

OST API

Users - create

Users - edit

Users - list

Airdrop

Airdrop - status

Transaction-types - create

Transaction-types - edit

Transaction-types - ...

OST SDK

Users - create

Users - edit

Users - list

Airdrop

Airdrop - status

...

OpenST Platform NPM

Stake and mint

Token Transfers

OST on Utility chain

web3 wrapping

Pessimistic caching

(Notifications / caching)

OpenST Protocol ABI

• Include Omit commission % parameter while making any action other than user_to_user action in the documentation as it is being missed by developers and is not obvious with the information already provided. Exclude this param altogether for calls to _user_to_company_ or _company_to_user_ action types
• In the API doc I see this: order_by string (optional) order the list by 'creation_time' or 'name' (default) by order_by=created works
• Change "Accept:" to "Content-Type:" in API documentation (fixed by Banks)
• The company_uuid returned from the /token endpoint being a 4 digit internal reference rather than the company_uuid available via the KIT backend
• User - filter on name is not available in this version as per requirements (from Sunil)
• Action - no filter on arbitrary_commission as per requirement (from Sunil)
• The token API is giving a 4 digit number for company_uuid in the APIs this should be changed to reflect the actual 'uuid'
• Added Including _arbitrary_commission_ or _commission_percent_ for either _user_to_company_ or _company_to_user_ action types will result in an error. for actions -> create, edit, update, execute.

• stepwise document describing details ofUC contract deployment
• follow the format provided below with necessary edits for versioning

id: utility_chains
title: Utility Chains
sidebar_label: Utility Chains

P1: OpenST Protocol and Utility Chains (borrow language from other places in the docs, on the website, and blogs)
P2: OSTa / Ropsten and 1409 (borrow language from other places in the docs, on the website, and blogs)
P3: How to interact (use Ben's Gist)

• read
• deploy (reference new /transfers API)

transaction-types/edit is a POST not GET

Add Ruby SDK Quick Start Guide.

• returns a truesuccess response and a uuid, for empty string name param. Creates a user in the database with empty string name which can be retrieved later and also edited.

the failure response is not found in the documentation.

• passing in an empty string as the transaction-types name returns a success response but does not actually change value in database

It should add two dates covering (a) the authentication changes and (b) v1 of the API.

For (b), I the following format is recommended :

• A brief overview description of changes (pull language from blog post about the API)
• Bullet points that say either "API x was changed to API y" or "API y was added"
• Bullet points should be in the order of the APIs as listed for v0 in the sidebar and then the additional APIs slotted in or added to the bottom of the list as seems sensible (e.g., GET /users/{id} should probably not be at the bottom of the list, but GET /token probably should be)
• For the new APIs, very brief description of what this does (e.g., GET /users/{id} enables retrieving data for a single user; GET /token returns data about your token economy)