Page Comparison

Table of Contents

• Overview

• Schemas

  • Query

    • bundle

    • bundles

    • bundlesWithinDateRange

  • Mutation

    • saveBundle

    • addComponentVersionToBundle

    • deleteBundle

    • deleteCVFromBundle

• Types

  • Bundle

  • SavedBundle

  • InputBundle

  • SaveCVBundle

  • ComponentVersionUIInput

  • ComponentVersionBundleInput

  • ComponentVersionBundle

Overview

This document provides an overview of the GraphQL API for managing bundles within a project. It includes the available queries and mutations, as well as the types used in the API.

...

query {
  bundles(projectId: "10000") {
    id
    name
    projectId
    startDate
    releaseDate
    versionId
    description
    archived
    children {
      componentVersionId
    }
    released
  }
}

...

bundlesWithinDateRange

...

query {
  bundlesWithinDateRange(
    startDate: "2024-01-01"
    endDate: "2024-12-31"
    projectId: "10000"
  ) {
    id
    name
    projectId
    startDate
    releaseDate
    versionId
    description
    archived
    children {
      componentVersionId

   }     released
  }
}

...

Mutation

saveBundle

...

• newBundle: InputBundle! - The input data for the bundle.

  Status
  colour Blue title Required

• oldBundleId: String - The unique identifier of the existing bundle to update.

Returns:

• Bundle SavedBundle - The saved or updated bundle.

...

mutation {
  saveBundle(
    newBundle: {
      id: "bundle-10004-9e93307c-12ab-4a6a-9119-e427f0f1e04e",
      name: "New Bundle",
      projectId: "proj123",
      startDate: "2024-01-01",
      releaseDate: "2024-06-01",
      versionId: "v1.0",
      archived: false,
      description: "Initial bundle",
      children: [{ componentVersionId: "compVersion-10000-10000-10000" }],
      released: true
    },
    oldBundleId: "bundle-10004-9e93307c-12ab-4a6a-9119-e427f0f1e04e"
  ) {
    id
    name
    projectId
    startDate
    releaseDate
    versionId
    description
    archived
    children {
      componentVersionId
   
}     released
  }
}

...

addComponentVersionToBundle

Adds a component version to an existing bundle.

Arguments:

• bundlebundleId: SaveCVBundleInput String! - The ID of the bundle data.

  Status
  colour Blue title Required

• newComponentVersionId: String! - The ID of the new component version to add.

  Status
  colour Blue title Required

• oldComponentVersionId: String - The ID of the old component version to replace.

Returns:

• Bundle SavedBundle - The updated bundle.

Example:

mutation {
  addComponentVersionToBundle(
    bundlebundleId: {
      id: "bundle-10004-9e93307c-12ab-4a6a-9119-e427f0f1e04e",
  
   name: "Updated Bundle",       projectId: "proj123",
      startDate: "2024-01-01",
      releaseDate: "2024-06-01",
      versionId: "v1.0",
      archived: false,
      children: [{ componentVersionId: "compVersion-10000-10000-10000" }],
      released: true
    },
    newComponentVersionId: "compVersion-10001-10001-10001",
    oldComponentVersionId: "compVersion-10000-10000-10000"
  ) {
    id
    name
    projectId
    startDate
    releaseDate
    versionId
    description
    archived
    children {
      componentVersionId
   
}     released
  }
}

...

deleteBundle

Deletes a specific bundle by its ID.

...

• id: String! - The unique identifier of the bundle.

• name: String! - The name of the bundle.

• projectId: String! - The unique identifier of the project.

• startDate: String - The start date of the bundle.

• releaseDate: String - The release date of the bundle.

• versionId: String - The version identifier of the bundle.

• archived: Boolean! - Indicates if the bundle is archived.children: [ComponentVersionBundle] - The component versions included in the bundle.

• released: Boolean! - Indicates if the bundle is

...

• id: String - The unique identifier of the bundle.

• name: String! - The name of the bundle.

  Status
  colour Blue title Required

• projectId: String! - The unique identifier of the project.

  Status
  colour Blue title Required

• archived: Boolean! - Indicates if the bundle is archived.

  Status
  colour Blue title Required

• released: Boolean! - Indicates if the bundle is released.

  Status
  colour Blue title Required

• startDate: String - The start date of the bundle.

• releaseDate: String - The release date of the bundle.

• versionId: String - The version identifier of the bundle

• description: String - A description of the bundle.

• children: [ComponentVersionBundleInput] - The component versions included in the bundle.

SaveCVBundleInput

Input type for adding a component version to a bundle.

Fields:

• id: String! - The unique identifier of the bundle.

  Status
  colour Blue title Required

• name: String! - The name of the bundle.

  Status
  colour Blue title Required

• projectId: String! - The unique identifier of the project.

  Status
  colour Blue title Required

• released: Boolean! - Indicates if the bundle is released.

  Status
  colour Blue title Required

• archived: Boolean! - Indicates if the bundle is archived.

  Status
  colour Blue title Required

• startDate: String - The start date of the bundle.

• releaseDate: String - The release date of the bundle.

• versionId: String - The version identifier of the bundle.

• children: [ComponentVersionUIInput]- The component versions included in the bundle.

ComponentVersionUIInput

Input type for specifying a component version within a bundle.

Fields:

• projectId: String! - The unique identifier of the project.

  Status
  colour Blue title Required

• versionId: String! - The unique identifier of the version.

  Status
  colour Blue title Required

• componentId: String! - The unique identifier of the component.

  Status
  colour Blue title Required

ComponentVersionBundleInput

Input type for specifying a component version within a bundle.

Fields:

• componentVersionId: String! - The unique identifier of the component version. StatuscolourBluetitleRequired