blocks

Documentation

Index

• Constants
• type Module
  • func New(processor *processing.Processor) *Module
  • func (m *Module) BlocksGETHandler(c *gin.Context)
  • func (m *Module) Route(...)

Constants

const (
	// BasePath is the base URI path for serving blocks, minus the api prefix.
	BasePath = "/v1/blocks"

	// MaxIDKey is the url query for setting a max ID to return
	MaxIDKey = "max_id"

	// SinceIDKey is the url query for returning results newer than the given ID
	SinceIDKey = "since_id"

	// LimitKey is for specifying maximum number of results to return.
	LimitKey = "limit"
)

Types

type Module

type Module struct {
	// contains filtered or unexported fields
}

func New

func New(processor *processing.Processor) *Module

func (*Module) BlocksGETHandler

func (m *Module) BlocksGETHandler(c *gin.Context)

BlocksGETHandler swagger:operation GET /api/v1/blocks blocksGet

Get an array of accounts that requesting account has blocked.

The next and previous queries can be parsed from the returned Link header. Example:

``` <https://example.org/api/v1/blocks?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/blocks?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev" ````

---
tags:
- blocks

produces:
- application/json

parameters:
-
	name: limit
	type: integer
	description: Number of blocks to return.
	default: 20
	in: query
-
	name: max_id
	type: string
	description: >-
		Return only blocks *OLDER* than the given block ID.
		The block with the specified ID will not be included in the response.
	in: query
-
	name: since_id
	type: string
	description: >-
	  Return only blocks *NEWER* than the given block ID.
	  The block with the specified ID will not be included in the response.
	in: query

security:
- OAuth2 Bearer:
	- read:blocks

responses:
	'200':
		headers:
			Link:
				type: string
				description: Links to the next and previous queries.
		schema:
			type: array
			items:
				"$ref": "#/definitions/account"
	'400':
		description: bad request
	'401':
		description: unauthorized
	'404':
		description: not found
	'406':
		description: not acceptable
	'500':
		description: internal server error

func (*Module) Route

func (m *Module) Route(attachHandler func(method string, path string, f ...gin.HandlerFunc) gin.IRoutes)