InterfacePart

Part of an Interface(Specification). Its semantics depend on the InterfaceSpecification, e.g. for a REST API interface, this could represent a single endpoint of the API. Relations can specify for both start and end included InterfaceParts. Can be affected by Issues, and be used as start / end of ServiceEffectSpecifications. READ is granted if READ is granted on definedOn.

type InterfacePart implements AffectedByIssue, BaseNode, MutableTemplatedNode, Named, NamedAffectedByIssue, Node, TemplatedNode {
  affectingIssues(
    after: String
    before: String
    filter: IssueFilterInput
    first: Int
    last: Int
    orderBy: [IssueOrder!]
    skip: Int
  ): IssueConnection!
  description: String!
  hasPermission(
    permission: AllPermissionEntry
  ): Boolean!
  id: ID!
  includingIncomingRelations(
    after: String
    before: String
    filter: RelationFilterInput
    first: Int
    last: Int
    orderBy: [RelationOrder!]
    skip: Int
  ): RelationConnection!
  includingIntraComponentDependencyParticipants(
    after: String
    before: String
    filter: IntraComponentDependencyParticipantFilterInput
    first: Int
    last: Int
    orderBy: [IntraComponentDependencyParticipantOrder!]
    skip: Int
  ): IntraComponentDependencyParticipantConnection!
  includingOutgoingRelations(
    after: String
    before: String
    filter: RelationFilterInput
    first: Int
    last: Int
    orderBy: [RelationOrder!]
    skip: Int
  ): RelationConnection!
  name: String!
  partOf: InterfaceSpecificationVersion!
  template: InterfacePartTemplate!
  templatedField(
    name: String!
  ): JSON
  templatedFields(
    names: [String!]
    prefixMatching: Boolean
  ): [JSONField!]!
}

Fields

InterfacePart.affectingIssues ● IssueConnection! non-null object

The issues which affect this entity

InterfacePart.affectingIssues.after ● String scalar

Get only items after the cursor

InterfacePart.affectingIssues.before ● String scalar

Get only items before the cursor

InterfacePart.affectingIssues.filter ● IssueFilterInput input

Filter for specific items in the connection

InterfacePart.affectingIssues.first ● Int scalar

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

InterfacePart.affectingIssues.last ● Int scalar

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

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

Order in which the items are sorted

InterfacePart.affectingIssues.skip ● Int scalar

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

InterfacePart.description ● String! non-null scalar

The description of this entity.

InterfacePart.hasPermission ● Boolean! non-null scalar

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

InterfacePart.hasPermission.permission ● AllPermissionEntry enum

The permission to check for

InterfacePart.id ● ID! non-null scalar

The unique id of this node

InterfacePart.includingIncomingRelations ● RelationConnection! non-null object

Relations which include this InterfacePart at the end of the Relation

InterfacePart.includingIncomingRelations.after ● String scalar

Get only items after the cursor

InterfacePart.includingIncomingRelations.before ● String scalar

Get only items before the cursor

InterfacePart.includingIncomingRelations.filter ● RelationFilterInput input

Filter for specific items in the connection

InterfacePart.includingIncomingRelations.first ● Int scalar

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

InterfacePart.includingIncomingRelations.last ● Int scalar

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

InterfacePart.includingIncomingRelations.orderBy ● [RelationOrder!] list input

Order in which the items are sorted

InterfacePart.includingIncomingRelations.skip ● Int scalar

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

InterfacePart.includingIntraComponentDependencyParticipants ● IntraComponentDependencyParticipantConnection! non-null object

Participants of IntraComponentDependencySpecifications where this is used as included part.

InterfacePart.includingIntraComponentDependencyParticipants.after ● String scalar

Get only items after the cursor

InterfacePart.includingIntraComponentDependencyParticipants.before ● String scalar

Get only items before the cursor

InterfacePart.includingIntraComponentDependencyParticipants.filter ● IntraComponentDependencyParticipantFilterInput input

Filter for specific items in the connection

InterfacePart.includingIntraComponentDependencyParticipants.first ● Int scalar

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

InterfacePart.includingIntraComponentDependencyParticipants.last ● Int scalar

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

InterfacePart.includingIntraComponentDependencyParticipants.orderBy ● [IntraComponentDependencyParticipantOrder!] list input

Order in which the items are sorted

InterfacePart.includingIntraComponentDependencyParticipants.skip ● Int scalar

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

InterfacePart.includingOutgoingRelations ● RelationConnection! non-null object

Relations which include this InterfacePart at the start of the Relation

InterfacePart.includingOutgoingRelations.after ● String scalar

Get only items after the cursor

InterfacePart.includingOutgoingRelations.before ● String scalar

Get only items before the cursor

InterfacePart.includingOutgoingRelations.filter ● RelationFilterInput input

Filter for specific items in the connection

InterfacePart.includingOutgoingRelations.first ● Int scalar

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

InterfacePart.includingOutgoingRelations.last ● Int scalar

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

InterfacePart.includingOutgoingRelations.orderBy ● [RelationOrder!] list input

Order in which the items are sorted

InterfacePart.includingOutgoingRelations.skip ● Int scalar

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

InterfacePart.name ● String! non-null scalar

The name of this entity.

InterfacePart.partOf ● InterfaceSpecificationVersion! non-null object

InterfaceSpecificationVersions where this InterfacePart is active.

InterfacePart.template ● InterfacePartTemplate! non-null object

The Template of this InterfacePart

InterfacePart.templatedField ● JSON scalar

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

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

Name of the extension field

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

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

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

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

NamedAffectedByIssue interface

Affected by issue with a name and description

Node interface

Base class of all nodes

TemplatedNode interface

Interface for all types which support templates.

Member of

CreateInterfacePartPayload object ● InterfacePartConnection object ● InterfacePartEdge object ● UpdateInterfacePartPayload object