Documentation
¶
Index ¶
Constants ¶
const ( BasePath = "/v1/timelines" HomeTimeline = BasePath + "/home" PublicTimeline = BasePath + "/public" ListTimeline = BasePath + "/list/:" + apiutil.IDKey TagTimeline = BasePath + "/tag/:" + apiutil.TagNameKey )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Module ¶
type Module struct {
// contains filtered or unexported fields
}
func New ¶
func New(processor *processing.Processor) *Module
func (*Module) HomeTimelineGETHandler ¶
HomeTimelineGETHandler swagger:operation GET /api/v1/timelines/home homeTimeline
See statuses/posts by accounts you follow.
The statuses will be returned in descending chronological order (newest first), with sequential IDs (bigger = newer).
The returned Link header can be used to generate the previous and next queries when scrolling up or down a timeline.
Example:
``` <https://example.org/api/v1/timelines/home?limit=20&max_id=01FC3GSQ8A3MMJ43BPZSGEG29M>; rel="next", <https://example.org/api/v1/timelines/home?limit=20&min_id=01FC3KJW2GYXSDDRA6RWNDM46M>; rel="prev" ````
--- tags: - timelines produces: - application/json parameters: - name: max_id type: string description: >- Return only statuses *OLDER* than the given max status ID. The status with the specified ID will not be included in the response. in: query required: false - name: since_id type: string description: >- Return only statuses *newer* than the given since status ID. The status with the specified ID will not be included in the response. in: query - name: min_id type: string description: >- Return only statuses *immediately newer* than the given since status ID. The status with the specified ID will not be included in the response. in: query required: false - name: limit type: integer description: Number of statuses to return. default: 20 in: query required: false - name: local type: boolean description: Show only statuses posted by local accounts. default: false in: query required: false security: - OAuth2 Bearer: - read:statuses responses: '200': name: statuses description: Array of statuses. schema: type: array items: "$ref": "#/definitions/status" headers: Link: type: string description: Links to the next and previous queries. '401': description: unauthorized '400': description: bad request
func (*Module) ListTimelineGETHandler ¶ added in v0.10.0
ListTimelineGETHandler swagger:operation GET /api/v1/timelines/list/{id} listTimeline
See statuses/posts from the given list timeline.
The statuses will be returned in descending chronological order (newest first), with sequential IDs (bigger = newer).
The returned Link header can be used to generate the previous and next queries when scrolling up or down a timeline.
Example:
``` <https://example.org/api/v1/timelines/list/01H0W619198FX7J54NF7EH1NG2?limit=20&max_id=01FC3GSQ8A3MMJ43BPZSGEG29M>; rel="next", <https://example.org/api/v1/timelines/list/01H0W619198FX7J54NF7EH1NG2?limit=20&min_id=01FC3KJW2GYXSDDRA6RWNDM46M>; rel="prev" ````
--- tags: - timelines produces: - application/json parameters: - name: id type: string description: ID of the list in: path required: true - name: max_id type: string description: >- Return only statuses *OLDER* than the given max status ID. The status with the specified ID will not be included in the response. in: query required: false - name: since_id type: string description: >- Return only statuses *NEWER* than the given since status ID. The status with the specified ID will not be included in the response. in: query - name: min_id type: string description: >- Return only statuses *NEWER* than the given since status ID. The status with the specified ID will not be included in the response. in: query required: false - name: limit type: integer description: Number of statuses to return. default: 20 in: query required: false security: - OAuth2 Bearer: - read:lists responses: '200': name: statuses description: Array of statuses. schema: type: array items: "$ref": "#/definitions/status" headers: Link: type: string description: Links to the next and previous queries. '401': description: unauthorized '400': description: bad request
func (*Module) PublicTimelineGETHandler ¶
PublicTimelineGETHandler swagger:operation GET /api/v1/timelines/public publicTimeline
See public statuses/posts that your instance is aware of.
The statuses will be returned in descending chronological order (newest first), with sequential IDs (bigger = newer).
The returned Link header can be used to generate the previous and next queries when scrolling up or down a timeline.
Example:
``` <https://example.org/api/v1/timelines/public?limit=20&max_id=01FC3GSQ8A3MMJ43BPZSGEG29M>; rel="next", <https://example.org/api/v1/timelines/public?limit=20&min_id=01FC3KJW2GYXSDDRA6RWNDM46M>; rel="prev" ````
--- tags: - timelines produces: - application/json parameters: - name: max_id type: string description: >- Return only statuses *OLDER* than the given max status ID. The status with the specified ID will not be included in the response. in: query required: false - name: since_id type: string description: >- Return only statuses *NEWER* than the given since status ID. The status with the specified ID will not be included in the response. in: query - name: min_id type: string description: >- Return only statuses *NEWER* than the given since status ID. The status with the specified ID will not be included in the response. in: query required: false - name: limit type: integer description: Number of statuses to return. default: 20 in: query required: false - name: local type: boolean description: Show only statuses posted by local accounts. default: false in: query required: false security: - OAuth2 Bearer: - read:statuses responses: '200': name: statuses description: Array of statuses. schema: type: array items: "$ref": "#/definitions/status" headers: Link: type: string description: Links to the next and previous queries. '401': description: unauthorized '400': description: bad request
func (*Module) TagTimelineGETHandler ¶ added in v0.11.0
HomeTimelineGETHandler swagger:operation GET /api/v1/timelines/tag/{tag_name} tagTimeline
See public statuses that use the given hashtag (case insensitive).
The statuses will be returned in descending chronological order (newest first), with sequential IDs (bigger = newer).
The returned Link header can be used to generate the previous and next queries when scrolling up or down a timeline.
Example:
``` <https://example.org/api/v1/timelines/tag/example?limit=20&max_id=01FC3GSQ8A3MMJ43BPZSGEG29M>; rel="next", <https://example.org/api/v1/timelines/tag/example?limit=20&min_id=01FC3KJW2GYXSDDRA6RWNDM46M>; rel="prev" ````
--- tags: - timelines produces: - application/json parameters: - name: max_id type: string description: >- Return only statuses *OLDER* than the given max status ID. The status with the specified ID will not be included in the response. in: query required: false - name: since_id type: string description: >- Return only statuses *newer* than the given since status ID. The status with the specified ID will not be included in the response. in: query - name: min_id type: string description: >- Return only statuses *immediately newer* than the given since status ID. The status with the specified ID will not be included in the response. in: query required: false - name: limit type: integer description: Number of statuses to return. default: 20 minimum: 1 maximum: 40 in: query required: false security: - OAuth2 Bearer: - read:statuses responses: '200': name: statuses description: Array of statuses. schema: type: array items: "$ref": "#/definitions/status" headers: Link: type: string description: Links to the next and previous queries. '401': description: unauthorized '400': description: bad request
Source Files