action figshare_articles_search {
  label: "Public Articles Search"
  description: "Returns a list of public articles, filtered by the search parameters"
  provider: figshare
  method: POST
  path: "/articles/search"
  encoding: json
  input: {
    type: "object"
    properties: {
      "X-Cursor": {
        type: "string"
        format: "uuid"
      }
      doi: {
        type: "string"
        description: "Only return articles with this doi"
      }
      handle: {
        type: "string"
        description: "Only return articles with this handle"
      }
      item_type: {
        type: "integer"
        format: "int64"
        description: "Only return articles with the respective type. Mapping for item_type is: 1 - Figure, 2 - Media, 3 - Dataset, 5 - Poster, 6 - Journal contribution, 7 - Presentation, 8 - Thesis, 9 - Software, 11 - Online resource, 12 - Preprint, 13 - Book, 14 - Conference contribution, 15 - Chapter, 16 - Peer review, 17 - Educational resource, 18 - Report, 19 - Standard, 20 - Composition, 21 - Funding, 22 - Physical object, 23 - Data management plan, 24 - Workflow, 25 - Monograph, 26 - Performance, 27 - Event, 28 - Service, 29 - Model"
      }
      order: {
        type: "string"
        description: "The field by which to order"
        enum: ["published_date", "modified_date", "views", "shares", "downloads", "cites"]
      }
      project_id: {
        type: "integer"
        format: "int64"
        description: "Only return articles in this project"
      }
      resource_doi: {
        type: "string"
        description: "Only return articles with this resource_doi"
      }
    }
    additionalProperties: false
  }
  output: {
    type: "array"
    items: {
      type: "object"
      required: ["project_id", "id", "title", "doi", "handle", "group_id", "url", "url_public_html", "url_public_api", "url_private_html", "url_private_api", "published_date", "timeline", "thumb", "defined_type", "defined_type_name"]
      properties: {
        project_id: {
          type: "integer"
          format: "int64"
          description: "Project id for this article."
        }
      }
    }
  }
}