GraphQL APIs

This section includes examples of GraphQL APIs for JFrog Catalog.

Note

• This API is in beta phase and subject to changes.

• The request that needs to be done for this API is a POST HTTP request to path

  /catalog/api/v1/custom/graphql with standard GraphQL over POST format for the body of the request.

Labels

Get a label with its assigned packages and package versions

{
  customCatalogLabel {
    getLabel(name: "my_label") {
      name
      description


      publicPackagesConnection(first:5) {
        edges {
          node {
            name
            type
          }
        }
      }
    
      publicPackageVersionsConnection(first:5) {
        edges {
          node {
            publicPackage {
              name
              type
            }
            version
          }
        }
      }
    }
  }
}

Get multiple labels with their assigned packages and package versions

{
  customCatalogLabel {
    searchLabels(first:10 where:{nameContainsFold:"my"} orderBy:{field:NAME, direction:ASC}) {
      edges {
        node{
          name
          description


          publicPackagesConnection(first:4) {
            edges {
              node {
                name
                type
              }
            }
          }


          publicPackageVersionsConnection(first:4) {
            edges {
              node {
                publicPackage {
                  name
                  type
                }
                version
              }
            }
          }
        }
      }
    }
  }
}

Get a package with its labels

{
  publicPackage {
    getPackage(name: "my_package" type: "npm") {
      name
      type


      customCatalogLabelsConnection(first:4) {
        edges {
          node {
            name
          }
        }
      }
    }
  }
}

Get a package version with its labels and its package with its labels

{
  publicPackageVersion {
    getVersion(name: "my_package" type: "npm" version: "1.0.0") {
      publicPackage {
        name
        type
        
        customCatalogLabelsConnection(first:4) {
          edges {
            node {
              name
            }
          }
        }
      }
      version


      customCatalogLabelsConnection(first:4) {
        edges {
          node {
            name
          }
        }
      }
    }
  }
}

Create a label

mutation {
   customCatalogLabel {
       createCustomCatalogLabel(label: {name: "my_label", description: "some description"}) {
           name
           description
       }
   }
}

Create multiple labels

mutation {
   customCatalogLabel{
       createCustomCatalogLabels(labels: [{name: "my_label1", description: "description1"}, {name: "my_label2", description: "description2"}]) {
           name
           description
       }
   }
}

Assign a label to a package

mutation {
    customCatalogLabel {
      assignCustomCatalogLabelsToPublicPackage(
        publicPackageLabels: {
          publicPackage: {name:"my_package", type:"npm"}
          labelNames:["my_label"]
        }
      )
   }
}

Assign a label to a package version

mutation {
  customCatalogLabel {
    assignCustomCatalogLabelsToPublicPackageVersion(
      publicPackageVersionLabels: {
        publicPackageVersion: {publicPackage: {name: "my_package", type: "npm"}, version: "1.0.0"}
        labelNames: ["my_label1"]
      }
    )
  }
}

Assign a label to multiple package versions

mutation {
  customCatalogLabel {
    assignCustomCatalogLabelToPublicPackageVersions(
      publicPackageVersionsLabel: {
        publicPackageVersions: [
          {publicPackage: {name: "my_package", type: "npm"}, version: "1.0.0"},
          {publicPackage: {name: "my_package", type: "npm"}, version: "1.0.0"}
        ],
        labelName: "my_label1"
      }
    )
  }
}

Remove labels from a package

mutation {
  customCatalogLabel {
    removeCustomCatalogLabelsFromPublicPackage(
      publicPackageLabels:{
        labelNames:["my_label", "my_label2"]
        publicPackage:{name:"my_package", type:"npm"}})
   }
}

Remove labels from a package version

mutation {
  customCatalogLabel {
    removeCustomCatalogLabelsFromPublicPackageVersion(
      publicPackageVersionLabels: {
        labelNames:["my_label1", "my_label2"]
        publicPackageVersion: {
          publicPackage: {name:"my_package", type:"npm"}
          version:"package_version"
        }
      }
    )
  }
}

Remove a label from multiple package versions

mutation {
  customCatalogLabel {
    removeCustomCatalogLabelFromPublicPackageVersions(
      publicPackageVersionsLabel: {
        labelName:"my_label1" 
        publicPackageVersions:[
          {publicPackage:{name:"my_package", type:"npm"} version: "1.0.0"} 
          {publicPackage:{name:"my_package", type:"npm"} version: "1.0.1"}
        ]
      }
    ) 
  }
}

Update a label

mutation {
  customCatalogLabel {
    updateCustomCatalogLabel(
  	label: {name: "my_label", updatedName: "my_label_new", updatedDescription: "updated description"}
    ) {
  	name
  	description
    }
  }
}

Delete a label

mutation {
  customCatalogLabel {
    deleteCustomCatalogLabel(label:{name:"my_label"})
   }
}

Delete multiple labels

mutation {
  customCatalogLabel {
    deleteCustomCatalogLabels(labels:[{name:"x1"}, {name:"x2"}])
  }
}

GraphQL API Error Messages