nr_well_known

package
v0.0.0-...-6bd88e3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 1, 2024 License: AGPL-3.0-or-later Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithAcceptApplicationJSON 

func WithAcceptApplicationJSON(r *runtime.ClientOperation)

WithAcceptApplicationJSON sets the Accept header to "application/json".

func WithAcceptApplicationJrdJSON 

func WithAcceptApplicationJrdJSON(r *runtime.ClientOperation)

WithAcceptApplicationJrdJSON sets the Accept header to "application/jrd+json".

func WithAcceptApplicationXrdXML 

func WithAcceptApplicationXrdXML(r *runtime.ClientOperation)

WithAcceptApplicationXrdXML sets the Accept header to "application/xrd+xml\"".

Types

type Client 

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

Client for nr well known API

func (*Client) HostMetaGet 

func (a *Client) HostMetaGet(params *HostMetaGetParams, opts ...ClientOption) (*HostMetaGetOK, error)

HostMetaGet returns a compliant hostmeta response to web host metadata queries

See: https://www.rfc-editor.org/rfc/rfc6415.html

func (*Client) NodeInfoWellKnownGet 

func (a *Client) NodeInfoWellKnownGet(params *NodeInfoWellKnownGetParams, opts ...ClientOption) (*NodeInfoWellKnownGetOK, error)
NodeInfoWellKnownGet returns a well known response which redirects 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

func (*Client) SetTransport 

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

func (*Client) WebfingerGet 

func (a *Client) WebfingerGet(params *WebfingerGetParams, opts ...ClientOption) (*WebfingerGetOK, error)
WebfingerGet handles webfinger account lookup requests

For example, a GET to `https://goblin.technology/.well-known/webfinger?resource=acct:tobi@goblin.technology` would return:

```

{"subject":"acct:tobi@goblin.technology","aliases":["https://goblin.technology/users/tobi","https://goblin.technology/@tobi"],"links":[{"rel":"http://webfinger.net/rel/profile-page","type":"text/html","href":"https://goblin.technology/@tobi"},{"rel":"self","type":"application/activity+json","href":"https://goblin.technology/users/tobi"}]}

```

See: https://webfinger.net/

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption may be used to customize the behavior of Client methods.

func WithAccept 

func WithAccept(mime string) ClientOption

WithAccept allows the client to force the Accept header to negotiate a specific Producer from the server.

You may use this option to set arbitrary extensions to your MIME media type.

type ClientService 

