api

Documentation

Overview

Package classification OpenBazaar REST API.

p2p ecommerce application using Bitcoin

Terms Of Service:

there are no TOS at this moment, use at your own risk we take no responsibility

Schemes: http, https
Host: localhost:8080
BasePath: /ob
Version: 0.2.0
License: MIT http://opensource.org/licenses/MIT
Contact: OpenBazaar<project@openbazaar.org> https://openbazaar.org

Consumes:
- application/json

Produces:
- application/json

swagger:meta

Index

• func Serve(cb chan<- bool, node *core.OpenBazaarNode, ctx commands.Context, ...) error
• type PeerIdParam
• type ProfileModel
• type ProfileParam
• type ProfileResponse
• type RestAPIConfig
• type StatusResponse

Functions

func Serve

func Serve(cb chan<- bool, node *core.OpenBazaarNode, ctx commands.Context, lis net.Listener, options ...corehttp.ServeOption) error

Types

type PeerIdParam

type PeerIdParam struct {
	//
	// IPNS id for the peer you're trying to reach.
	// eg: QmewaTzuA2gMjHyAGFN6wTWH7cVfZeApFM98TC28aSTy1P
	//
	// in: path
	// schema: object
	// required: true
	PeerId string
}

swagger:parameters status

type ProfileModel

type ProfileModel struct {
	// Name of the user
	// required: true
	Name string `json:"name"`

	// User handle
	// Either IPNS id or Blockchain ID (i.e. @OpenBazaar)
	// required: true
	Handle string `json:"handle"`

	// About description of the peer
	// required: true
	About string `json:"about"`

	// Email address
	// required: true
	Email string `json:"email"`

	// Location
	// required: true
	Location string `json:"location"`

	// NSFW status of the peer
	// required: true
	NSFW string `json:"nsfw"`

	// Short Description
	// required: true
	ShortDescription string `json:"short_description"`

	// Vendor status of peer
	// required: true
	Vendor string `json:"vendor"`

	// URL of the user's website
	// required: true
	Website string `json:"website"`
}

ProfileModel represents a profile object

A profile holds information about peers on the network.

swagger:model ProfileModel

type ProfileParam

type ProfileParam struct {
	// Holds a Profile JSON object
	//
	// in: body
	// type: object
	// required: true
	Profile ProfileModel
}

swagger:parameters putProfile

type ProfileResponse

type ProfileResponse struct {
	// Response from server
	// in: body
	Body struct {
		// Success Status of true or false
		//
		// Required: true
		Success string `json:"success"`
		// An optional reason if there is a failure or error
		Reason string `json:"reason"`
	}
}

A ProfileResponse is the response for Profile calls swagger:response ProfileResponse

type RestAPIConfig

type RestAPIConfig struct {
	Headers      map[string][]string
	BlockList    *corehttp.BlockList
	Writable     bool
	PathPrefixes []string
}

type StatusResponse

type StatusResponse struct {
	// Response from server
	// in: body
	Body struct {
		// Success Status of true or false
		//
		// Required: true
		Status string `json:"status"`
	}
}

A StatusResponse is the response for Status calls swagger:response StatusResponse