Interface

An interface which is part of a specific ComponentVersion. Its semantics depend on the InterfaceSpecification it is specified by, e.g. an Interface can represent a REST API. Can be used in Relations and affected by Issues. READ is granted if READ is granted on interfaceDefinition.

type Interface implements AffectedByIssue, BaseNode, MutableTemplatedNode, Named, NamedNode, Node, RelationPartner, TemplatedNode {
  affectingIssues(
    after: String
    before: String
    filter: IssueFilterInput
    first: Int
    last: Int
    orderBy: [IssueOrder!]
    skip: Int
  ): IssueConnection!
  aggregatedIssues(
    after: String
    before: String
    filter: AggregatedIssueFilterInput
    first: Int
    last: Int
    orderBy: [AggregatedIssueOrder!]
    skip: Int
  ): AggregatedIssueConnection!
  description: String!
  hasPermission(
    permission: AllPermissionEntry
  ): Boolean!
  id: ID!
  incomingRelations(
    after: String
    before: String
    filter: RelationFilterInput
    first: Int
    last: Int
    orderBy: [RelationOrder!]
    skip: Int
  ): RelationConnection!
  interfaceDefinition: InterfaceDefinition!
  intraComponentDependencyParticipants(
    after: String
    before: String
    filter: IntraComponentDependencyParticipantFilterInput
    first: Int
    last: Int
    orderBy: [IntraComponentDependencyParticipantOrder!]
    skip: Int
  ): IntraComponentDependencyParticipantConnection!
  name: String!
  outgoingRelations(
    after: String
    before: String
    filter: RelationFilterInput
    first: Int
    last: Int
    orderBy: [RelationOrder!]
    skip: Int
  ): RelationConnection!
  template: InterfaceTemplate!
  templatedField(
    name: String!
  ): JSON
  templatedFields(
    names: [String!]
    prefixMatching: Boolean
  ): [JSONField!]!
}

Fields

Interface.affectingIssues ● IssueConnection! non-null object

The issues which affect this entity

Interface.affectingIssues.after ● String scalar

Get only items after the cursor

Interface.affectingIssues.before ● String scalar

Get only items before the cursor

Interface.affectingIssues.filter ● IssueFilterInput input

Filter for specific items in the connection

Interface.affectingIssues.first ● Int scalar

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

Interface.affectingIssues.last ● Int scalar

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

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

Order in which the items are sorted

Interface.affectingIssues.skip ● Int scalar

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

Interface.aggregatedIssues ● AggregatedIssueConnection! non-null object

AggregatedIssues on this RelationPartner.

Interface.aggregatedIssues.after ● String scalar

Get only items after the cursor

Interface.aggregatedIssues.before ● String scalar

Get only items before the cursor

Interface.aggregatedIssues.filter ● AggregatedIssueFilterInput input

Filter for specific items in the connection

Interface.aggregatedIssues.first ● Int scalar

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

Interface.aggregatedIssues.last ● Int scalar

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

Interface.aggregatedIssues.orderBy ● [AggregatedIssueOrder!] list input

Order in which the items are sorted

Interface.aggregatedIssues.skip ● Int scalar

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

Interface.description ● String! non-null scalar

The description of this entity.

Interface.hasPermission ● Boolean! non-null scalar

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

Interface.hasPermission.permission ● AllPermissionEntry enum

The permission to check for

Interface.id ● ID! non-null scalar

The unique id of this node

Interface.incomingRelations ● RelationConnection! non-null object

Relations which use this as the end of the Relation.

Interface.incomingRelations.after ● String scalar

Get only items after the cursor

Interface.incomingRelations.before ● String scalar

Get only items before the cursor

Interface.incomingRelations.filter ● RelationFilterInput input

Filter for specific items in the connection

Interface.incomingRelations.first ● Int scalar

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

Interface.incomingRelations.last ● Int scalar

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

Interface.incomingRelations.orderBy ● [RelationOrder!] list input

Order in which the items are sorted

Interface.incomingRelations.skip ● Int scalar

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

Interface.interfaceDefinition ● InterfaceDefinition! non-null object

The definition of this interface.

Interface.intraComponentDependencyParticipants ● IntraComponentDependencyParticipantConnection! non-null object

Participants of IntraComponentDependencySpecifications where this is used.

Interface.intraComponentDependencyParticipants.after ● String scalar

Get only items after the cursor

Interface.intraComponentDependencyParticipants.before ● String scalar

Get only items before the cursor

Interface.intraComponentDependencyParticipants.filter ● IntraComponentDependencyParticipantFilterInput input

Filter for specific items in the connection

Interface.intraComponentDependencyParticipants.first ● Int scalar

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

Interface.intraComponentDependencyParticipants.last ● Int scalar

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

Interface.intraComponentDependencyParticipants.orderBy ● [IntraComponentDependencyParticipantOrder!] list input

Order in which the items are sorted

Interface.intraComponentDependencyParticipants.skip ● Int scalar

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

Interface.name ● String! non-null scalar

The name of this entity.

Interface.outgoingRelations ● RelationConnection! non-null object

Relations which use this as the start of the Relation.

Interface.outgoingRelations.after ● String scalar

Get only items after the cursor

Interface.outgoingRelations.before ● String scalar

Get only items before the cursor

Interface.outgoingRelations.filter ● RelationFilterInput input

Filter for specific items in the connection

Interface.outgoingRelations.first ● Int scalar

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

Interface.outgoingRelations.last ● Int scalar

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

Interface.outgoingRelations.orderBy ● [RelationOrder!] list input

Order in which the items are sorted

Interface.outgoingRelations.skip ● Int scalar

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

Interface.template ● InterfaceTemplate! non-null object

The Template of this Interface.

Interface.templatedField ● JSON scalar

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

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

Name of the extension field

Interface.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.

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

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

Interface.templatedFields.prefixMatching ● Boolean scalar

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

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

RelationPartner interface

Entity which can be used as start / end of Relations. Can be affected by Issues.

TemplatedNode interface

Interface for all types which support templates.

Member of

InterfaceConnection object ● InterfaceDefinition object ● InterfaceEdge object ● IntraComponentDependencyParticipant object ● UpdateInterfacePayload object