@lootlog/sdk 0.1.0 → 0.2.0

package/openapi/search.json

@@ -180,14 +180,6 @@
               ]
             },
             "required": false
-          },
-          {
-            "name": "world",
-            "in": "query",
-            "schema": {
-              "type": "string"
-            },
-            "required": false
           }
         ],
         "responses": {
@@ -304,14 +296,6 @@
             },
             "required": false
           },
-          {
-            "name": "world",
-            "in": "query",
-            "schema": {
-              "type": "string"
-            },
-            "required": false
-          },
           {
             "name": "filter",
             "in": "query",
@@ -336,36 +320,429 @@
             "name": "facets",
             "in": "query",
             "schema": {
-              "type": "array",
-              "items": {
-                "type": "string"
-              }
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "required": false,
+            "style": "form",
+            "explode": true
+          },
+          {
+            "name": "sort",
+            "in": "query",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "required": false,
+            "style": "form",
+            "explode": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Item search results",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchItemsResponseDto_Output"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    }
+                  },
+                  "required": ["message"]
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    }
+                  },
+                  "required": ["message"]
+                }
+              }
+            }
+          },
+          "429": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    }
+                  },
+                  "required": ["message"]
+                }
+              }
+            }
+          },
+          "503": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchUnavailableEncoded"
+                }
+              }
+            }
+          }
+        },
+        "summary": "Search items with filters, sorting, and facets",
+        "security": [
+          {
+            "apiKey": []
+          }
+        ],
+        "x-lootlog-access": "read",
+        "x-lootlog-data": "public"
+      }
+    },
+    "/all": {
+      "get": {
+        "tags": ["All"],
+        "operationId": "AllController_searchAll",
+        "parameters": [
+          {
+            "name": "limit",
+            "in": "query",
+            "schema": {
+              "type": "number",
+              "default": 10
+            },
+            "required": false
+          },
+          {
+            "name": "search",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "required": false
+          },
+          {
+            "name": "world",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "required": false,
+            "description": "Filters players by world. NPC and item results cover every world of their edition."
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Aggregated search results across items, players, and NPCs",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchAllResponseDto_Output"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    }
+                  },
+                  "required": ["message"]
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    }
+                  },
+                  "required": ["message"]
+                }
+              }
+            }
+          },
+          "429": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    }
+                  },
+                  "required": ["message"]
+                }
+              }
+            }
+          },
+          "503": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchUnavailableEncoded"
+                }
+              }
+            }
+          }
+        },
+        "summary": "Search across all categories",
+        "security": [
+          {
+            "apiKey": []
+          }
+        ],
+        "x-lootlog-access": "read",
+        "x-lootlog-data": "public"
+      }
+    },
+    "/public/catalog/items": {
+      "get": {
+        "tags": ["Catalog"],
+        "operationId": "CatalogController_getItems",
+        "parameters": [
+          {
+            "name": "search",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "required": false
+          },
+          {
+            "name": "gameVersion",
+            "in": "query",
+            "schema": {
+              "type": "string",
+              "enum": ["en", "pl"],
+              "description": "Only entries of this game edition."
+            },
+            "required": false
+          },
+          {
+            "name": "ids",
+            "in": "query",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "integer",
+                "minimum": -9007199254740991,
+                "maximum": 9007199254740991
+              }
+            },
+            "required": false,
+            "style": "form",
+            "explode": true
+          },
+          {
+            "name": "rarities",
+            "in": "query",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "required": false,
+            "style": "form",
+            "explode": true
+          },
+          {
+            "name": "types",
+            "in": "query",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "required": false,
+            "style": "form",
+            "explode": true
+          },
+          {
+            "name": "professions",
+            "in": "query",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "required": false,
+            "style": "form",
+            "explode": true
+          },
+          {
+            "name": "minLevel",
+            "in": "query",
+            "schema": {
+              "type": "number"
+            },
+            "required": false
+          },
+          {
+            "name": "maxLevel",
+            "in": "query",
+            "schema": {
+              "type": "number"
+            },
+            "required": false
+          },
+          {
+            "name": "statKeys",
+            "in": "query",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "required": false,
+            "style": "form",
+            "explode": true
+          },
+          {
+            "name": "excludedStatKeys",
+            "in": "query",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "required": false,
+            "style": "form",
+            "explode": true
+          },
+          {
+            "name": "legendaryBonuses",
+            "in": "query",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "required": false,
+            "style": "form",
+            "explode": true
+          },
+          {
+            "name": "dropSourceTypes",
+            "in": "query",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "required": false,
+            "style": "form",
+            "explode": true
+          },
+          {
+            "name": "event",
+            "in": "query",
+            "schema": {
+              "type": "string",
+              "description": "Items of the event with this slug: its name and year, such as `wakacje-2026`."
+            },
+            "required": false
+          },
+          {
+            "name": "droppedBy",
+            "in": "query",
+            "schema": {
+              "type": "string",
+              "description": "Items that drop from the NPC with this catalog key."
+            },
+            "required": false
+          },
+          {
+            "name": "sort",
+            "in": "query",
+            "schema": {
+              "type": "string",
+              "enum": [
+                "relevance",
+                "id:desc",
+                "lvl:asc",
+                "lvl:desc",
+                "name:asc",
+                "name:desc",
+                "attackSpeed:desc",
+                "upgradedAttackSpeed:desc"
+              ],
+              "description": "`id:desc` lists the items Margonem added most recently first. `attackSpeed:desc` lists first the items that add the most attack speed to a character with at least 100 agility: their own attack speed plus 0.002 for each point of agility or all attributes. `upgradedAttackSpeed:desc` ranks the same attack speed with each item upgraded to +5 and given the +5 bonus that adds the most of it: attack speed on weapons, agility or all attributes on other pieces."
+            },
+            "required": false
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "schema": {
+              "type": "number",
+              "default": 24
             },
-            "required": false,
-            "style": "form",
-            "explode": true
+            "required": false
           },
           {
-            "name": "sort",
+            "name": "offset",
             "in": "query",
             "schema": {
-              "type": "array",
-              "items": {
-                "type": "string"
-              }
+              "type": "number",
+              "default": 0
             },
-            "required": false,
-            "style": "form",
-            "explode": true
+            "required": false
           }
         ],
         "responses": {
           "200": {
-            "description": "Item search results",
+            "description": "Public catalog items",
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/SearchItemsResponseDto_Output"
+                  "$ref": "#/components/schemas/CatalogItemsResponseDto_Output"
                 }
               }
             }