type ClientService interface {
	HostMetaGet(params *HostMetaGetParams, opts ...ClientOption) (*HostMetaGetOK, error)

	NodeInfoWellKnownGet(params *NodeInfoWellKnownGetParams, opts ...ClientOption) (*NodeInfoWellKnownGetOK, error)

	WebfingerGet(params *WebfingerGetParams, opts ...ClientOption) (*WebfingerGetOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New 

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new nr well known API client.

func NewClientWithBasicAuth 

func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService

New creates a new nr well known API client with basic auth credentials. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - user: user for basic authentication header. - password: password for basic authentication header.

func NewClientWithBearerToken 

func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService

New creates a new nr well known API client with a bearer token for authentication. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - bearerToken: bearer token for Bearer authentication header.

type HostMetaGetOK 

type HostMetaGetOK struct {
	Payload *models.HostMeta
}

HostMetaGetOK describes a response with status code 200, with default header values.

HostMetaGetOK host meta get o k

func NewHostMetaGetOK 

func NewHostMetaGetOK() *HostMetaGetOK

NewHostMetaGetOK creates a HostMetaGetOK with default headers values

func (*HostMetaGetOK) Code 

func (o *HostMetaGetOK) Code() int

Code gets the status code for the host meta get o k response

func (*HostMetaGetOK) Error 

func (o *HostMetaGetOK) Error() string

func (*HostMetaGetOK) GetPayload 

func (o *HostMetaGetOK) GetPayload() *models.HostMeta

func (*HostMetaGetOK) IsClientError 

func (o *HostMetaGetOK) IsClientError() bool

IsClientError returns true when this host meta get o k response has a 4xx status code

func (*HostMetaGetOK) IsCode 

func (o *HostMetaGetOK) IsCode(code int) bool

IsCode returns true when this host meta get o k response a status code equal to that given

func (*HostMetaGetOK) IsRedirect 

func (o *HostMetaGetOK) IsRedirect() bool

IsRedirect returns true when this host meta get o k response has a 3xx status code

func (*HostMetaGetOK) IsServerError 

func (o *HostMetaGetOK) IsServerError() bool

IsServerError returns true when this host meta get o k response has a 5xx status code

func (*HostMetaGetOK) IsSuccess 

func (o *HostMetaGetOK) IsSuccess() bool

IsSuccess returns true when this host meta get o k response has a 2xx status code

func (*HostMetaGetOK) String 

func (o *HostMetaGetOK) String() string

type HostMetaGetParams 

type HostMetaGetParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

HostMetaGetParams contains all the parameters to send to the API endpoint 

for the host meta get operation.

Typically these are written to a http.Request.

func NewHostMetaGetParams 

func NewHostMetaGetParams() *HostMetaGetParams

NewHostMetaGetParams creates a new HostMetaGetParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewHostMetaGetParamsWithContext 

func NewHostMetaGetParamsWithContext(ctx context.Context) *HostMetaGetParams

NewHostMetaGetParamsWithContext creates a new HostMetaGetParams object with the ability to set a context for a request.

func NewHostMetaGetParamsWithHTTPClient 

func NewHostMetaGetParamsWithHTTPClient(client *http.Client) *HostMetaGetParams

NewHostMetaGetParamsWithHTTPClient creates a new HostMetaGetParams object with the ability to set a custom HTTPClient for a request.

func NewHostMetaGetParamsWithTimeout 

func NewHostMetaGetParamsWithTimeout(timeout time.Duration) *HostMetaGetParams

NewHostMetaGetParamsWithTimeout creates a new HostMetaGetParams object with the ability to set a timeout on a request.

func (*HostMetaGetParams) SetContext 

func (o *HostMetaGetParams) SetContext(ctx context.Context)

SetContext adds the context to the host meta get params

func (*HostMetaGetParams) SetDefaults 

func (o *HostMetaGetParams) SetDefaults()

SetDefaults hydrates default values in the host meta get params (not the query body).

All values with no default are reset to their zero value.

func (*HostMetaGetParams) SetHTTPClient 

func (o *HostMetaGetParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the host meta get params

func (*HostMetaGetParams) SetTimeout 

func (o *HostMetaGetParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the host meta get params

func (*HostMetaGetParams) WithContext 

func (o *HostMetaGetParams) WithContext(ctx context.Context) *HostMetaGetParams

WithContext adds the context to the host meta get params

func (*HostMetaGetParams) WithDefaults 

func (o *HostMetaGetParams) WithDefaults() *HostMetaGetParams

WithDefaults hydrates default values in the host meta get params (not the query body).

All values with no default are reset to their zero value.

func (*HostMetaGetParams) WithHTTPClient 

func (o *HostMetaGetParams) WithHTTPClient(client *http.Client) *HostMetaGetParams

WithHTTPClient adds the HTTPClient to the host meta get params

func (*HostMetaGetParams) WithTimeout 

func (o *HostMetaGetParams) WithTimeout(timeout time.Duration) *HostMetaGetParams

WithTimeout adds the timeout to the host meta get params

func (*HostMetaGetParams) WriteToRequest 

func (o *HostMetaGetParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type HostMetaGetReader 

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

HostMetaGetReader is a Reader for the HostMetaGet structure.

func (*HostMetaGetReader) ReadResponse 

func (o *HostMetaGetReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type NodeInfoWellKnownGetOK 

type NodeInfoWellKnownGetOK struct {
	Payload *models.WellKnownResponse
}

NodeInfoWellKnownGetOK describes a response with status code 200, with default header values.

NodeInfoWellKnownGetOK node info well known get o k

func NewNodeInfoWellKnownGetOK 

func NewNodeInfoWellKnownGetOK() *NodeInfoWellKnownGetOK

NewNodeInfoWellKnownGetOK creates a NodeInfoWellKnownGetOK with default headers values

func (*NodeInfoWellKnownGetOK) Code 

func (o *NodeInfoWellKnownGetOK) Code() int

Code gets the status code for the node info well known get o k response

func (*NodeInfoWellKnownGetOK) Error 

func (o *NodeInfoWellKnownGetOK) Error() string

func (*NodeInfoWellKnownGetOK) GetPayload 

func (o *NodeInfoWellKnownGetOK) GetPayload() *models.WellKnownResponse

func (*NodeInfoWellKnownGetOK) IsClientError 

func (o *NodeInfoWellKnownGetOK) IsClientError() bool

IsClientError returns true when this node info well known get o k response has a 4xx status code

func (*NodeInfoWellKnownGetOK) IsCode 

func (o *NodeInfoWellKnownGetOK) IsCode(code int) bool

IsCode returns true when this node info well known get o k response a status code equal to that given

func (*NodeInfoWellKnownGetOK) IsRedirect 

func (o *NodeInfoWellKnownGetOK) IsRedirect() bool

IsRedirect returns true when this node info well known get o k response has a 3xx status code

func (*NodeInfoWellKnownGetOK) IsServerError 

func (o *NodeInfoWellKnownGetOK) IsServerError() bool

IsServerError returns true when this node info well known get o k response has a 5xx status code

func (*NodeInfoWellKnownGetOK) IsSuccess 

func (o *NodeInfoWellKnownGetOK) IsSuccess() bool

IsSuccess returns true when this node info well known get o k response has a 2xx status code

func (*NodeInfoWellKnownGetOK) String 

func (o *NodeInfoWellKnownGetOK) String() string

type NodeInfoWellKnownGetParams 

type NodeInfoWellKnownGetParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

NodeInfoWellKnownGetParams contains all the parameters to send to the API endpoint 

for the node info well known get operation.

Typically these are written to a http.Request.

func NewNodeInfoWellKnownGetParams 

func NewNodeInfoWellKnownGetParams() *NodeInfoWellKnownGetParams

NewNodeInfoWellKnownGetParams creates a new NodeInfoWellKnownGetParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewNodeInfoWellKnownGetParamsWithContext 

func NewNodeInfoWellKnownGetParamsWithContext(ctx context.Context) *NodeInfoWellKnownGetParams

NewNodeInfoWellKnownGetParamsWithContext creates a new NodeInfoWellKnownGetParams object with the ability to set a context for a request.

func NewNodeInfoWellKnownGetParamsWithHTTPClient 

func NewNodeInfoWellKnownGetParamsWithHTTPClient(client *http.Client) *NodeInfoWellKnownGetParams

NewNodeInfoWellKnownGetParamsWithHTTPClient creates a new NodeInfoWellKnownGetParams object with the ability to set a custom HTTPClient for a request.

func NewNodeInfoWellKnownGetParamsWithTimeout 

func NewNodeInfoWellKnownGetParamsWithTimeout(timeout time.Duration) *NodeInfoWellKnownGetParams

NewNodeInfoWellKnownGetParamsWithTimeout creates a new NodeInfoWellKnownGetParams object with the ability to set a timeout on a request.

func (*NodeInfoWellKnownGetParams) SetContext 

func (o *NodeInfoWellKnownGetParams) SetContext(ctx context.Context)

SetContext adds the context to the node info well known get params

func (*NodeInfoWellKnownGetParams) SetDefaults 

func (o *NodeInfoWellKnownGetParams) SetDefaults()

SetDefaults hydrates default values in the node info well known get params (not the query body).

All values with no default are reset to their zero value.

func (*NodeInfoWellKnownGetParams) SetHTTPClient 

func (o *NodeInfoWellKnownGetParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the node info well known get params

func (*NodeInfoWellKnownGetParams) SetTimeout 

func (o *NodeInfoWellKnownGetParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the node info well known get params

func (*NodeInfoWellKnownGetParams) WithContext 

func (o *NodeInfoWellKnownGetParams) WithContext(ctx context.Context) *NodeInfoWellKnownGetParams

WithContext adds the context to the node info well known get params

func (*NodeInfoWellKnownGetParams) WithDefaults 

func (o *NodeInfoWellKnownGetParams) WithDefaults() *NodeInfoWellKnownGetParams

WithDefaults hydrates default values in the node info well known get params (not the query body).

All values with no default are reset to their zero value.

func (*NodeInfoWellKnownGetParams) WithHTTPClient 

func (o *NodeInfoWellKnownGetParams) WithHTTPClient(client *http.Client) *NodeInfoWellKnownGetParams

WithHTTPClient adds the HTTPClient to the node info well known get params

func (*NodeInfoWellKnownGetParams) WithTimeout 

func (o *NodeInfoWellKnownGetParams) WithTimeout(timeout time.Duration) *NodeInfoWellKnownGetParams

WithTimeout adds the timeout to the node info well known get params

func (*NodeInfoWellKnownGetParams) WriteToRequest 

func (o *NodeInfoWellKnownGetParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type NodeInfoWellKnownGetReader 

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

NodeInfoWellKnownGetReader is a Reader for the NodeInfoWellKnownGet structure.

func (*NodeInfoWellKnownGetReader) ReadResponse 

func (o *NodeInfoWellKnownGetReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type WebfingerGetOK 

type WebfingerGetOK struct {
	Payload *models.WellKnownResponse
}

WebfingerGetOK describes a response with status code 200, with default header values.

WebfingerGetOK webfinger get o k

func NewWebfingerGetOK 

func NewWebfingerGetOK() *WebfingerGetOK

NewWebfingerGetOK creates a WebfingerGetOK with default headers values

func (*WebfingerGetOK) Code 

func (o *WebfingerGetOK) Code() int

Code gets the status code for the webfinger get o k response

func (*WebfingerGetOK) Error 

func (o *WebfingerGetOK) Error() string

func (*WebfingerGetOK) GetPayload 

func (o *WebfingerGetOK) GetPayload() *models.WellKnownResponse

func (*WebfingerGetOK) IsClientError 

func (o *WebfingerGetOK) IsClientError() bool

IsClientError returns true when this webfinger get o k response has a 4xx status code

func (*WebfingerGetOK) IsCode 

func (o *WebfingerGetOK) IsCode(code int) bool

IsCode returns true when this webfinger get o k response a status code equal to that given

func (*WebfingerGetOK) IsRedirect 

func (o *WebfingerGetOK) IsRedirect() bool

IsRedirect returns true when this webfinger get o k response has a 3xx status code

func (*WebfingerGetOK) IsServerError 

func (o *WebfingerGetOK) IsServerError() bool

IsServerError returns true when this webfinger get o k response has a 5xx status code

func (*WebfingerGetOK) IsSuccess 

func (o *WebfingerGetOK) IsSuccess() bool

IsSuccess returns true when this webfinger get o k response has a 2xx status code

func (*WebfingerGetOK) String 

func (o *WebfingerGetOK) String() string

type WebfingerGetParams 

type WebfingerGetParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

WebfingerGetParams contains all the parameters to send to the API endpoint 

for the webfinger get operation.

Typically these are written to a http.Request.

func NewWebfingerGetParams 

func NewWebfingerGetParams() *WebfingerGetParams

NewWebfingerGetParams creates a new WebfingerGetParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewWebfingerGetParamsWithContext 

func NewWebfingerGetParamsWithContext(ctx context.Context) *WebfingerGetParams

NewWebfingerGetParamsWithContext creates a new WebfingerGetParams object with the ability to set a context for a request.

func NewWebfingerGetParamsWithHTTPClient 

func NewWebfingerGetParamsWithHTTPClient(client *http.Client) *WebfingerGetParams

NewWebfingerGetParamsWithHTTPClient creates a new WebfingerGetParams object with the ability to set a custom HTTPClient for a request.

func NewWebfingerGetParamsWithTimeout 

func NewWebfingerGetParamsWithTimeout(timeout time.Duration) *WebfingerGetParams

NewWebfingerGetParamsWithTimeout creates a new WebfingerGetParams object with the ability to set a timeout on a request.

func (*WebfingerGetParams) SetContext 

func (o *WebfingerGetParams) SetContext(ctx context.Context)

SetContext adds the context to the webfinger get params

func (*WebfingerGetParams) SetDefaults 

func (o *WebfingerGetParams) SetDefaults()

SetDefaults hydrates default values in the webfinger get params (not the query body).

All values with no default are reset to their zero value.

func (*WebfingerGetParams) SetHTTPClient 

func (o *WebfingerGetParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the webfinger get params

func (*WebfingerGetParams) SetTimeout 

func (o *WebfingerGetParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the webfinger get params

func (*WebfingerGetParams) WithContext 

func (o *WebfingerGetParams) WithContext(ctx context.Context) *WebfingerGetParams

WithContext adds the context to the webfinger get params

func (*WebfingerGetParams) WithDefaults 

func (o *WebfingerGetParams) WithDefaults() *WebfingerGetParams

WithDefaults hydrates default values in the webfinger get params (not the query body).

All values with no default are reset to their zero value.

func (*WebfingerGetParams) WithHTTPClient 

func (o *WebfingerGetParams) WithHTTPClient(client *http.Client) *WebfingerGetParams

WithHTTPClient adds the HTTPClient to the webfinger get params

func (*WebfingerGetParams) WithTimeout 

func (o *WebfingerGetParams) WithTimeout(timeout time.Duration) *WebfingerGetParams

WithTimeout adds the timeout to the webfinger get params

func (*WebfingerGetParams) WriteToRequest 

func (o *WebfingerGetParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type WebfingerGetReader 

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

WebfingerGetReader is a Reader for the WebfingerGet structure.

func (*WebfingerGetReader) ReadResponse 

func (o *WebfingerGetReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.