spec

Documentation

Overview

Package booking API.

the purpose of this application is to provide an application that is using plain go code to define an API

Schemes: https
Host: localhost
Version: 0.0.1

Consumes:
- application/json

Produces:
- application/json

swagger:meta

Index

• type BookingResponse
• type Customer
• type DateRange
• type IgnoreMe
• type User

Types

type BookingResponse

type BookingResponse struct {
	// Booking struct
	//
	// in: body
	// required: true
	Body struct {
		Booking  makeplans.Booking `json:"booking"`
		Customer Customer          `json:"customer"`
		Dates    DateRange         `json:"dates"`
		// example: {"key": "value"}
		Map map[string]string `json:"map"`
		// example: [1, 2]
		Slice []int `json:"slice"`
	}
}

BookingResponse represents a scheduled appointment

swagger:response BookingResponse

type Customer

type Customer = User

Customer of the site.

swagger:model Customer

type DateRange

type DateRange struct {
	Start string `json:"start"`
	End   string `json:"end"`
}

DateRange represents a scheduled appointments time DateRange should be in definitions since it's being used in a response

type IgnoreMe

type IgnoreMe struct {
	Name string `json:"name"`
}

IgnoreMe should not be added to definitions since it is not annotated.

type User

type User struct {
	Name string `json:"name"`
}