...

Text file src/edge-infra.dev/pkg/edge/api/graph/schema/labels_queries.graphql

Documentation: edge-infra.dev/pkg/edge/api/graph/schema

     1extend type Query {
     2  """
     3  Get labels gets labels by banner id. If nil will get all labels. If == empty string will return edge labels
     4  """
     5  labels(
     6    """
     7    banner edge id is the edge id for the banner
     8    """
     9    bannerEdgeId: String @hasBannerAccess(field: "bannerEdgeId")
    10  ): [Label]!
    11    @hasRole(
    12      roles: [
    13        EDGE_ORG_ADMIN
    14        EDGE_BANNER_ADMIN
    15        EDGE_BANNER_OPERATOR
    16        EDGE_BANNER_VIEWER
    17      ]
    18    )
    19  """
    20  Get label gets labels by label id
    21  """
    22  label(
    23    """
    24    labels edge id is the edge id for the label
    25    """
    26    labelEdgeId: String @hasLabelAccess(field: "labelEdgeId")
    27  ): Label
    28    @hasRole(
    29      roles: [
    30        EDGE_ORG_ADMIN
    31        EDGE_BANNER_ADMIN
    32        EDGE_BANNER_OPERATOR
    33        EDGE_BANNER_VIEWER
    34      ]
    35    )
    36  """
    37  getClusterLabels gets the mappings of labels to clusters
    38  """
    39  clusterLabels(
    40    """
    41    clusterLabelParameters is the optional paramaeters for get cluster label mappings
    42    """
    43    clusterLabelParameters: SearchClusterLabelInput!
    44  ): [ClusterLabel]!
    45    @hasRole(
    46      roles: [
    47        EDGE_ORG_ADMIN
    48        EDGE_BANNER_ADMIN
    49        EDGE_BANNER_OPERATOR
    50        EDGE_BANNER_VIEWER
    51      ]
    52    )
    53  """
    54  API to get already created label types
    55  """
    56  labelTypes(
    57    """
    58    Optional filter for label type for a banner. If empty will return types for edge.
    59    """
    60    bannerEdgeId: String @hasBannerAccess(field: "bannerEdgeId")
    61  ): [String!]
    62    @hasRole(
    63      roles: [
    64        EDGE_ORG_ADMIN
    65        EDGE_BANNER_ADMIN
    66        EDGE_BANNER_OPERATOR
    67        EDGE_BANNER_VIEWER
    68      ]
    69    )
    70}
    71
    72extend type Mutation {
    73  """
    74  Add label creates a new label
    75  """
    76  createLabel(newLabel: LabelInput): Boolean!
    77    @hasRole(roles: [EDGE_ORG_ADMIN, EDGE_BANNER_ADMIN, EDGE_BANNER_OPERATOR])
    78  """
    79  Update label updates an existing lable with the values passed in
    80  """
    81  updateLabel(newLabel: LabelUpdateInput): Boolean!
    82    @hasRole(roles: [EDGE_ORG_ADMIN, EDGE_BANNER_ADMIN, EDGE_BANNER_OPERATOR])
    83  """
    84  delete label deletes the specified label
    85  """
    86  deleteLabel(
    87    """
    88    labelEdgeID is the id of the label to be deleted
    89    """
    90    labelEdgeID: String! @hasLabelAccess(field: "labelEdgeID")
    91  ): Boolean!
    92    @hasRole(roles: [EDGE_ORG_ADMIN, EDGE_BANNER_ADMIN, EDGE_BANNER_OPERATOR])
    93  """
    94  addClusterLabel add a new mapping of label to cluster
    95  """
    96  addClusterLabel(clusterLabelParameters: NewClusterLabelInput!): Boolean!
    97    @hasRole(roles: [EDGE_ORG_ADMIN, EDGE_BANNER_ADMIN, EDGE_BANNER_OPERATOR])
    98  """
    99  addClusterLabels add a list of labels to cluster
   100  """
   101  addClusterLabels(
   102    clusterEdgeId: String!
   103    labelEdgeIds: [String!]! @hasLabelAccess(field: "labelEdgeIds")
   104  ): Boolean!
   105    @hasRole(roles: [EDGE_ORG_ADMIN, EDGE_BANNER_ADMIN, EDGE_BANNER_OPERATOR])
   106  """
   107  deleteClusterLabel deletes a cluster label mapping by either cluster id, label id or both
   108  """
   109  deleteClusterLabel(
   110    clusterLabelParameters: SearchClusterLabelInput!
   111  ): Boolean!
   112    @hasRole(roles: [EDGE_ORG_ADMIN, EDGE_BANNER_ADMIN, EDGE_BANNER_OPERATOR])
   113}

View as plain text