action up_get_categories {
  label: "List categories"
  description: "Retrieve a list of all categories and their ancestry. The returned list\nis not paginated.\n"
  provider: up
  method: GET
  path: "/categories"
  encoding: json
  input: {
    type: "object"
    properties: {
      "filter[parent]": {
        type: "string"
      }
    }
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "Successful response to get all categories and their ancestry. The\nreturned list is not paginated.\n"
    required: ["data"]
    properties: {
      data: {
        type: "array"
        description: "The list of categories returned in this response.\n"
        items: {
          type: "object"
          description: "Provides information about a category and its ancestry.\n"
          required: ["type", "id", "attributes", "relationships"]
          properties: {
            attributes: {
              type: "object"
              required: ["name"]
              properties: {
                name: {
                  type: "string"
                  description: "The name of this category as seen in the Up application.\n"
                }
              }
            }
            id: {
              type: "string"
              description: "The unique identifier for this category. This is a human-readable but\nURL-safe value.\n"
            }
            links: {
              type: "object"
              required: ["self"]
              properties: {
                self: {
                  type: "string"
                  description: "The canonical link to this resource within the API.\n"
                }
              }
            }
            relationships: {
              type: "object"
              required: ["parent", "children"]
              properties: {
                children: {
                  type: "object"
                  required: ["data"]
                  properties: {
                    data: {
                      type: "array"
                      items: {
                        type: "object"
                        required: ["type", "id"]
                        properties: {
                          id: {
                            type: "string"
                            description: "The unique identifier of the resource within its type.\n"
                          }
                          type: {
                            type: "string"
                            description: "The type of this resource: `categories`"
                          }
                        }
                      }
                    }
                    links: {
                      type: "object"
                      required: ["related"]
                      properties: {
                        related: {
                          type: "string"
                          description: "The link to retrieve the related resource(s) in this relationship.\n"
                        }
                      }
                    }
                  }
                }
                parent: {
                  type: "object"
                  required: ["data"]
                  properties: {
                    data: {
                      type: "object"
                      required: ["type", "id"]
                      properties: {
                        id: {
                          type: "string"
                          description: "The unique identifier of the resource within its type.\n"
                        }
                        type: {
                          type: "string"
                          description: "The type of this resource: `categories`"
                        }
                      }
                    }
                    links: {
                      type: "object"
                      required: ["related"]
                      properties: {
                        related: {
                          type: "string"
                          description: "The link to retrieve the related resource(s) in this relationship.\n"
                        }
                      }
                    }
                  }
                }
              }
            }
            type: {
              type: "string"
              description: "The type of this resource: `categories`"
            }
          }
        }
      }
    }
  }
}