@@ -429,7 +806,7 @@
             }
           }
         },
-        "summary": "Search items with filters, sorting, and facets",
+        "summary": "List items in the public catalog",
         "security": [
           {
             "apiKey": []
@@ -439,44 +816,96 @@
         "x-lootlog-data": "public"
       }
     },
-    "/all": {
+    "/public/catalog/npcs": {
       "get": {
-        "tags": ["All"],
-        "operationId": "AllController_searchAll",
+        "tags": ["Catalog"],
+        "operationId": "CatalogController_getNpcs",
         "parameters": [
           {
-            "name": "limit",
+            "name": "search",
             "in": "query",
             "schema": {
-              "type": "number",
-              "default": 10
+              "type": "string"
             },
             "required": false
           },
           {
-            "name": "search",
+            "name": "gameVersion",
             "in": "query",
             "schema": {
-              "type": "string"
+              "type": "string",
+              "enum": ["en", "pl"],
+              "description": "Only entries of this game edition."
             },
             "required": false
           },
           {
-            "name": "world",
+            "name": "ids",
             "in": "query",
             "schema": {
-              "type": "string"
+              "type": "array",
+              "items": {
+                "type": "integer",
+                "minimum": -9007199254740991,
+                "maximum": 9007199254740991
+              }
+            },
+            "required": false,
+            "style": "form",
+            "explode": true
+          },
+          {
+            "name": "keys",
+            "in": "query",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "required": false,
+            "style": "form",
+            "explode": true
+          },
+          {
+            "name": "types",
+            "in": "query",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "required": false,
+            "style": "form",
+            "explode": true
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "schema": {
+              "type": "number",
+              "default": 24
+            },
+            "required": false
+          },
+          {
+            "name": "offset",
+            "in": "query",
+            "schema": {
+              "type": "number",
+              "default": 0
             },
             "required": false
           }
         ],
         "responses": {
           "200": {
-            "description": "Aggregated search results across items, players, and NPCs",
+            "description": "Public catalog NPCs",
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/SearchAllResponseDto_Output"
+                  "$ref": "#/components/schemas/CatalogNpcsResponseDto_Output"
                 }
               }
             }
@@ -540,7 +969,7 @@
             }
           }
         },
