nodeinfo

Documentation

Index

• Constants
• func New(processor processing.Processor) api.FederationModule
• type Module
  • func (m *Module) NodeInfoGETHandler(c *gin.Context)
  • func (m *Module) NodeInfoWellKnownGETHandler(c *gin.Context)
  • func (m *Module) Route(s router.Router) error

Constants

const (
	// NodeInfoWellKnownPath is the base path for serving responses to nodeinfo lookup requests.
	NodeInfoWellKnownPath = ".well-known/nodeinfo"
	// NodeInfoBasePath is the path for serving nodeinfo responses.
	NodeInfoBasePath = "/nodeinfo/2.0"
)

Functions

func New

func New(processor processing.Processor) api.FederationModule

New returns a new nodeinfo module

Types

type Module

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

Module implements the FederationModule interface

func (*Module) NodeInfoGETHandler

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

NodeInfoGETHandler swagger:operation GET /nodeinfo/2.0 nodeInfoGet

Returns a compliant nodeinfo response to node info queries.

See: https://nodeinfo.diaspora.software/schema.html

--- tags: - nodeinfo

produces: - application/json; profile="http://nodeinfo.diaspora.software/ns/schema/2.0#"

responses:

'200':
  schema:
    "$ref": "#/definitions/nodeinfo"

func (*Module) NodeInfoWellKnownGETHandler

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

NodeInfoWellKnownGETHandler swagger:operation GET /.well-known/nodeinfo nodeInfoWellKnownGet

Directs callers to /nodeinfo/2.0.

eg. `{"links":[{"rel":"http://nodeinfo.diaspora.software/ns/schema/2.0","href":"http://example.org/nodeinfo/2.0"}]}` See: https://nodeinfo.diaspora.software/protocol.html

--- tags: - nodeinfo

produces: - application/json

responses:

'200':
  schema:
    "$ref": "#/definitions/wellKnownResponse"

func (*Module) Route

func (m *Module) Route(s router.Router) error

Route satisfies the FederationModule interface