action dodo_get_nh_fish {
  label: "All New Horizons fish"
  description: "Get a list of all fish and their details in *New Horizons*."
  provider: dodo
  method: GET
  path: "/nh/fish"
  encoding: json
  input: {
    type: "object"
    properties: {
      "Accept-Version": {
        type: "string"
      }
      "X-API-KEY": {
        type: "string"
        format: "uuid"
      }
      excludedetails: {
        type: "string"
      }
      month: {
        type: "string"
      }
      thumbsize: {
        type: "integer"
      }
    }
    required: ["Accept-Version", "X-API-KEY"]
    additionalProperties: false
  }
  output: {
    type: "array"
    items: {
      type: "object"
      properties: {
        catchphrases: {
          type: "array"
          description: "An array of possible catchphrases the player says after catching the fish. Most critters have just one, but some can have multiple."
          items: {
            type: "string"
          }
        }
        image_url: {
          type: "string"
          description: "Image of the fish. dodo.ac is Nookipedia's CDN server."
        }
        location: {
          type: "string"
          description: "Short descriptor of where the fish can be found."
        }
        name: {
          type: "string"
          description: "Name of the fish."
        }
        north: {
          type: "object"
          description: "When you can catch the fish in the Northern hemisphere."
          properties: {
            availability_array: {
              type: "array"
              description: "An array of objects, each object holding a months string and the time the critter is availabile during the specified month(s) in the northern hemisphere. Most critters will have just one object. A small number of critters have variable time availability in which case this array will have multiple objects."
              items: {
                type: "object"
                properties: {
                  months: {
                    type: "string"
                  }
                  time: {
                    type: "string"
                  }
                }
              }
            }
            months: {
              type: "string"
              description: "The months the fish is available for in the Northern hemisphere. If all year, value will be `\"All year\"`."
            }
            months_array: {
              type: "array"
              description: "An array of integers representing the months the fish is available in the Northern hemisphere."
              items: {
                type: "integer"
              }
            }
            times_by_month: {
              type: "object"
              description: "An object with twelve numerical keys, each representing a month (`\"1\"` for January, `\"2\"` for February, etc.). The value is the times the critter is available during that month. If the critter is unavailable in a month, the value will be `\"NA\"`."
              properties: {
                "1": {
                  type: "string"
                }
                "2": {
                  type: "string"
                }
                "3": {
                  type: "string"
                }
                "4": {
                  type: "string"
                }
                "5": {
                  type: "string"
                }
                "6": {
                  type: "string"
                }
                "7": {
                  type: "string"
                }
                "8": {
                  type: "string"
                }
                "9": {
                  type: "string"
                }
                "10": {
                  type: "string"
                }
                "11": {
                  type: "string"
                }
                "12": {
                  type: "string"
                }
              }
            }
          }
        }
        number: {
          type: "integer"
          description: "In-game fish number, marking position in the Critterpedia."
        }
        rarity: {
          type: "string"
          description: "How rare the fish is. Note that this field is currently empty for most fish as we do not yet know how exactly fish rarities are calculated in the game code."
        }
        render_url: {
          type: "string"
          description: "Render of the fish. dodo.ac is Nookipedia's CDN server."
        }
        sell_cj: {
          type: "integer"
          description: "The number of Bells the fish can be sold to C.J. for. This value is always 1.5x that of `sell_nook`."
        }
        sell_nook: {
          type: "integer"
          description: "The number of Bells the fish can be sold to Nook's store for."
        }
        shadow_size: {
          type: "string"
          description: "The size of the fish's shadow."
          enum: ["X-Small", "Small", "Medium", "Medium w/Fin", "Large", "Large w/Fin", "X-Large", "XX-Large", "Long"]
        }
        south: {
          type: "object"
          description: "When you can catch the fish in the Southern hemisphere."
          properties: {
            availability_array: {
              type: "array"
              description: "An array of objects, each object holding a months string and the time the critter is availabile during the specified month(s) in the southern hemisphere. Most critters will have just one object. A small number of critters have variable time availability in which case this array will have multiple objects."
              items: {
                type: "object"
                properties: {
                  months: {
                    type: "string"
                  }
                  time: {
                    type: "string"
                  }
                }
              }
            }
            months: {
              type: "string"
              description: "The months the fish is available for in the Southern hemisphere. If all year, value will be `\"All year\"`."
            }
            months_array: {
              type: "array"
              description: "An array of integers representing the months the fish is available in the Southern hemisphere."
              items: {
                type: "integer"
              }
            }
            times_by_month: {
              type: "object"
              description: "An object with twelve numerical keys, each representing a month (`\"1\"` for January, `\"2\"` for February, etc.). The value is the times the critter is available during that month. If the critter is unavailable in a month, the value will be `\"NA\"`."
              properties: {
                "1": {
                  type: "string"
                }
                "4": {
                  type: "string"
                }
                "5": {
                  type: "string"
                }
                "6": {
                  type: "string"
                }
                "7": {
                  type: "string"
                }
                "8": {
                  type: "string"
                }
                "9": {
                  type: "string"
                }
                "10": {
                  type: "string"
                }
                "11": {
                  type: "string"
                }
                "12": {
                  type: "string"
                }
                "2'": {
                  type: "string"
                }
                "3'": {
                  type: "string"
                }
              }
            }
          }
        }
        tank_length: {
          type: "number"
          format: "float"
          description: "The length of the tank when the fish is placed as a furniture item."
        }
        tank_width: {
          type: "number"
          format: "float"
          description: "The width of the tank when the fish is placed as a furniture item."
        }
        total_catch: {
          type: "integer"
          description: "The total number of fish the player has to have caught before this fish will start spawning."
        }
        url: {
          type: "string"
          description: "Link to the respective Nookipedia article."
        }
      }
    }
  }
}