design

package

v0.0.0-...-68900ed Latest Latest Go to latest Published: Jul 21, 2016 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/gopheracademy/congo

Links

Open Source Insights

Documentation ¶

Index ¶

Variables

Constants ¶

This section is empty.

Variables ¶

View Source

var AdminUserPayload = Type("AdminUserPayload", func() {
	Attribute("id", Integer)
	Attribute("tenant_id", Integer)
	Attribute("first_name", func() {
		MinLength(2)
	})
	Attribute("last_name", func() {
		MinLength(2)
	})
	Attribute("email", func() {
		MinLength(2)
	})
	Attribute("password", func() {
		MinLength(8)
	})
	Attribute("validated", Boolean, func() {
	})

	Attribute("validation_code", String, func() {
		MinLength(8)
	})

	Attribute("role")
})

AdminUserPayload defines the data structure used in the create user request body. It is also the base type for the user media type used to render users.

View Source

var Authorize = MediaType("application/vnd.authorize+json", func() {
	Description("Token authorization response")
	Attributes(func() {
		Attribute("access_token", String, "access token")
		Attribute("expires_in", Integer, "Time to expiration in seconds")
		Attribute("token_type", String, "type of token")
		Attribute("user", User, "user")
		Attribute("tenant", Tenant, "tenant")

	})
	View("default", func() {
		Attribute("access_token")
		Attribute("expires_in")
		Attribute("token_type")
		Attribute("user")
		Attribute("tenant")
	})
})

Authorize is the authorize resource media type.

View Source

var Event = MediaType("application/vnd.event+json", func() {
	Description("An event is a specific instance of a conference, e.g. GopherCon 2016")
	Attributes(func() {
		Attribute("id", Integer, "ID of record")
		Attribute("name", String, "name")
		Attribute("location", String, "location")
		Attribute("url", String, "event URL")
		Attribute("start_date", DateTime, "start_date")
		Attribute("end_date", DateTime, "end_date")
		Attribute("speakers", CollectionOf(Speaker))
		Attribute("presentations", CollectionOf(Presentation))
	})
	View("default", func() {
		Attribute("id")
		Attribute("name")
		Attribute("location")
		Attribute("url")
		Attribute("start_date")
		Attribute("end_date")
		Attribute("speakers")
		Attribute("presentations")
	})
})

Event is the event resource media type. GopherCon 2016

View Source

var EventPayload = Type("EventPayload", func() {
	Attribute("name", func() {
		MinLength(2)
	})
	Attribute("url", func() {
		MinLength(5)
	})
	Attribute("start_date", DateTime)
	Attribute("end_date", DateTime)

})

EventPayload defines the data structure used in the create event request body. It is also the base type for the event media type used to render events.

View Source

var Login = MediaType("application/vnd.login+json", func() {
	Description("")
	Attributes(func() {
		Attribute("email", String, "email")
		Attribute("password", String, "password")
	})
	View("default", func() {
		Attribute("email")
		Attribute("password")
	})
})

Login is the Login resource media type.

View Source

var Presentation = MediaType("application/vnd.presentation+json", func() {
	Description("A presentation is a scheduled talk given by a speaker")
	Attributes(func() {
		Attribute("id", Integer, "ID of record")
		Attribute("name", String, "name of presentation")
		Attribute("abstract", String, "short description of talk")
		Attribute("detail", String, "detailed description of talk - not for public display")
		Attribute("speaker", Speaker, "speaker who is giving the talk")
	})
	Links(func() {
		Link("speaker")
	})
	View("default", func() {
		Attribute("id")
		Attribute("name")
		Attribute("abstract")
		Attribute("links")
	})
	View("admin", func() {
		Attribute("id")
		Attribute("name")
		Attribute("abstract")
		Attribute("detail")
		Attribute("links")
	})
})

Presentation is the presentation resource media type.

View Source

var PresentationPayload = Type("PresentationPayload", func() {
	Attribute("abstract", func() {
		MinLength(10)
	})
	Attribute("name")
	Attribute("detail")
})

PresentationPayload defines the data structure used in the create presentation request body. It is also the base type for the presentation media type used to render presentation.

View Source

var Series = MediaType("application/vnd.series+json", func() {
	Description("A series is a recurring event, e.g. GopherCon")
	Attributes(func() {
		Attribute("id", Integer, "ID of record")
		Attribute("name", String, "name")
	})
	View("default", func() {
		Attribute("id")
		Attribute("name")
	})
})

