Merge branch 'readme_bridge_api' of gitlab.syncad.com:hive/tests_api into readme_bridge_api

hivemind/tavern/bridge_api_patterns/get_discussion/_readme.txt

+Gives all information about post/ comment (replies, votes, information about author etc.).
+
+method: "bridge.get_discussion"
+params:
+{
+  "auhtor":"{author}", "permlink":"permlink",
+  
+     author + permlink : mandatory, have to point to valid post; paging mechanism
+
+  "observer":"{account}",
+
+     optional (can be skipped or passed empty), when passed has to point to valid account
+     used to hide authors blacklisted by observer
+
+}

hivemind/tavern/bridge_api_patterns/get_payout_stats/_readme.txt

+Lists communities order by payout with stats (total payout, number of posts and authors).
+Similar to condenser_api.get_trending_tags but gives slightly different values and it is limited to communities.
+
+method: "bridge.get_payout_stats"
+params:
+{
+  "limit":"{number}",
+
+     optional, range 1..250; default = 250
+
+}

hivemind/tavern/bridge_api_patterns/list_communities/_readme.txt

+Lists information about communities.
+
+method: "bridge.list_communities"
+params:
+{
+  "last":"{name}",
+
+     optional, name of community; given community not appear in result; used for paging mechanism 
+
+  "limit":"{number}",
+
+    optional, range 1..100; default = 100
+
+  "query":"{title}",
+
+    optional, when given turns on filtering on given name/ part of name
+
+  "sort": "{order}",
+
+     optional, determines order of returned communities' default = "rank"
+     values:
+       "rank" - communities with highest rank (trending) score first
+       "new" - newest communities first
+       "subs" - communities with largest number of subscribers first
+
+  "observer":"{account}",
+
+     optional (can be skipped or passed empty), when passed has to point to valid account
+     used to hide show relation between account and community (subscribed, role and title)
+
+}

hivemind/tavern/bridge_api_patterns/list_community_roles/_readme.txt

+Lists given community account-roles (anyone with non-guest status).
+
+method: "bridge.list_community_roles"
+params:
+{
+  "community":"{name}",
+
+    mandatory, points to community
+
+  "last":"{name}",
+
+     optional, appears to be broken 
+
+  "limit":"{number}",
+
+    optional, must be positive; default = 50;
+
+}
\ No newline at end of file

hivemind/tavern/bridge_api_patterns/list_pop_communities/_readme.txt

+Lists communities by new subscriber count. Returns names and titles community list.
+
+method: "bridge.list_pop_communities"
+params:
+{
+  "limit":"{number}",
+
+    optional, range 1..25; default = 25;
+
+}
\ No newline at end of file

hivemind/tavern/bridge_api_patterns/list_subscribers/_readme.txt

+Lists all subscribers with role, title and time of subscription for given community.
+
+method: "bridge.list_subscribers"
+params:
+{
+  "community":"{name}",
+
+    mandatory, points to community;
+
+}
\ No newline at end of file

hivemind/tavern/bridge_api_patterns/normalize_post/_readme.txt

+Took post object and outputs bridge-api normalized version, but at the moment there is no fat node that would be source of unnormalized posts.
+Result is basically the same as bridge.get_post.
+Depracated.
+
+method: "bridge.normalize_post"
+params:
+{
+  "post": {
+
+    "author":"{author}" + "permlink::"{permlink}",
+
+       mandatory, point to valid post; rest of parameters are irrelevant
+
+  }
+}
\ No newline at end of file