Skip to content

Commit 54afe40

Browse files
author
Bryan Berg
committed
Update post documentation
1 parent 2060e01 commit 54afe40

File tree

2 files changed

+64
-5
lines changed

2 files changed

+64
-5
lines changed

resources/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,11 +96,16 @@ Guiding principles are:
9696
<td>/stream/0/posts/stream/global</td>
9797
<td>GET</td>
9898
<td><a href="/appdotnet/api-spec/blob/master/resources/posts.md#retrieve-the-global-stream">Retrieve the Global stream</a></td>
99-
</tr>
99+
</tr>
100+
<tr>
101+
<td>/stream/0/posts/tag/[hashtag]</td>
102+
<td>GET</td>
103+
<td><a href="/appdotnet/api-spec/blob/master/resources/posts.md#retrieve-tagged-posts">Retrieve tagged Posts</a></td>
104+
</tr>
100105
</tbody>
101106
</table>
102107

103-
### [Streams](/appdotnet/api-spec/blob/master/resources/streams.md)
108+
## [Streams](/appdotnet/api-spec/blob/master/resources/streams.md) -- coming soon
104109
<table>
105110
<thead>
106111
<tr>
@@ -138,7 +143,7 @@ Guiding principles are:
138143
</tbody>
139144
</table>
140145

141-
### [Real-time updates](/appdotnet/api-spec/blob/master/resources/subscriptions.md)
146+
## [Real-time updates](/appdotnet/api-spec/blob/master/resources/subscriptions.md) -- coming soon
142147

143148
<table>
144149
<thead>
@@ -172,7 +177,7 @@ Guiding principles are:
172177
</tbody>
173178
</table>
174179

175-
### [Filters](/appdotnet/api-spec/blob/master/resources/filters.md)
180+
## [Filters](/appdotnet/api-spec/blob/master/resources/filters.md) -- coming soon
176181

177182
<table>
178183
<thead>

resources/posts.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Posts are currently the best implemented objects on the system. If you're looking to play around with part of the API, start here.
44

5-
## General parameters - coming soon
5+
## General parameters
66

77
Requests for streams of Posts can be filtered by passing query string parameters along with the request.
88

@@ -589,3 +589,57 @@ Return the 20 most recent <a href="/appdotnet/api-spec/blob/master/objects.md#po
589589
...
590590
]
591591
```
592+
## Retrieve tagged Posts
593+
594+
Return the 20 most recent <a href="/appdotnet/api-spec/blob/master/objects.md#post">Post</a>s for a specific hashtag.
595+
596+
### URL
597+
> https://alpha-api.app.net/stream/0/posts/tag/[hashtag]
598+
599+
### Parameters
600+
601+
*See [General Parameters](#general-parameters) for optional parameters you can use with this query.*
602+
603+
### Example
604+
605+
> GET https://alpha-api.app.net/stream/0/posts/tag/newsocialnetwork
606+
```js
607+
[{
608+
"id": "1", // note this is a string
609+
"user": {
610+
...
611+
},
612+
"created_at": "2012-07-16T17:25:47Z",
613+
"text": "@berg FIRST post on this new site #newsocialnetwork",
614+
"source": {
615+
"name": "Rdio for iOS",
616+
"link": "http://rdio.com"
617+
},
618+
"reply_to": null,
619+
"annotations": {
620+
"wellknown:geo": {
621+
"type": "Point",
622+
"coordinates": [102.0, .5]
623+
},
624+
"rdio:song": ...
625+
},
626+
"entities": {
627+
"mentions": [{
628+
"name": "berg",
629+
"id": "2",
630+
"indices": [0, 4]
631+
}],
632+
"hashtags": [{
633+
"name": "newsocialnetwork",
634+
"indices": [34, 50]
635+
}],
636+
"links": [{
637+
"text": "this new site",
638+
"url": "https://join.app.net"
639+
"indices": [20, 32],
640+
}]
641+
}
642+
},
643+
...
644+
]
645+
```

0 commit comments

Comments
 (0)