Series is the series resource media type. GopherCon

View Source

var SeriesPayload = Type("SeriesPayload", func() {
	Attribute("name", func() {
		MinLength(2)
	})
})

SeriesPayload defines the data structure used in the create series request body. It is also the base type for the series media type used to render series.

View Source

var Speaker = MediaType("application/vnd.speaker+json", func() {
	Description("A speaker is someone giving a talk at an event")
	Attributes(func() {
		Attribute("id", Integer, "ID of record")
		Attribute("first_name", String, "first name")
		Attribute("last_name", String, "last name")
		Attribute("email", String, "email address")
		Attribute("twitter", String, "twitter handle - no @")
		Attribute("github", String, "github handle")
		Attribute("linkedin", String, "linkedin url")
		Attribute("bio", String, "speaker bio")
		Attribute("image_url", String, "url of speaker image")
		Attribute("href", String)
	})
	View("link", func() {
		Attribute("id")
		Attribute("href")
	})
	View("default", func() {
		Attribute("id")
		Attribute("first_name")
		Attribute("last_name")
		Attribute("bio")
		Attribute("twitter")
		Attribute("github")
		Attribute("linkedin")
		Attribute("image_url")
	})
	View("admin", func() {
		Attribute("id")
		Attribute("first_name")
		Attribute("last_name")
		Attribute("email")
		Attribute("bio")
		Attribute("twitter")
		Attribute("github")
		Attribute("linkedin")
		Attribute("image_url")
	})
})

Speaker is the speaker resource media type.

View Source

var SpeakerPayload = Type("SpeakerPayload", func() {
	Attribute("first_name", func() {
		MinLength(2)
	})
	Attribute("last_name", func() {
		MinLength(2)
	})
	Attribute("bio")
	Attribute("twitter")
	Attribute("linkedin")
	Attribute("github")
	Attribute("image_url", func() {
		MinLength(5)
	})

})

SpeakerPayload defines the data structure used in the create speaker request body. It is also the base type for the speaker media type used to render speakers.

View Source

var Tenant = MediaType("application/vnd.tenant+json", func() {
	Description("Tenant account in Congo")
	Attributes(func() {
		Attribute("id", Integer, "ID")
		Attribute("name", String, "name")
	})
	View("default", func() {
		Attribute("id")
		Attribute("name")
	})
})

Tenant is the tenant resource media type. GopherAcademy

View Source

var TenantPayload = Type("TenantPayload", func() {
	Attribute("name", func() {
		MinLength(2)
	})
})

TenantPayload defines the data structure used in the create tenant request body. It is also the base type for the tenant media type used to render tenants.

View Source

var User = MediaType("application/vnd.user+json", func() {
	Description("A user belonging to a tenant")
	Reference(UserPayload)
	Attributes(func() {
		Attribute("id", Integer, "ID of record")
		Attribute("href", String, "API href of record")
		Attribute("first_name", String, "First name of user")
		Attribute("last_name", String, "Last name of user")
		Attribute("active", Boolean, "Activation status")
		Attribute("validated", Boolean, "Validation status")
		Attribute("role", String, "User's role")
		Attribute("tenant_id", Integer)
		Attribute("email", String, "Email address of user", func() {
			Format("email")
		})
	})

	View("default", func() {
		Attribute("id")
		Attribute("href")
		Attribute("first_name")
		Attribute("last_name")
		Attribute("email")
		Attribute("role")
		Attribute("tenant_id")
	})

	View("tenant", func() {
		Attribute("id")
		Attribute("href")
		Attribute("first_name")
		Attribute("last_name")
		Attribute("email")
		Attribute("active")
		Attribute("validated")
		Attribute("role")
		Attribute("tenant_id")
	})

	View("link", func() {
		Attribute("id")
		Attribute("href")
		Attribute("email")
	})
})

User is the user resource media type.

View Source

var UserPayload = Type("UserPayload", func() {
	Attribute("id", Integer)
	Attribute("first_name", func() {
		MinLength(2)
	})
	Attribute("last_name", func() {
		MinLength(2)
	})
	Attribute("email", func() {
		MinLength(2)
	})
	Attribute("password", func() {
		MinLength(8)
	})
	Attribute("validated", Boolean, func() {
	})

	Attribute("validation_code", String, func() {
		MinLength(8)
	})

	Attribute("role")
})

UserPayload defines the data structure used in the create user request body. It is also the base type for the user media type used to render users.

Functions ¶

This section is empty.

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL