Packages

Reference documentation for GraphQL schema types in the Packages category.

In this article

Mutations

deletePackageVersion

Mutation

Delete a package version.

Input fields for deletePackageVersion

Return fields for deletePackageVersion

NameDescription

clientMutationId (String)

A unique identifier for the client performing the mutation.

success (Boolean)

Whether or not the operation succeeded.

Objects

Package

Object

Information for an uploaded package.

Package Implements

Fields for Package

NameDescription

id (ID!)

The Node ID of the Package object.

latestVersion (PackageVersion)

Find the latest version for the package.

name (String!)

Identifies the name of the package.

packageType (PackageType!)

Identifies the type of the package.

repository (Repository)

The repository this package belongs to.

statistics (PackageStatistics)

Statistics about package activity.

version (PackageVersion)

Find package version by version string.

Arguments for version

  • version (String!)

    The package version.

versions (PackageVersionConnection!)

list of versions for this package.

Arguments for versions

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

PackageConnection

Object

The connection type for Package.

Fields for PackageConnection

NameDescription

edges ([PackageEdge])

A list of edges.

nodes ([Package])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

PackageEdge

Object

An edge in a connection.

Fields for PackageEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (Package)

The item at the end of the edge.

PackageFile

Object

A file in a package version.

PackageFile Implements

Fields for PackageFile

NameDescription

id (ID!)

The Node ID of the PackageFile object.

md5 (String)

MD5 hash of the file.

name (String!)

Name of the file.

packageVersion (PackageVersion)

The package version this file belongs to.

sha1 (String)

SHA1 hash of the file.

sha256 (String)

SHA256 hash of the file.

size (Int)

Size of the file in bytes.

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

url (URI)

URL to download the asset.

PackageFileConnection

Object

The connection type for PackageFile.

Fields for PackageFileConnection

NameDescription

edges ([PackageFileEdge])

A list of edges.

nodes ([PackageFile])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

PackageFileEdge

Object

An edge in a connection.

Fields for PackageFileEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (PackageFile)

The item at the end of the edge.

PackageStatistics

Object

Represents a object that contains package activity statistics such as downloads.

Fields for PackageStatistics

NameDescription

downloadsTotalCount (Int!)

Number of times the package was downloaded since it was created.

PackageTag

Object

A version tag contains the mapping between a tag name and a version.

PackageTag Implements

Fields for PackageTag

NameDescription

id (ID!)

The Node ID of the PackageTag object.

name (String!)

Identifies the tag name of the version.

version (PackageVersion)

Version that the tag is associated with.

PackageVersion

Object

Information about a specific package version.

PackageVersion Implements

Fields for PackageVersion

NameDescription

files (PackageFileConnection!)

List of files associated with this package version.

Arguments for files

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.

  • first (Int)

    Returns the first n elements from the list.

  • last (Int)

    Returns the last n elements from the list.

id (ID!)

The Node ID of the PackageVersion object.

package (Package)

The package associated with this version.

platform (String)

The platform this version was built for.

preRelease (Boolean!)

Whether or not this version is a pre-release.

readme (String)

The README of this package version.

release (Release)

The release associated with this package version.

statistics (PackageVersionStatistics)

Statistics about package activity.

summary (String)

The package version summary.

version (String!)

The version string.

PackageVersionConnection

Object

The connection type for PackageVersion.

Fields for PackageVersionConnection

NameDescription

edges ([PackageVersionEdge])

A list of edges.

nodes ([PackageVersion])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

totalCount (Int!)

Identifies the total count of items in the connection.

PackageVersionEdge

Object

An edge in a connection.

Fields for PackageVersionEdge

NameDescription

cursor (String!)

A cursor for use in pagination.

node (PackageVersion)

The item at the end of the edge.

PackageVersionStatistics

Object

Represents a object that contains package version activity statistics such as downloads.

Fields for PackageVersionStatistics

NameDescription

downloadsTotalCount (Int!)

Number of times the package was downloaded since it was created.

Interfaces

PackageOwner

Interface

Represents an owner of a package.

PackageOwner is implemented by

Fields for PackageOwner

NameDescription

id (ID!)

The Node ID of the PackageOwner object.

packages (PackageConnection!)

A list of packages under the owner.

Arguments for packages

  • after (String)

    Returns the elements in the list that come after the specified cursor.

  • before (String)

    Returns the elements in the list that come before the specified cursor.