backstage

type ApiEntityV1alpha1 struct {
	Entity

	// ApiVersion is always "backstage.io/v1alpha1".
	ApiVersion string `json:"apiVersion"`

	// Kind is always "API".
	Kind string `json:"kind"`

	// Spec is the specification data describing the API itself.
	Spec *ApiEntityV1alpha1Spec `json:"spec"`
}

type ApiEntityV1alpha1Spec struct {
	// Type of the API definition.
	Type string `json:"type"`

	// Lifecycle state of the API.
	Lifecycle string `json:"lifecycle"`

	// Owner is entity reference to the owner of the API.
	Owner string `json:"owner"`

	// Definition of the API, based on the format defined by the type.
	Definition string `json:"definition"`

	// System is entity reference to the system that the API belongs to.
	System string `json:"system,omitempty"`
}

type Client struct {

	// BaseURL for API requests, e.g. http://localhost:7007/api/.
	BaseURL *url.URL

	// User agent used when communicating with the Backstage API.
	UserAgent string

	// Name of the namespace to use by default when communicating with the Backstage API.
	DefaultNamespace string

	// Catalog service to handle communication with the Backstage Catalog API.
	Catalog *catalogService
	// contains filtered or unexported fields
}

type ComponentEntityV1alpha1 struct {
	Entity

	// ApiVersion is always "backstage.io/v1alpha1".
	ApiVersion string `json:"apiVersion"`

	// Kind is always "Component".
	Kind string `json:"kind"`

	// Spec is the specification data describing the component itself.
	Spec *ComponentEntityV1alpha1Spec `json:"spec"`
}

type ComponentEntityV1alpha1Spec struct {
	// Type of component.
	Type string `json:"type"`

	// Lifecycle state of the component.
	Lifecycle string `json:"lifecycle"`

	// Owner is an entity reference to the owner of the component.
	Owner string `json:"owner"`

	// SubcomponentOf is an entity reference to another component of which the component is a part.
	SubcomponentOf string `json:"subcomponentOf,omitempty"`

	// ProvidesApis is an array of entity references to the APIs that are provided by the component.
	ProvidesApis []string `json:"providesApis,omitempty"`

	// ConsumesApis is an array of entity references to the APIs that are consumed by the component.
	ConsumesApis []string `json:"consumesApis,omitempty"`

	// DependsOn is an array of entity references to the components and resources that the component depends on.
	DependsOn []string `json:"dependsOn,omitempty"`

	// System is an array of references to other entities that the component depends on to function.
	System string `json:"system,omitempty"`
}

type DomainEntityV1alpha1 struct {
	Entity

	// ApiVersion is always "backstage.io/v1alpha1".
	ApiVersion string `json:"apiVersion"`

	// Kind is always "Domain".
	Kind string `json:"kind"`

	// Spec is the specification data describing the domain itself.
	Spec *DomainEntityV1alpha1Spec `json:"spec"`
}

type DomainEntityV1alpha1Spec struct {
	// Owner is an entity reference to the owner of the component.
	Owner string `json:"owner"`
}

type Entity struct {
	// ApiVersion is the version of specification format for this particular entity that this is written against.
	ApiVersion string `json:"apiVersion"`

	// Kind is the high level entity type being described.
	Kind string `json:"kind"`

	// Metadata is metadata related to the entity. Should always be "System".
	Metadata EntityMeta `json:"metadata"`

	// Spec is the specification data describing the entity itself.
	Spec map[string]interface{} `json:"spec,omitempty"`

	// Relations that this entity has with other entities.
	Relations []EntityRelation `json:"relations,omitempty"`
}

type EntityLink struct {
	// URL in a standard uri format.
	URL string `json:"url"`

	// Title is a user-friendly display name for the link.
	Title string `json:"title,omitempty"`

	// Icon is a key representing a visual icon to be displayed in the UI.
	Icon string `json:"icon,omitempty"`

	// Type is an optional value to categorize links into specific groups.
	Type string `json:"type,omitempty"`
}

type EntityMeta struct {
	// UID A globally unique ID for the entity. This field can not be set by the user at creation time, and the server will reject
	// an attempt to do so. The field will be populated in read operations.
	UID string `json:"uid,omitempty"`

	// Etag is an opaque string that changes for each update operation to any part of the entity, including metadata. This field
	// can not be set by the user at creation time, and the server will reject an attempt to do so. The field will be populated in read
	// operations.The field can (optionally) be specified when performing update or delete operations, and the server will then reject
	// the operation if it does not match the current stored value.
	Etag string `json:"etag,omitempty"`

	// Name of the entity. Must be unique within the catalog at any given point in time, for any given namespace + kind pair.
	Name string `json:"name"`

	// Namespace that the entity belongs to.
	Namespace string `json:"namespace,omitempty"`

	// Title is a display name of the entity, to be presented in user interfaces instead of the name property, when available.
	Title string `json:"title,omitempty"`

	// Description is a short (typically relatively few words, on one line) description of the entity.
	Description string `json:"description,omitempty"`

	// Labels are key/value pairs of identifying information attached to the entity.
	Labels map[string]string `json:"labels,omitempty"`

	// Annotations are key/value pairs of non-identifying auxiliary information attached to the entity.
	Annotations map[string]string `json:"annotations,omitempty"`

	// Tags is a list of single-valued strings, to for example classify catalog entities in various ways.
	Tags []string `json:"tags,omitempty"`

	// Links is a list of external hyperlinks related to the entity. Links can provide additional contextual
	// information that may be located outside of Backstage itself. For example, an admin dashboard or external CMS page.
	Links []EntityLink `json:"links,omitempty"`
}

type EntityRelation struct {
	// Type of the relation.
	Type string `json:"type"`

	// TargetRef is the entity ref of the target of this relation.
	TargetRef string `json:"targetRef"`

	// Target is the entity of the target of this relation.
	Target EntityRelationTarget `json:"target"`
}

type EntityRelationTarget struct {
	// Name of the target entity. Must be unique within the catalog at any given point in time, for any given namespace + kind pair.
	Name string `json:"name"`

	// Kind is the high level target entity type being described.
	Kind string `json:"kind"`

	// Namespace that the target entity belongs to.
	Namespace string `json:"namespace"`
}

type GroupEntityV1alpha1 struct {
	Entity

	// ApiVersion is always "backstage.io/v1alpha1".
	ApiVersion string `json:"apiVersion"`

	// Kind is always "Group".
	Kind string `json:"kind"`

	// Spec is the specification data describing the group itself.
	Spec *GroupEntityV1alpha1Spec `json:"spec"`
}

type GroupEntityV1alpha1Spec struct {
	// Type of group. There is currently no enforced set of values for this field, so it is left up to the adopting
	// organization to choose a nomenclature that matches their org hierarchy.
	Type string `json:"type"`

	// Profile information about the group, mainly for display purposes. All fields of this structure are also optional.
	// The email would be a group email of some form, that the group may wish to be used for contacting them.
	// The picture is expected to be a URL pointing to an image that's representative of the group, and that a browser could
	// fetch and render on a group page or similar.
	Profile struct {
		// DisplayName to present to users.
		DisplayName string `json:"displayName,omitempty"`

		// Email where this entity can be reached.
		Email string `json:"email,omitempty"`

		// Picture is a URL of an image that represents this entity.
		Picture string `json:"picture,omitempty"`
	} `json:"profile,omitempty"`

	// Parent is the immediate parent group in the hierarchy, if any. Not all groups must have a parent; the catalog supports
	// multi-root hierarchies. Groups may however not have more than one parent. This field is an entity reference.
	Parent string `json:"parent,omitempty"`

	// Children contains immediate child groups of this group in the hierarchy (whose parent field points to this group).
	// The list must be present, but may be empty if there are no child groups. The items are not guaranteed to be ordered in
	// any particular way. The entries of this array are entity references.
	Children []string `json:"children"`

	// Members contains users that are members of this group. The entries of this array are entity references.
	Members []string `json:"members,omitempty"`
}

type ListEntityOptions struct {
	// Filters is a set of conditions that can be used to filter entities.
	Filters []string

	// Fields is a set of fields that can be used to limit the response.
	Fields []string

	// Order is a set of conditions that can be used to order entities.
	Order []ListEntityOrder
}

type ListEntityOrder struct {
	// Direction is the direction to order by.
	Direction string

	// Field is the field to order by.
	Field string
}

type LocationCreateResponse struct {
	// Exists is only set in dryRun mode.
	Exists bool `json:"exists,omitempty"`
	// Location contains details of created location.
	Location *LocationResponse `json:"location,omitempty"`
	// Entities is a list of entities that were discovered from the created location.
	Entities []Entity `json:"entities"`
}

