media

Documentation

Index

• Variables

Variables

var Event = MediaType("application/vnd.event+json", func() {
	Description("event")
	Attributes(func() {
		Attribute("id", String, "id", func() {
			Example("5646954281304064")
			Pattern("^[0-9]{16}$")
		})
		Attribute("api_id", Integer, "APIの種別", func() {
			Example(1)
		})
		Attribute("title", String, "イベント名", func() {
			Example("イベント")
		})
		Attribute("description", String, "説明文", func() {
			Example("説明文")
		})
		Attribute("start_at", DateTime, "開始日時", func() {
			Example("2017-08-26T15:05:11.916011956Z")
		})
		Attribute("end_at", DateTime, "終了日時", func() {
			Example("2017-08-26T15:05:11.916011956Z")
		})
		Attribute("url", String, "イベントURL", func() {
			Example("http://example.com")
		})
		Attribute("address", String, "住所", func() {
			Example("大阪府大阪市北区小松原町5-8　トリオビル４F、5Ｆ")
		})
		Attribute("place", String, "開催場所", func() {
			Example("大阪府高槻市")
		})
		Attribute("area", String, "開催地域", func() {
			Example("ほげビル")
		})
		Attribute("lat", Number, "緯度", func() {
			Example(34.7033395)
		})
		Attribute("lon", Number, "経度", func() {
			Example(135.5014871)
		})
		Attribute("limit", Integer, "参加上限人数", func() {
			Example(10)
		})
		Attribute("accepted", Integer, "参加済み人数", func() {
			Example(10)
		})
		Attribute("waiting", Integer, "キャンセル待ち人数", func() {
			Example(5)
		})
		Attribute("updated_at", DateTime, "更新日時", func() {
			Example("2017-08-26T15:05:11.916011956Z")
		})
		Attribute("tags", ArrayOf(String), "ジャンルタグ", func() {
			Example([]string{"js", "php", "Go"})
		})
		Attribute("is_favorite", Boolean, "お気に入り済み", func() {
			Example(false)
		})
		Attribute("is_red", Boolean, "既読済み", func() {
			Example(true)
		})
		Required(
			"id",
			"api_id",
			"title",
			"description",
			"start_at",
			"end_at",
			"url",
			"address",
			"place",
			"area",
			"lat",
			"lon",
			"limit",
			"accepted",
			"waiting",
			"updated_at",
			"is_favorite",
			"is_red",
			"tags",
		)
	})
	View("tiny", func() {
		Attribute("id")
		Attribute("api_id")
		Attribute("title")

		Attribute("start_at")
		Attribute("end_at")
		Attribute("url")

		Attribute("area")

		Attribute("limit")
		Attribute("accepted")

		Attribute("updated_at")
		Attribute("is_favorite")
		Attribute("is_red")
		Attribute("tags")
		Required(
			"id",
			"api_id",
			"title",

			"start_at",
			"end_at",
			"url",

			"area",

			"limit",
			"accepted",

			"updated_at",
			"is_favorite",
			"is_red",
			"tags",
		)
	})
	View("default", func() {
		Attribute("id")
		Attribute("api_id")
		Attribute("title")
		Attribute("description")
		Attribute("start_at")
		Attribute("end_at")
		Attribute("url")
		Attribute("address")
		Attribute("place")
		Attribute("area")
		Attribute("lat")
		Attribute("lon")
		Attribute("limit")
		Attribute("accepted")
		Attribute("waiting")
		Attribute("updated_at")

		Attribute("tags")
		Required(
			"id",
			"api_id",
			"title",
			"description",
			"start_at",
			"end_at",
			"url",
			"address",
			"place",
			"area",
			"lat",
			"lon",
			"limit",
			"accepted",
			"waiting",
			"updated_at",

			"tags",
		)
	})
	View("show", func() {
		Attribute("id")
		Attribute("api_id")
		Attribute("title")
		Attribute("description")
		Attribute("start_at")
		Attribute("end_at")
		Attribute("url")
		Attribute("address")
		Attribute("place")
		Attribute("area")
		Attribute("lat")
		Attribute("lon")
		Attribute("limit")
		Attribute("accepted")
		Attribute("waiting")
		Attribute("updated_at")
		Attribute("is_favorite")
		Attribute("is_red")
		Attribute("tags")
		Required(
			"id",
			"api_id",
			"title",
			"description",
			"start_at",
			"end_at",
			"url",
			"address",
			"place",
			"area",
			"lat",
			"lon",
			"limit",
			"accepted",
			"waiting",
			"updated_at",
			"is_favorite",
			"is_red",
			"tags",
		)
	})
	View("full", func() {
		Attribute("id")
		Attribute("api_id")
		Attribute("title")
		Attribute("description")
		Attribute("start_at")
		Attribute("end_at")
		Attribute("url")
		Attribute("address")
		Attribute("place")
		Attribute("area")
		Attribute("lat")
		Attribute("lon")
		Attribute("limit")
		Attribute("accepted")
		Attribute("waiting")
		Attribute("updated_at")
		Attribute("is_favorite")
		Attribute("is_red")
		Attribute("tags")
		Required(
			"id",
			"api_id",
			"title",
			"description",
			"start_at",
			"end_at",
			"url",
			"address",
			"place",
			"area",
			"lat",
			"lon",
			"limit",
			"accepted",
			"waiting",
			"updated_at",
			"is_favorite",
			"is_red",
			"tags",
		)
	})
})

var Session = MediaType("application/vnd.session+json", func() {
	Description("セッション情報")
	Attributes(func() {
		Attribute("token", String, "トークン", func() {
			Example("ECB666D778725EC97307044D642BF4D160AABB76F56C0069C71EA25B1E926825")
		})
		Attribute("expire", DateTime, "トークン期限", func() {
			Example("2017-08-26T15:05:11.916011956Z")
		})
		Attribute("name", String, "ユーザー名", func() {
			Example("hogeさん")
		})
		Attribute("avater_url", String, "アバターURL", func() {
			Example("https://avatars3.githubusercontent.com/u/9821370?v=4&s=460")
		})
		Required("token", "expire", "name", "avater_url")
	})
	View("default", func() {
		Attribute("token")
		Attribute("name")
		Attribute("expire")
		Attribute("avater_url")
	})
})

var User = MediaType("application/vnd.user+json", func() {
	Description("user")
	Attributes(func() {
		Attribute("id", String, "id", func() {
			Example("9223372036854775807")
		})
		Attribute("name", String, "ユーザー名")
		Required(
			"id",
			"name",
		)
	})
	View("default", func() {
		Attribute("id")
		Attribute("name")
		Required(
			"id",
			"name",
		)
	})
	View("full", func() {
		Attribute("id")
		Attribute("name")
		Required(
			"id",
			"name",
		)
	})
})