server/graph/schema/item.gql

"""
An item that can be required for an issue.
"""
type Item {
    "The item's unique ID."
    id: String!
    "Name of the item."
    name: String!
    "A description of the item."
    description: String!
    "Item tags."
    tags: [String!]!
    "Quantity unit. Usually absent, but otherwise most often 'g' or 'ml'"
    quantityUnit: String
    "URL for the image, if available."
    imageUrl: String
}

"Filter for the items query."
input ItemFilter {
    "Get these item IDs. Mostly used internally."
    itemIds: [String!]
    "Limit to items with any of the following tags."
    tags: [String!]
}

"Input for the createItem mutation."
input ItemCreateInput {
    "Put a name on it."
    name: String!
    "Describe it for me."
    description: String!
    "Add a tag or a few"
    tags: [String!]!
    "Optional: Quanity unit."
    quantityUnit: String
    "Optional: Upload an image."
    image: Upload
}

"Input for the editItem mutation."
input ItemEditInput {
    "The item to edit."
    itemId: String!

    "Update the name."
    setName: String
    "Update the description."
    setDescription: String
    "Add new tags. The tags are added after removeTag tags are removed."
    addTags: [String!]
    "Remove existing tags. If a tag exists both here and in addTags, it will not be removed."
    removeTags: [String!]
    "Update quantity unit."
    setQuantityUnit: String
    "Clear quantity unit."
    clearQuantityUnit: Boolean
    "Update the image URL with a new image."
    updateImage: Upload
}