Github API - Test Config

MarketplaceListing [object]

A listing in the GitHub integration marketplace.

Implements
Node

Node [interface]

An object with an ID.

Attributes
id ID

ID of the object.

API:
Github GraphQL API
Attributes
app App

App [object]

A GitHub App.

Implements
Node
Attributes
createdAt DateTime

Identifies the date and time when the object was created.

databaseId Int

Identifies the primary key from the database.

description String

The description of the app.

id ID

The Node ID of the App object

ipAllowListEntries IpAllowListEntryConnection

The IP addresses of the app.

logoBackgroundColor String

The hex color code, without the leading '#', for the logo background.

logoUrl URI

A URL pointing to the app's logo.

name String

The name of the app.

slug String

A slug based on the name of the app for use in URLs.

updatedAt DateTime

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

url URI

The URL to the app's homepage.

API:
Github GraphQL API

The GitHub App this listing represents.

companyUrl URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

URL to the listing owner's company site.

configurationResourcePath URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

The HTTP path for configuring access to the listing's integration or OAuth app

configurationUrl URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

The HTTP URL for configuring access to the listing's integration or OAuth app

documentationUrl URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

URL to the listing's documentation.

extendedDescription String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The listing's detailed description.

extendedDescriptionHTML HTML

HTML [scalar]

A string containing HTML code.

API:
Github GraphQL API

The listing's detailed description rendered to HTML.

fullDescription String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The listing's introductory description.

fullDescriptionHTML HTML

HTML [scalar]

A string containing HTML code.

API:
Github GraphQL API

The listing's introductory description rendered to HTML.

hasPublishedFreeTrialPlans Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Does this listing have any plans with a free trial?

hasTermsOfService Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Does this listing have a terms of service link?

hasVerifiedOwner Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Whether the creator of the app is a verified org

howItWorks String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

A technical description of how this app works with GitHub.

howItWorksHTML HTML

HTML [scalar]

A string containing HTML code.

API:
Github GraphQL API

The listing's technical description rendered to HTML.

id ID

ID [scalar]

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

API:
Github GraphQL API

The Node ID of the MarketplaceListing object

installationUrl URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

URL to install the product to the viewer's account or organization.

installedForViewer Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Whether this listing's app has been installed for the current viewer

isArchived Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Whether this listing has been removed from the Marketplace.

isDraft Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Whether this listing is still an editable draft that has not been submitted
for review and is not publicly visible in the Marketplace.

isPaid Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Whether the product this listing represents is available as part of a paid plan.

isPublic Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Whether this listing has been approved for display in the Marketplace.

isRejected Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Whether this listing has been rejected by GitHub for display in the Marketplace.

isUnverified Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Whether this listing has been approved for unverified display in the Marketplace.

isUnverifiedPending Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Whether this draft listing has been submitted for review for approval to be unverified in the Marketplace.

isVerificationPendingFromDraft Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Whether this draft listing has been submitted for review from GitHub for approval to be verified in the Marketplace.

isVerificationPendingFromUnverified Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Whether this unverified listing has been submitted for review from GitHub for approval to be verified in the Marketplace.

isVerified Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Whether this listing has been approved for verified display in the Marketplace.

logoBackgroundColor String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The hex color code, without the leading '#', for the logo background.

logoUrl URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

URL for the listing's logo image.

name String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The listing's full name.

normalizedShortDescription String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The listing's very short description without a trailing period or ampersands.

pricingUrl URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

URL to the listing's detailed pricing.

primaryCategory MarketplaceCategory

MarketplaceCategory [object]

A public description of a Marketplace category.

Implements
Node
Attributes
description String

The category's description.

howItWorks String

The technical description of how apps listed in this category work with GitHub.

id ID

The Node ID of the MarketplaceCategory object

name String

The category's name.

primaryListingCount Int

How many Marketplace listings have this as their primary category.

resourcePath URI

The HTTP path for this Marketplace category.

secondaryListingCount Int

How many Marketplace listings have this as their secondary category.

slug String

The short name of the category used in its URL.

url URI

The HTTP URL for this Marketplace category.

API:
Github GraphQL API

The category that best describes the listing.

privacyPolicyUrl URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

URL to the listing's privacy policy, may return an empty string for listings that do not require a privacy policy URL.

resourcePath URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

The HTTP path for the Marketplace listing.

screenshotUrls String []

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The URLs for the listing's screenshots.

secondaryCategory MarketplaceCategory

MarketplaceCategory [object]

A public description of a Marketplace category.

Implements
Node
Attributes
description String

The category's description.

howItWorks String

The technical description of how apps listed in this category work with GitHub.

id ID

The Node ID of the MarketplaceCategory object

name String

The category's name.

primaryListingCount Int

How many Marketplace listings have this as their primary category.

resourcePath URI

The HTTP path for this Marketplace category.

secondaryListingCount Int

How many Marketplace listings have this as their secondary category.

slug String

The short name of the category used in its URL.

url URI

The HTTP URL for this Marketplace category.

API:
Github GraphQL API

An alternate category that describes the listing.

shortDescription String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The listing's very short description.

slug String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

The short name of the listing used in its URL.

statusUrl URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

URL to the listing's status page.

supportEmail String

String [scalar]

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

API:
Github GraphQL API

An email address for support for this listing's app.

supportUrl URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

Either a URL or an email address for support for this listing's app, may
return an empty string for listings that do not require a support URL.

termsOfServiceUrl URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

URL to the listing's terms of service.

url URI

URI [scalar]

An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string.

API:
Github GraphQL API

The HTTP URL for the Marketplace listing.

viewerCanAddPlans Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Can the current viewer add plans for this Marketplace listing.

viewerCanApprove Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Can the current viewer approve this Marketplace listing.

viewerCanDelist Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Can the current viewer delist this Marketplace listing.

viewerCanEdit Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Can the current viewer edit this Marketplace listing.

viewerCanEditCategories Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Can the current viewer edit the primary and secondary category of this
Marketplace listing.

viewerCanEditPlans Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Can the current viewer edit the plans for this Marketplace listing.

viewerCanRedraft Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Can the current viewer return this Marketplace listing to draft state
so it becomes editable again.

viewerCanReject Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Can the current viewer reject this Marketplace listing by returning it to
an editable draft state or rejecting it entirely.

viewerCanRequestApproval Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Can the current viewer request this listing be reviewed for display in
the Marketplace as verified.

viewerHasPurchased Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Indicates whether the current user has an active subscription to this Marketplace listing.

viewerHasPurchasedForAllOrganizations Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Indicates if the current user has purchased a subscription to this Marketplace listing
for all of the organizations the user owns.

viewerIsListingAdmin Boolean

Boolean [scalar]

The Boolean scalar type represents true or false.

API:
Github GraphQL API

Does the current viewer role allow them to administer this Marketplace listing.

API:
Github GraphQL API