projects

Documentation

Index

• Variables

Variables

var CreatePackageForm = Type("CreatePackageForm", func() {
	Required("name", "title", "summary")

	Attribute("name", String, func() {
		Description("The name of the package")
		MaxLength(100)
		Pattern(constants.SlugPattern)
	})
	Attribute("title", String, "The title of the package", func() {
		MaxLength(100)
	})
	Attribute("summary", String, "The summary of the package", func() {
		MaxLength(80)
	})
	Attribute("description", String, "The description of the package. Limited markdown syntax is supported.", func() {
		MaxLength(10000)
	})
	Attribute("url", String, "External URL for the package owner", func() {
		MaxLength(100)
	})
	Attribute("keywords", ArrayOf(String), "The keywords of the package", func() {
		MaxLength(5)
	})
	Attribute("image_asset_id", String, "The asset ID of the image to show for this package", func() {
		MaxLength(50)
	})
})

var CreatePackageResult = Type("CreatePackageResult", func() {
	Required("package")

	Attribute("package", shared.ProjectPackage, "The newly created package")
})

var ListPackagesResult = Type("ListPackagesResult", func() {
	Required("packages")

	Attribute("packages", ArrayOf(shared.ProjectPackage), "The list of packages")
})

var ListVersionsForm = Type("ListVersionsForm", func() {
	Required("name")

	Attribute("name", String, "The name of the package")
})

var ListVersionsResult = Type("ListVersionsResult", func() {
	Required("package", "versions")

	Attribute("package", shared.ProjectPackage)
	Attribute("versions", ArrayOf(shared.PackageVersion))
})

var PublishPackageForm = Type("PublishPackageForm", func() {
	Required("name", "version", "deployment_id", "visibility")

	Attribute("name", String, "The name of the package")
	Attribute("version", String, "The new semantic version of the package to publish")
	Attribute("deployment_id", String, "The deployment ID to associate with the package version")
	Attribute("visibility", String, "The visibility of the package version", func() {
		Enum("public", "private")
	})
})

var PublishPackageResult = Type("PublishPackageResult", func() {
	Required("package", "version")

	Attribute("package", shared.ProjectPackage, "The published package")
	Attribute("version", shared.PackageVersion, "The published package version")
})

var UpdatePackageForm = Type("UpdatePackageForm", func() {
	Required("id")

	Attribute("id", String, "The id of the package to update", func() {
		MaxLength(50)
	})

	Attribute("title", String, "The title of the package", func() {
		MaxLength(100)
	})
	Attribute("summary", String, "The summary of the package", func() {
		MaxLength(80)
	})
	Attribute("description", String, "The description of the package. Limited markdown syntax is supported.", func() {
		MaxLength(10000)
	})
	Attribute("url", String, "External URL for the package owner", func() {
		MaxLength(100)
	})
	Attribute("keywords", ArrayOf(String), "The keywords of the package", func() {
		MaxLength(5)
	})
	Attribute("image_asset_id", String, "The asset ID of the image to show for this package", func() {
		MaxLength(50)
	})
})

var UpdatePackageResult = Type("UpdatePackageResult", func() {
	Required("package")

	Attribute("package", shared.ProjectPackage, "The newly created package")
})