Skip to main content

InterfaceSpecificationVersion

A specific version of an InterfaceSpecification. Defines which InterfaceParts are active. Can be both visible (generates an Interface) and invisible (does not generate an Interface) on different Components. Can be derived by Relations, and affected by Issues. READ is granted if READ is granted on interfaceSpecification, or any InterfaceDefinition in definitions

type InterfaceSpecificationVersion implements AffectedByIssue, BaseNode, MutableTemplatedNode, Named, NamedNode, Node, TemplatedNode, Versioned {
affectingIssues(
after: String
before: String
filter: IssueFilterInput
first: Int
last: Int
orderBy: [IssueOrder!]
skip: Int
): IssueConnection!
description: String!
hasPermission(
permission: AllPermissionEntry
): Boolean!
id: ID!
interfaceDefinitions(
after: String
before: String
filter: InterfaceDefinitionFilterInput
first: Int
last: Int
orderBy: [InterfaceDefinitionOrder!]
skip: Int
): InterfaceDefinitionConnection!
interfaceSpecification: InterfaceSpecification!
name: String!
parts(
after: String
before: String
filter: InterfacePartFilterInput
first: Int
last: Int
orderBy: [InterfacePartOrder!]
skip: Int
): InterfacePartConnection!
template: InterfaceSpecificationVersionTemplate!
templatedField(
name: String!
): JSON
templatedFields(
names: [String!]
prefixMatching: Boolean
): [JSONField!]!
version: String!
}

Fields

InterfaceSpecificationVersion.affectingIssues ● IssueConnection! non-null object

The issues which affect this entity

InterfaceSpecificationVersion.affectingIssues.after ● String scalar

Get only items after the cursor

InterfaceSpecificationVersion.affectingIssues.before ● String scalar

Get only items before the cursor

InterfaceSpecificationVersion.affectingIssues.filter ● IssueFilterInput input

Filter for specific items in the connection

InterfaceSpecificationVersion.affectingIssues.first ● Int scalar

Get the first n items. Must not be used if before is specified

InterfaceSpecificationVersion.affectingIssues.last ● Int scalar

Get the last n items. Must not be used if after is specified

InterfaceSpecificationVersion.affectingIssues.orderBy ● [IssueOrder!] list input

Order in which the items are sorted

InterfaceSpecificationVersion.affectingIssues.skip ● Int scalar

Skips n items. First or last MUST be specified, is otherwise ignored

InterfaceSpecificationVersion.description ● String! non-null scalar

The description of this entity.

InterfaceSpecificationVersion.hasPermission ● Boolean! non-null scalar

Checks if the current user has a specific permission on this Node

InterfaceSpecificationVersion.hasPermission.permission ● AllPermissionEntry enum

The permission to check for

InterfaceSpecificationVersion.id ● ID! non-null scalar

The unique id of this node

InterfaceSpecificationVersion.interfaceDefinitions ● InterfaceDefinitionConnection! non-null object

Defines on which ComponentVersions this InterfaceSpecificationVersion is used

InterfaceSpecificationVersion.interfaceDefinitions.after ● String scalar

Get only items after the cursor

InterfaceSpecificationVersion.interfaceDefinitions.before ● String scalar

Get only items before the cursor

InterfaceSpecificationVersion.interfaceDefinitions.filter ● InterfaceDefinitionFilterInput input

Filter for specific items in the connection

InterfaceSpecificationVersion.interfaceDefinitions.first ● Int scalar

Get the first n items. Must not be used if before is specified

InterfaceSpecificationVersion.interfaceDefinitions.last ● Int scalar

Get the last n items. Must not be used if after is specified

InterfaceSpecificationVersion.interfaceDefinitions.orderBy ● [InterfaceDefinitionOrder!] list input

Order in which the items are sorted

InterfaceSpecificationVersion.interfaceDefinitions.skip ● Int scalar

Skips n items. First or last MUST be specified, is otherwise ignored

InterfaceSpecificationVersion.interfaceSpecification ● InterfaceSpecification! non-null object

The InterfaceSpecification this is part of.

InterfaceSpecificationVersion.name ● String! non-null scalar

The name of this entity.

InterfaceSpecificationVersion.parts ● InterfacePartConnection! non-null object

InterfaceParts which are part of this InterfaceSpecificationVersion

InterfaceSpecificationVersion.parts.after ● String scalar

Get only items after the cursor

InterfaceSpecificationVersion.parts.before ● String scalar

Get only items before the cursor

InterfaceSpecificationVersion.parts.filter ● InterfacePartFilterInput input

Filter for specific items in the connection

InterfaceSpecificationVersion.parts.first ● Int scalar

Get the first n items. Must not be used if before is specified

InterfaceSpecificationVersion.parts.last ● Int scalar

Get the last n items. Must not be used if after is specified

InterfaceSpecificationVersion.parts.orderBy ● [InterfacePartOrder!] list input

Order in which the items are sorted

InterfaceSpecificationVersion.parts.skip ● Int scalar

Skips n items. First or last MUST be specified, is otherwise ignored

InterfaceSpecificationVersion.template ● InterfaceSpecificationVersionTemplate! non-null object

The Template of this InterfaceSpecificationVersion

InterfaceSpecificationVersion.templatedField ● JSON scalar

Value of a field defined by the template. Error if such a field is not defined.

InterfaceSpecificationVersion.templatedField.name ● String! non-null scalar

Name of the extension field

InterfaceSpecificationVersion.templatedFields ● [JSONField!]! non-null object

All templatedFields If names is provided, only those matching the name. If prefixMatching is true, matching is done by prefix, otherwise by full name.

InterfaceSpecificationVersion.templatedFields.names ● [String!] list scalar

Names of the templated fields. If not provided, all templatedFields.

InterfaceSpecificationVersion.templatedFields.prefixMatching ● Boolean scalar

If true, name matching is performed as prefix matching, otherwise as absolute match. Defaults to absolute matching

InterfaceSpecificationVersion.version ● String! non-null scalar

The version of this InterfaceSpecificationVersion.

Interfaces

AffectedByIssue interface

Entities that can be affected by an Issue, meaning that this entity is in some regard impacted by e.g. a bug described by an issue, or the non-present of a feature described by an issue.

BaseNode interface

Shared extensions to the node type.

MutableTemplatedNode interface

Interface for all types which support templates describing user writeable fields.

Named interface

Entity with a name and a description.

NamedNode interface

Node with a name and description

Node interface

Base class of all nodes

TemplatedNode interface

Interface for all types which support templates.

Versioned interface

Entity with a version

Member of

CreateInterfaceSpecificationVersionPayload object ● InterfaceDefinition object ● InterfacePart object ● InterfaceSpecificationVersionConnection object ● InterfaceSpecificationVersionEdge object ● UpdateInterfaceSpecificationVersionPayload object