-        "summary": "Search across all categories",
+        "summary": "List NPCs in the public catalog",
         "security": [
           {
             "apiKey": []
@@ -619,6 +1048,11 @@
           "id": {
             "type": "number"
           },
+          "identityNamespace": {
+            "type": "string",
+            "enum": ["legacy", "runtime", "template"],
+            "description": "Meaning of `id`: a Margonem template id, a runtime spawn id observed without a template, or an overloaded legacy id."
+          },
           "prof": {
             "type": "string"
           },
@@ -645,18 +1079,30 @@
               "EVENT_HERO",
               "COLOSSUS",
               "TITAN",
+              "HERO_TRACKER",
               "NPC"
             ]
           },
           "margonemType": {
             "type": "number"
           },
-          "world": {
-            "type": "string"
+          "worlds": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Worlds of the edition where this NPC was observed.",
+            "default": []
+          },
+          "gameVersion": {
+            "type": "string",
+            "enum": ["en", "pl"],
+            "description": "Margonem edition of the NPC: `pl` for margonem.pl, `en` for margonem.com. Equal ids in different editions are unrelated."
           }
         },
         "required": [
           "id",
+          "identityNamespace",
           "prof",
           "icon",
           "name",
@@ -664,7 +1110,8 @@
           "wt",
           "type",
           "margonemType",
-          "world"
+          "worlds",
+          "gameVersion"
         ],
         "description": "NPC search hit"
       },
@@ -863,6 +1310,11 @@
                 "id": {
                   "type": "number"
                 },
+                "identityNamespace": {
+                  "type": "string",
+                  "enum": ["legacy", "runtime", "template"],
+                  "description": "Meaning of `id`: a Margonem template id, a runtime spawn id observed without a template, or an overloaded legacy id."
+                },
                 "prof": {
                   "type": "string"
                 },
@@ -889,18 +1341,30 @@
                     "EVENT_HERO",
                     "COLOSSUS",
                     "TITAN",
+                    "HERO_TRACKER",
                     "NPC"
                   ]
                 },
                 "margonemType": {
                   "type": "number"
                 },
-                "world": {
-                  "type": "string"
+                "worlds": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  },
+                  "description": "Worlds of the edition where this NPC was observed.",
+                  "default": []
+                },
+                "gameVersion": {
+                  "type": "string",
+                  "enum": ["en", "pl"],
+                  "description": "Margonem edition of the NPC: `pl` for margonem.pl, `en` for margonem.com. Equal ids in different editions are unrelated."
                 }
               },
               "required": [
                 "id",
+                "identityNamespace",
                 "prof",
                 "icon",
                 "name",
@@ -908,7 +1372,8 @@
                 "wt",
                 "type",
                 "margonemType",
-                "world"
+                "worlds",
+                "gameVersion"
               ],
               "description": "NPC search hit"
             }
@@ -916,6 +1381,209 @@
         },
         "required": ["items", "players", "npcs"],
         "description": "Aggregated search results"
+      },
+      "CatalogItemsResponseDto_Output": {
+        "type": "object",
+        "properties": {
+          "hits": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CatalogItemDto_Output"
+            }
+          },
+          "estimatedTotalHits": {
+            "type": "number"
+          }
+        },
+        "required": ["hits", "estimatedTotalHits"],
+        "description": "Public catalog items"
+      },
+      "CatalogItemDto_Output": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "number"
+          },
+          "name": {
+            "type": "string"
+          },
+          "icon": {
+            "type": "string"
+          },
+          "stat": {
+            "type": "string"
+          },
+          "lvl": {
+            "type": "number"
+          },
+          "rarity": {
+            "nullable": true,
+            "type": "string"
+          },
+          "type": {
+            "nullable": true,
+            "type": "string"
+          },
+          "droppedBy": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CatalogDropSourceDto_Output"
+            }
+          },
+          "elasticLevel": {
+            "type": "boolean",
+            "description": "Whether the item takes the level of the character who loots it, so `lvl` and `stat` describe one of its levels."
+          }
+        },
+        "required": [
+          "id",
+          "name",
+          "icon",
+          "stat",
+          "lvl",
+          "rarity",
+          "type",
+          "droppedBy",
+          "elasticLevel"
+        ],
+        "description": "A Margonem item in the public catalog"
+      },
+      "CatalogDropSourceDto_Output": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string",
+            "description": "The NPC's catalog key, as `CatalogNpcDto_Output.key`."
+          },
+          "id": {
+            "type": "number"
+          },
+          "name": {
+            "type": "string"
+          },
+          "lvl": {
+            "nullable": true,
+            "type": "number"
+          },
+          "icon": {
+            "nullable": true,
+            "type": "string"
+          },
+          "type": {
+            "nullable": true,
+            "type": "string"
+          },
+          "retired": {
+            "type": "boolean",
+            "description": "Whether the NPC no longer drops the item: Lootlog has recorded its loot far too often since the item's last drop for the gap to be chance."
+          }
+        },
+        "required": ["key", "id", "name", "lvl", "icon", "type", "retired"],
+        "description": "An NPC an item drops from"
+      },
+      "CatalogNpcsResponseDto_Output": {
+        "type": "object",
+        "properties": {
+          "hits": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CatalogNpcDto_Output"
+            }
+          },
+          "estimatedTotalHits": {
+            "type": "number"
+          }
+        },
+        "required": ["hits", "estimatedTotalHits"],
+        "description": "Public catalog NPCs"
+      },
+      "CatalogNpcDto_Output": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string",
+            "description": "Stable catalog key of the NPC, used to link its page."
+          },
+          "id": {
+            "type": "number"
+          },
+          "name": {
+            "type": "string"
+          },
+          "icon": {
+            "type": "string"
+          },
+          "lvl": {
+            "type": "number"
+          },
+          "type": {
+            "type": "string",
+            "enum": [
+              "COMMON",
+              "ELITE",
+              "ELITE2",
+              "ELITE3",
+              "HERO",
+              "EVENT_HERO",
+              "COLOSSUS",
+              "TITAN",
+              "HERO_TRACKER",
+              "NPC"
+            ]
+          },
+          "gameVersion": {
+            "type": "string",
+            "enum": ["en", "pl"]
+          },
+          "locations": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "map": {
+                  "type": "string",
+                  "description": "The map's name."
+                },
+                "share": {
+                  "type": "number",
+                  "description": "The share of the NPC's latest recorded fights on the map, from 0 to 1, rounded to a hundredth."
+                }
+              },
+              "required": ["map", "share"]
+            },
+            "description": "Maps the NPC is fought on, most fought first, from its latest 1000 recorded fights; maps under 1% of them are left out. Lootlog recomputes them daily, so an NPC first seen today may have none yet."
+          },
+          "formerLevels": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "lvl": {
+                  "type": "number",
+                  "description": "The level it had."
+                },
+                "until": {
+                  "type": "string",
+                  "description": "The UTC day, as `YYYY-MM-DD`, its next level was first recorded."
+                }
+              },
+              "required": ["lvl", "until"]
+            },
+            "description": "Levels the NPC had before the game changed it, oldest first. Lootlog recomputes them daily from recorded fights and leaves out NPCs whose level follows the player's."
+          }
+        },
+        "required": [
+          "key",
+          "id",
+          "name",
+          "icon",
+          "lvl",
+          "type",
+          "gameVersion",
+          "locations",
+          "formerLevels"
+        ],
+        "description": "A Margonem NPC in the public catalog"
       }
     }
   }