action figshare_collection_details {
  label: "Collection details"
  description: "View a collection"
  provider: figshare
  method: GET
  path: "/collections/{collection_id}"
  encoding: json
  input: {
    type: "object"
    properties: {
      collection_id: {
        type: "integer"
        format: "int64"
      }
    }
    required: ["collection_id"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["articles_count", "authors", "categories", "citation", "created_date", "custom_fields", "description", "doi", "funding", "group_id", "group_resource_id", "handle", "id", "institution_id", "modified_date", "public", "published_date", "references", "resource_doi", "resource_id", "resource_link", "resource_title", "resource_version", "tags", "timeline", "title", "url", "version"]
    properties: {
      articles_count: {
        type: "integer"
        format: "int64"
        description: "Number of articles in collection"
      }
      authors: {
        type: "array"
        description: "List of collection authors"
        items: {
          type: "object"
          required: ["id", "full_name", "is_active", "url_name", "orcid_id"]
          properties: {
            full_name: {
              type: "string"
              description: "Author full name"
            }
            id: {
              type: "integer"
              format: "int64"
              description: "Author id"
            }
            is_active: {
              type: "boolean"
              description: "True if author has published items"
            }
            orcid_id: {
              type: "string"
              description: "Author Orcid"
            }
            url_name: {
              type: "string"
              description: "Author url name"
            }
          }
        }
      }
      categories: {
        type: "array"
        description: "List of collection categories"
        items: {
          type: "object"
          required: ["parent_id", "id", "title", "path", "source_id", "taxonomy_id"]
          properties: {
            id: {
              type: "integer"
              format: "int64"
              description: "Category id"
            }
            parent_id: {
              type: "integer"
              format: "int64"
              description: "Parent category"
            }
            path: {
              type: "string"
              description: "Path to all ancestor ids"
            }
            source_id: {
              type: "string"
              description: "ID in original standard taxonomy"
            }
            taxonomy_id: {
              type: "integer"
              format: "int64"
              description: "Internal id of taxonomy the category is part of"
            }
            title: {
              type: "string"
              description: "Category title"
            }
          }
        }
      }
      citation: {
        type: "string"
        description: "Collection citation"
      }
      created_date: {
        type: "string"
        description: "Date when collection was created"
      }
      custom_fields: {
        type: "array"
        description: "Collection custom fields"
        items: {
          type: "object"
          required: ["name", "value", "is_mandatory"]
          properties: {
            is_mandatory: {
              type: "boolean"
              description: "True if field completion is mandatory"
            }
            name: {
              type: "string"
              description: "Custom  metadata name"
            }
            value: {
              type: "string"
              description: "Custom metadata value"
            }
          }
        }
      }
      description: {
        type: "string"
        description: "Collection description"
      }
      funding: {
        type: "array"
        description: "Full Collection funding information"
        items: {
          type: "object"
          required: ["id", "title", "grant_code", "funder_name", "is_user_defined", "url"]
          properties: {
            funder_name: {
              type: "string"
              description: "Funder's name"
            }
            grant_code: {
              type: "string"
              description: "The grant code"
            }
            id: {
              type: "integer"
              format: "int64"
              description: "Funding id"
            }
            is_user_defined: {
              type: "boolean"
              description: "Return whether the grant has been introduced manually"
            }
            title: {
              type: "string"
              description: "The funding name"
            }
            url: {
              type: "string"
              format: "url"
              description: "The grant url"
            }
          }
        }
      }
      group_id: {
        type: "integer"
        format: "int64"
        description: "Collection group"
      }
      group_resource_id: {
        type: "string"
        description: "Collection group resource id"
      }
      institution_id: {
        type: "integer"
        format: "int64"
        description: "Collection institution"
      }
      modified_date: {
        type: "string"
        description: "Date when collection was last modified"
      }
      public: {
        type: "boolean"
        description: "True if collection is published"
      }
      references: {
        type: "array"
        description: "List of collection references"
        items: {
          type: "string"
          format: "url"
        }
      }
      resource_doi: {
        type: "string"
        description: "Collection resource doi"
      }
      resource_id: {
        type: "string"
        description: "Collection resource id"
      }
      resource_link: {
        type: "string"
        description: "Collection resource link"
      }
      resource_title: {
        type: "string"
        description: "Collection resource title"
      }
      resource_version: {
        type: "integer"
        format: "int64"
        description: "Collection resource version"
      }
      tags: {
        type: "array"
        description: "List of collection tags"
        items: {
          type: "string"
        }
      }
      timeline: {
        type: "object"
        required: ["firstOnline", "posted", "publisherAcceptance", "publisherPublication", "revision", "submission"]
        properties: {
          posted: {
            type: "string"
            description: "Posted date"
          }
          revision: {
            type: "string"
            description: "Revision date from curation (if curated)"
          }
          submission: {
            type: "string"
            description: "Submission date in curation (if curated)"
          }
        }
      }
      version: {
        type: "integer"
        format: "int64"
        description: "Collection version"
      }
    }
  }
}