type LocationEntityV1alpha1 struct {
	Entity

	// ApiVersion is always "backstage.io/v1alpha1".
	ApiVersion string `json:"apiVersion"`

	// Kind is always "Location".
	Kind string `json:"kind"`

	// Spec is the specification data describing the location itself.
	Spec *LocationEntityV1alpha1Spec `json:"spec"`
}

type LocationEntityV1alpha1Spec struct {
	// Type is the single location type, that's common to the targets specified in the spec. If it is left out, it is inherited
	// from the location type that originally read the entity data.
	Type string `json:"type,omitempty"`

	// Target as a string. Can be either an absolute path/URL (depending on the type), or a relative path
	// such as./details/catalog-info.yaml which is resolved relative to the location of this Location entity itself.
	Target string `json:"target,omitempty"`

	// Targets contains a list of targets as strings. They can all be either absolute paths/URLs (depending on the type),
	// or relative paths such as ./details/catalog-info.yaml which are resolved relative to the location of this Location
	// entity itself.
	Targets []string `json:"targets,omitempty"`

	// Presence describes whether the presence of the location target is required, and it should be considered an error if it
	// can not be found.
	Presence string `json:"presence,omitempty"`
}

type LocationListResponse struct {
	Data *LocationResponse `json:"data"`
}

type LocationResponse struct {
	// ID of the location.
	ID string `json:"id"`
	// Type of the location.
	Type string `json:"type"`
	// Target of the location.
	Target string `json:"target"`
}

type ResourceEntityV1alpha1 struct {
	Entity

	// ApiVersion is always "backstage.io/v1alpha1".
	ApiVersion string `json:"apiVersion"`

	// Kind is always "Resource".
	Kind string `json:"kind"`

	// Spec is the specification data describing the resource itself.
	Spec *ResourceEntityV1alpha1Spec `json:"spec"`
}

type ResourceEntityV1alpha1Spec struct {
	// Type of resource.
	Type string `json:"type"`

	// Owner is an entity reference to the owner of the resource.
	Owner string `json:"owner"`

	// DependsOn is an array of references to other entities that the resource depends on to function.
	DependsOn []string `json:"dependsOn,omitempty"`

	// System is an entity reference to the system that the resource belongs to.
	System string `json:"system,omitempty"`
}

type SystemEntityV1alpha1 struct {
	Entity

	// ApiVersion is always "backstage.io/v1alpha1".
	ApiVersion string `json:"apiVersion"`

	// Kind is always "System".
	Kind string `json:"kind"`

	// Spec is the specification data describing the system itself.
	Spec *SystemEntityV1alpha1Spec `json:"spec"`
}

type SystemEntityV1alpha1Spec struct {
	// Owner is an entity reference to the owner of the system.
	Owner string `json:"owner"`

	// Domain is an entity reference to the domain that the system belongs to.
	Domain string `json:"domain,omitempty"`
}

type UserEntityV1alpha1 struct {
	Entity

	// ApiVersion is always "backstage.io/v1alpha1".
	ApiVersion string `json:"apiVersion"`

	// Kind is always "User".
	Kind string `json:"kind"`

	// Spec is the specification data describing the user itself.
	Spec *UserEntityV1alpha1Spec `json:"spec"`
}

type UserEntityV1alpha1Spec struct {
	// Profile information about the user, mainly for display purposes. All fields of this structure are also optional.
	// The email would be a primary email of some form, that the user may wish to be used for contacting them.
	// The picture is expected to be a URL pointing to an image that's representative of the user, and that a browser could
	// fetch and render on a profile page or similar.
	Profile struct {
		// DisplayName is a simple display name to present to users.
		DisplayName string `json:"displayName,omitempty"`

		// Email where this user can be reached.
		Email string `json:"email,omitempty"`

		// Picture is a URL of an image that represents this user.
		Picture string `json:"picture,omitempty"`
	} `json:"profile,omitempty"`

	// MemberOf is the list of groups that the user is a direct member of (i.e., no transitive memberships are listed here).
	// The list must be present, but may be empty if the user is not member of any groups. The items are not guaranteed to be
	// ordered in any particular way. The entries of this array are entity references.
	MemberOf []string `json:"memberOf,omitempty"`
}