Skip to content
Snippets Groups Projects
Commit 78a3cc46 authored by Andrzej Lisak's avatar Andrzej Lisak
Browse files

[ABW]: _readme decriptions simplified since most of described routines are...

[ABW]: _readme decriptions simplified since most of described routines are simple aliases to condenser_api
small corrections in existing _readme in condenser_api
merged with latest master
parents 78c1b2ec 4fedc415
No related branches found
No related tags found
1 merge request!153Tags_api readme files.
Showing
with 41 additions and 32 deletions
...@@ -12,9 +12,9 @@ params: ...@@ -12,9 +12,9 @@ params:
optional, with author when given have to point to valid start post; paging mechanism optional, with author when given have to point to valid start post; paging mechanism
"limit":"{limit}", "limit":{number},
optional, range 1...100; default = 20 optional, 1..100, default = 20
"before_date":"{date}", "before_date":"{date}",
...@@ -22,5 +22,5 @@ params: ...@@ -22,5 +22,5 @@ params:
"truncate_body":{number} "truncate_body":{number}
optional, default = 0; optional, default = 0 (meaning no truncation); reduces maximal size of post body, cutting out all excess
} }
\ No newline at end of file
...@@ -13,7 +13,7 @@ params: ...@@ -13,7 +13,7 @@ params:
start_author + start_permlink : optional, when given have to point to valid start post; paging mechanism (cuts out this and newer posts/reblogs) start_author + start_permlink : optional, when given have to point to valid start post; paging mechanism (cuts out this and newer posts/reblogs)
"limit":"{number}", "limit":{number},
optional, 1..100, default = 20 optional, 1..100, default = 20
...@@ -21,7 +21,7 @@ params: ...@@ -21,7 +21,7 @@ params:
optional, default = 0 (meaning no truncation); reduces maximal size of post body, cutting out all excess optional, default = 0 (meaning no truncation); reduces maximal size of post body, cutting out all excess
"filter_tags":"{list_of_tags}" "filter_tags":[{list_of_tags}]
has to be left empty, not supported has to be left empty, not supported
} }
\ No newline at end of file
...@@ -11,15 +11,15 @@ params: ...@@ -11,15 +11,15 @@ params:
optional, when given have to point on valid start comment optional, when given have to point on valid start comment
"limit":"{number}", "limit":{number},
optional, range 1...100; default = 20 optional, range 1..100; default = 20
"truncate_body":{number} "truncate_body":{number}
optional, default = 0; optional, default = 0 (meaning no truncation); reduces maximal size of post body, cutting out all excess
"filter_tags":"{list_of_tags}", "filter_tags":[{list_of_tags}]
optional, not supported has to be left empty, not supported
} }
\ No newline at end of file
...@@ -8,7 +8,7 @@ params: ...@@ -8,7 +8,7 @@ params:
start_author + start_permlink : optional, when given have to point to valid start post; paging mechanism (cuts out this and newer posts) start_author + start_permlink : optional, when given have to point to valid start post; paging mechanism (cuts out this and newer posts)
"limit":"{number}", "limit":{number},
optional, 1..100, default = 20 optional, 1..100, default = 20
...@@ -21,7 +21,7 @@ params: ...@@ -21,7 +21,7 @@ params:
optional, default = 0 (meaning no truncation); reduces maximal size of post body, cutting out all excess optional, default = 0 (meaning no truncation); reduces maximal size of post body, cutting out all excess
"filter_tags":"{list_of_tags}" "filter_tags":[{list_of_tags}]
has to be left empty, not supported has to be left empty, not supported
} }
...@@ -6,23 +6,23 @@ params: ...@@ -6,23 +6,23 @@ params:
{ {
"tag":"{account}", "tag":"{account}",
mandatory, have to point on valid account whose feed we are looking at mandatory, have to point on valid account whose feed we are looking at
"start_author":"{author}" + "start_permlink":"{permlink}", "start_author":"{author}" + "start_permlink":"{permlink}",
optional, should point to valid apost optional, should point to valid apost
"limit":"{number}", "limit":{number},
optional, range 1...100; default = 20 optional, 1..100, default = 20
"truncate_body":{number} "truncate_body":{number}
optional, default = 0; optional, default = 0 (meaning no truncation); reduces maximal size of post body, cutting out all excess
"filter_tags":"{list_of_tags}" "filter_tags":[{list_of_tags}]
optional, not supported has to be left empty, not supported
} }
Notes for creating patterns: Notes for creating patterns:
......
...@@ -10,7 +10,7 @@ params: ...@@ -10,7 +10,7 @@ params:
start_author + start_permlink : optional, when given have to point to valid start post; paging mechanism (cuts out this and hotter) start_author + start_permlink : optional, when given have to point to valid start post; paging mechanism (cuts out this and hotter)
"limit":"{number}", "limit":{number},
optional, 1..100, default = 20 optional, 1..100, default = 20
...@@ -23,7 +23,7 @@ params: ...@@ -23,7 +23,7 @@ params:
optional, default = 0 (meaning no truncation); reduces maximal size of post body, cutting out all excess optional, default = 0 (meaning no truncation); reduces maximal size of post body, cutting out all excess
"filter_tags":"{list_of_tags}" "filter_tags":[{list_of_tags}]
has to be left empty, not supported has to be left empty, not supported
} }
...@@ -8,7 +8,7 @@ params: ...@@ -8,7 +8,7 @@ params:
start_author + start_permlink : optional, when given have to point to valid start post; paging mechanism (cuts out this and more promoted posts) start_author + start_permlink : optional, when given have to point to valid start post; paging mechanism (cuts out this and more promoted posts)
"limit":"{number}", "limit":{number},
optional, 1..100, default = 20 optional, 1..100, default = 20
...@@ -21,7 +21,7 @@ params: ...@@ -21,7 +21,7 @@ params:
optional, default = 0 (meaning no truncation); reduces maximal size of post body, cutting out all excess optional, default = 0 (meaning no truncation); reduces maximal size of post body, cutting out all excess
"filter_tags":"{list_of_tags}" "filter_tags":[{list_of_tags}]
has to be left empty, not supported has to be left empty, not supported
} }
\ No newline at end of file
...@@ -10,7 +10,7 @@ params: ...@@ -10,7 +10,7 @@ params:
start_author + start_permlink : optional, when given have to point to valid start post; paging mechanism (cuts out this and more trending) start_author + start_permlink : optional, when given have to point to valid start post; paging mechanism (cuts out this and more trending)
"limit":"{number}", "limit":{number},
optional, 1..100, default = 20 optional, 1..100, default = 20
...@@ -23,7 +23,7 @@ params: ...@@ -23,7 +23,7 @@ params:
optional, default = 0 (meaning no truncation); reduces maximal size of post body, cutting out all excess optional, default = 0 (meaning no truncation); reduces maximal size of post body, cutting out all excess
"filter_tags":"{list_of_tags}" "filter_tags":[{list_of_tags}]
has to be left empty, not supported has to be left empty, not supported
} }
\ No newline at end of file
...@@ -15,7 +15,7 @@ params: ...@@ -15,7 +15,7 @@ params:
optional, 'blog'/'ignore' (should be extended with 'blacklists' etc.), default = 'blog' optional, 'blog'/'ignore' (should be extended with 'blacklists' etc.), default = 'blog'
"limit:"{number}" "limit:{number}
optional, 1..1000, default = 1000 optional, 1..1000, default = 1000
} }
\ No newline at end of file
...@@ -11,7 +11,7 @@ params: ...@@ -11,7 +11,7 @@ params:
optional, when provided has to point to valid account, paging mechanism (cuts out this and newer follows) optional, when provided has to point to valid account, paging mechanism (cuts out this and newer follows)
"limit:"{number}" "limit:{number}
optional, 1..1000, default = 1000 optional, 1..1000, default = 1000
......
...@@ -9,7 +9,7 @@ params: ...@@ -9,7 +9,7 @@ params:
start_author + start_permlink : optional, when given have to point to valid start post; paging mechanism (cuts out this and more paying replies) start_author + start_permlink : optional, when given have to point to valid start post; paging mechanism (cuts out this and more paying replies)
"limit":"{number}", "limit":{number},
optional, 1..100, default = 20 optional, 1..100, default = 20
......
...@@ -13,11 +13,11 @@ params: ...@@ -13,11 +13,11 @@ params:
optional, when passed it has to point to valid post (paired with start_author) optional, when passed it has to point to valid post (paired with start_author)
"limit":"{number}", "limit":{number},
optional, 1..100, default = 20 optional, 1..100, default = 20
"truncate_body":"{number}" "truncate_body":{number}
optional, default = 0 (meaning no truncation); reduces maximal size of post body, cutting out all excess optional, default = 0 (meaning no truncation); reduces maximal size of post body, cutting out all excess
} }
\ No newline at end of file
Alias for condenser_api.get_comment_discussions_by_payout
Nearly an alias for condenser_api.get_content_replies, except the results are given in condenser_api style (original condenser_api.get_content_replies
implementation), while current condenser_api.get_content_replies uses database_api style (since it was made to match Fat Node implementation)
Nearly an alias for condenser_api.get_content, except the results are given in condenser_api style (original condenser_api.get_content implementation), while
current condenser_api.get_content uses database_api style (since it was made to match Fat Node implementation)
Alias for condenser_api.get_discussions_by_author_before_date
Same as condenser_api.get_discussions_by_blog Alias for condenser_api.get_discussions_by_blog
\ No newline at end of file \ No newline at end of file
Alias for condenser_api.get_discussions_by_comments
Alias for condenser_api.get_discussions_by_created
Alias for condenser_api.get_discussions_by_hot
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment