{"action":"created","issue":{"url":"https://api.github.com/repos/OmniLayer/omnicore/issues/14","labels_url":"https://api.github.com/repos/OmniLayer/omnicore/issues/14/labels{/name}","comments_url":"https://api.github.com/repos/OmniLayer/omnicore/issues/14/comments","events_url":"https://api.github.com/repos/OmniLayer/omnicore/issues/14/events","html_url":"https://github.com/OmniLayer/omnicore/issues/14","id":66871717,"number":14,"title":"Unification of labels, commands, descriptions","user":{"login":"dexX7","id":5836089,"avatar_url":"https://avatars.githubusercontent.com/u/5836089?v=3","gravatar_id":"","url":"https://api.github.com/users/dexX7","html_url":"https://github.com/dexX7","followers_url":"https://api.github.com/users/dexX7/followers","following_url":"https://api.github.com/users/dexX7/following{/other_user}","gists_url":"https://api.github.com/users/dexX7/gists{/gist_id}","starred_url":"https://api.github.com/users/dexX7/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dexX7/subscriptions","organizations_url":"https://api.github.com/users/dexX7/orgs","repos_url":"https://api.github.com/users/dexX7/repos","events_url":"https://api.github.com/users/dexX7/events{/privacy}","received_events_url":"https://api.github.com/users/dexX7/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/OmniLayer/omnicore/labels/meta%20dex","name":"meta dex","color":"5319e7"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":24,"created_at":"2015-04-07T12:33:19Z","updated_at":"2015-05-26T08:58:44Z","closed_at":null,"body":"As continuation of https://github.com/OmniLayer/omnicore/pull/3#issuecomment-90286069:\r\n\r\n> @zathras-crypto: I would say for OmniCore at least the API documentation should be the primary doc? It'll need updating if my work gets merged in that's for sure :)\r\n\r\n> https://github.com/OmniLayer/omnicore/blob/omnicore-0.0.10/doc/apidocumentation.md\r\n\r\n> I would say for OmniCore at least the API documentation should be the primary doc?\r\n\r\nWell, this is the documentation, but I was more thinking about something more compact, and with the intention of finding a naming convention for various places, such as Omni Core, Omni Wallet, OmniJ, ...\r\n\r\nWhere I was basically going: there are several labels and commands, documentation pieces and more, all referring to the same thing:\r\n\r\n- Spec: `\"Create a Property via Crowdsale with Variable number of Tokens\"`\r\n- Omni Core RPC command: `\"sendissuancecrowdsale_OMNI\"`\r\n- Omni Core RPC description field: `\"Create Property - Variable\"`\r\n- Omni Core transaction history: `\"Create Property\"`\r\n- Omni Wallet short description: `\"Create Property - Variable\"`\r\n- Omni Chest short description: `\"Create Property - Crowdsale Issuance\"`\r\n- OmniJ function name: `\"createCrowdsaleHex\"` (let's ignore the \"Hex\" here)\r\n- OmniJ part of a test label: `\"create crowdsale\"`\r\n- OmniJ code comment: `\"create a property via crowdsale with variable supply\"`\r\n\r\nNow this is more or less pretty similar, but when it comes to.. say for example DEx related stuff, there are `\"trade tokens for bitcoins\"`, `\"sell bitcoins for mastercoins\"`, `\"create an offer\"`, and other variations.\r\n\r\nIt would be nice to have a spreadsheet with:\r\n\r\n| Type | Command          | Label              | Description                                            |\r\n| ---- | ---------------- | ------------------ | ------------------------------------------------------ |\r\n|  1   | simple_send      | \"Simple Send\"      | \"Send tokens\"                                          |\r\n| 50   | create_crowdsale | \"Create Crowdsale\" | \"Create a property via crowdsale with variable supply\" |\r\n| ...  | ...              | ...                | ...                                                    |\r\n\r\nIn particular, having consistent commands seems useful, for a consistent use of several Omni products. It's not relevant, whether it's `\"simplesend\"` or `\"simple_send\"`, but more of an issue, if one uses `\"send\"`, but the other `\"transfer_tokens\"`, especially when it comes to APIs. Hope you see my point? :)\r\n\r\nMore obvious cases: `\"property\"` or `\"currency\"`? `\"tokens\"` or `\"coins\"`, ...?\r\n\r\nIf I find some time, I'm going to create a list for Omni Core, which could then be passed around to collaboratively improve the names and labels.\r\n\r\nI mentioned, I dislike `\"send_MP\"` and `\"send_OMNI\"`, but I also have no idea how to make it better - or what others think about this topic in general - so this can basically be considered as trying to find an answer and alternatives.. :)\r\n\r\nAt some point this can be extended to parameter names, and it would also be useful, if there were a compact list of the fields of RPC results (e.g. of `\"gettransaction_MP\"`). "},"comment":{"url":"https://api.github.com/repos/OmniLayer/omnicore/issues/comments/105454970","html_url":"https://github.com/OmniLayer/omnicore/issues/14#issuecomment-105454970","issue_url":"https://api.github.com/repos/OmniLayer/omnicore/issues/14","id":105454970,"user":{"login":"zathras-crypto","id":5633351,"avatar_url":"https://avatars.githubusercontent.com/u/5633351?v=3","gravatar_id":"","url":"https://api.github.com/users/zathras-crypto","html_url":"https://github.com/zathras-crypto","followers_url":"https://api.github.com/users/zathras-crypto/followers","following_url":"https://api.github.com/users/zathras-crypto/following{/other_user}","gists_url":"https://api.github.com/users/zathras-crypto/gists{/gist_id}","starred_url":"https://api.github.com/users/zathras-crypto/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/zathras-crypto/subscriptions","organizations_url":"https://api.github.com/users/zathras-crypto/orgs","repos_url":"https://api.github.com/users/zathras-crypto/repos","events_url":"https://api.github.com/users/zathras-crypto/events{/privacy}","received_events_url":"https://api.github.com/users/zathras-crypto/received_events","type":"User","site_admin":false},"created_at":"2015-05-26T08:58:44Z","updated_at":"2015-05-26T08:58:44Z","body":"Great minds mate :)\r\n\r\nFrom my RPC branch:\r\n```\r\n    if (sell_subaction == 1) txobj.push_back(Pair(\"subaction\", \"new\"));\r\n    if (sell_subaction == 2) txobj.push_back(Pair(\"subaction\", \"update\"));\r\n    if (sell_subaction == 3) txobj.push_back(Pair(\"subaction\", \"cancel\"));\r\n```\r\nand\r\n```\r\n    if (metaObj.getAction() == 1) actionStr = \"new\";\r\n    if (metaObj.getAction() == 2) actionStr = \"cancel price\";\r\n    if (metaObj.getAction() == 3) actionStr = \"cancel pair\";\r\n    if (metaObj.getAction() == 4) actionStr = \"cancel all\";\r\n```\r\n\r\nHappy to change ```subaction``` to ```action```"}}