[{"data":1,"prerenderedAt":1180},["ShallowReactive",2],{"navigation":3,"\u002Fpackages\u002Fadonisjs-api-query\u002Fgetting-started\u002Fconfiguration":273,"\u002Fpackages\u002Fadonisjs-api-query\u002Fgetting-started\u002Fconfiguration-surround":1126,"packages-data":1131},[4,23],{"title":5,"path":6,"stem":7,"children":8,"icon":22},"Getting Started","\u002Fgetting-started","1.getting-started\u002F1.index",[9,12,17],{"title":10,"path":6,"stem":7,"icon":11},"Introduction","i-tabler-home",{"title":13,"path":14,"stem":15,"icon":16},"Manifest","\u002Fgetting-started\u002Fmanifest","1.getting-started\u002F2.manifest","i-tabler-file-diff",{"title":18,"path":19,"stem":20,"icon":21},"Contributing","\u002Fgetting-started\u002Fcontributing","1.getting-started\u002F3.contributing","i-tabler-git-fork",false,{"title":24,"path":25,"stem":26,"children":27,"icon":30},"Packages","\u002Fpackages","2.packages\u002F1.index",[28,31,108,194,247],{"title":29,"path":25,"stem":26,"icon":30},"Overview","i-tabler-packages",{"title":32,"icon":33,"path":34,"stem":35,"children":36,"page":22},"AdonisJS API Query","i-tabler-filter-search","\u002Fpackages\u002Fadonisjs-api-query","2.packages\u002Fadonisjs-api-query",[37,56,87],{"title":5,"icon":38,"path":39,"stem":40,"children":41,"page":22},"i-tabler-rocket","\u002Fpackages\u002Fadonisjs-api-query\u002Fgetting-started","2.packages\u002Fadonisjs-api-query\u002F1.getting-started",[42,46,51],{"title":10,"path":43,"stem":44,"icon":45},"\u002Fpackages\u002Fadonisjs-api-query\u002Fgetting-started\u002Fintroduction","2.packages\u002Fadonisjs-api-query\u002F1.getting-started\u002F1.introduction","i-tabler-book",{"title":47,"path":48,"stem":49,"icon":50},"Installation","\u002Fpackages\u002Fadonisjs-api-query\u002Fgetting-started\u002Finstallation","2.packages\u002Fadonisjs-api-query\u002F1.getting-started\u002F2.installation","i-tabler-download",{"title":52,"path":53,"stem":54,"icon":55},"Configuration","\u002Fpackages\u002Fadonisjs-api-query\u002Fgetting-started\u002Fconfiguration","2.packages\u002Fadonisjs-api-query\u002F1.getting-started\u002F3.configuration","i-tabler-settings",{"title":57,"icon":58,"path":59,"stem":60,"children":61,"page":22},"Features","i-tabler-sparkles","\u002Fpackages\u002Fadonisjs-api-query\u002Ffeatures","2.packages\u002Fadonisjs-api-query\u002F2.features",[62,67,72,77,82],{"title":63,"path":64,"stem":65,"icon":66},"Filtering","\u002Fpackages\u002Fadonisjs-api-query\u002Ffeatures\u002Ffiltering","2.packages\u002Fadonisjs-api-query\u002F2.features\u002F1.filtering","i-tabler-filter",{"title":68,"path":69,"stem":70,"icon":71},"Sorting","\u002Fpackages\u002Fadonisjs-api-query\u002Ffeatures\u002Fsorting","2.packages\u002Fadonisjs-api-query\u002F2.features\u002F2.sorting","i-tabler-arrows-sort",{"title":73,"path":74,"stem":75,"icon":76},"Including Relationships","\u002Fpackages\u002Fadonisjs-api-query\u002Ffeatures\u002Fincluding-relationships","2.packages\u002Fadonisjs-api-query\u002F2.features\u002F3.including-relationships","i-tabler-hierarchy-2",{"title":78,"path":79,"stem":80,"icon":81},"Filterable Classes","\u002Fpackages\u002Fadonisjs-api-query\u002Ffeatures\u002Ffilterable-classes","2.packages\u002Fadonisjs-api-query\u002F2.features\u002F4.filterable-classes","i-tabler-box-model",{"title":83,"path":84,"stem":85,"icon":86},"Validation","\u002Fpackages\u002Fadonisjs-api-query\u002Ffeatures\u002Fvalidation","2.packages\u002Fadonisjs-api-query\u002F2.features\u002F5.validation","i-tabler-shield-check",{"title":88,"icon":89,"path":90,"stem":91,"children":92,"page":22},"Advanced Usage","i-tabler-adjustments","\u002Fpackages\u002Fadonisjs-api-query\u002Fadvanced","2.packages\u002Fadonisjs-api-query\u002F3.advanced",[93,98,103],{"title":94,"path":95,"stem":96,"icon":97},"Custom Filters, Sorts & Includes","\u002Fpackages\u002Fadonisjs-api-query\u002Fadvanced\u002Fcustom-clauses","2.packages\u002Fadonisjs-api-query\u002F3.advanced\u002F1.custom-clauses","i-tabler-puzzle",{"title":99,"path":100,"stem":101,"icon":102},"Request & Delimiters","\u002Fpackages\u002Fadonisjs-api-query\u002Fadvanced\u002Frequest-and-delimiters","2.packages\u002Fadonisjs-api-query\u002F3.advanced\u002F2.request-and-delimiters","i-tabler-brackets-contain",{"title":104,"path":105,"stem":106,"icon":107},"Exceptions","\u002Fpackages\u002Fadonisjs-api-query\u002Fadvanced\u002Fexceptions","2.packages\u002Fadonisjs-api-query\u002F3.advanced\u002F3.exceptions","i-tabler-alert-triangle",{"title":109,"icon":110,"path":111,"stem":112,"children":113,"page":22},"AdonisJS Permission","i-tabler-shield-lock","\u002Fpackages\u002Fadonisjs-permission","2.packages\u002Fadonisjs-permission",[114,127,157,183],{"title":5,"icon":38,"path":115,"stem":116,"children":117,"page":22},"\u002Fpackages\u002Fadonisjs-permission\u002Fgetting-started","2.packages\u002Fadonisjs-permission\u002F1.getting-started",[118,121,124],{"title":10,"path":119,"stem":120,"icon":45},"\u002Fpackages\u002Fadonisjs-permission\u002Fgetting-started\u002Fintroduction","2.packages\u002Fadonisjs-permission\u002F1.getting-started\u002F1.introduction",{"title":47,"path":122,"stem":123,"icon":50},"\u002Fpackages\u002Fadonisjs-permission\u002Fgetting-started\u002Finstallation","2.packages\u002Fadonisjs-permission\u002F1.getting-started\u002F2.installation",{"title":52,"path":125,"stem":126,"icon":55},"\u002Fpackages\u002Fadonisjs-permission\u002Fgetting-started\u002Fconfiguration","2.packages\u002Fadonisjs-permission\u002F1.getting-started\u002F3.configuration",{"title":128,"icon":86,"path":129,"stem":130,"children":131,"page":22},"Basic Usage","\u002Fpackages\u002Fadonisjs-permission\u002Fbasic-usage","2.packages\u002Fadonisjs-permission\u002F2.basic-usage",[132,137,142,147,152],{"title":133,"path":134,"stem":135,"icon":136},"Roles & Permissions","\u002Fpackages\u002Fadonisjs-permission\u002Fbasic-usage\u002Froles-and-permissions","2.packages\u002Fadonisjs-permission\u002F2.basic-usage\u002F1.roles-and-permissions","i-tabler-users",{"title":138,"path":139,"stem":140,"icon":141},"Checking Access","\u002Fpackages\u002Fadonisjs-permission\u002Fbasic-usage\u002Fchecking","2.packages\u002Fadonisjs-permission\u002F2.basic-usage\u002F2.checking","i-tabler-checks",{"title":143,"path":144,"stem":145,"icon":146},"Middleware","\u002Fpackages\u002Fadonisjs-permission\u002Fbasic-usage\u002Fmiddleware","2.packages\u002Fadonisjs-permission\u002F2.basic-usage\u002F3.middleware","i-tabler-route",{"title":148,"path":149,"stem":150,"icon":151},"Wildcard Permissions","\u002Fpackages\u002Fadonisjs-permission\u002Fbasic-usage\u002Fwildcard-permissions","2.packages\u002Fadonisjs-permission\u002F2.basic-usage\u002F4.wildcard-permissions","i-tabler-asterisk",{"title":153,"path":154,"stem":155,"icon":156},"Catalog & Sync","\u002Fpackages\u002Fadonisjs-permission\u002Fbasic-usage\u002Fcatalog","2.packages\u002Fadonisjs-permission\u002F2.basic-usage\u002F5.catalog","i-tabler-refresh",{"title":158,"icon":159,"path":160,"stem":161,"children":162,"page":22},"Advanced","i-tabler-tool","\u002Fpackages\u002Fadonisjs-permission\u002Fadvanced","2.packages\u002Fadonisjs-permission\u002F3.advanced",[163,168,173,178],{"title":164,"path":165,"stem":166,"icon":167},"Teams","\u002Fpackages\u002Fadonisjs-permission\u002Fadvanced\u002Fteams","2.packages\u002Fadonisjs-permission\u002F3.advanced\u002F1.teams","i-tabler-building",{"title":169,"path":170,"stem":171,"icon":172},"Super-Admin","\u002Fpackages\u002Fadonisjs-permission\u002Fadvanced\u002Fsuper-admin","2.packages\u002Fadonisjs-permission\u002F3.advanced\u002F2.super-admin","i-tabler-crown",{"title":174,"path":175,"stem":176,"icon":177},"Events","\u002Fpackages\u002Fadonisjs-permission\u002Fadvanced\u002Fevents","2.packages\u002Fadonisjs-permission\u002F3.advanced\u002F3.events","i-tabler-radio",{"title":179,"path":180,"stem":181,"icon":182},"Cache","\u002Fpackages\u002Fadonisjs-permission\u002Fadvanced\u002Fcache","2.packages\u002Fadonisjs-permission\u002F3.advanced\u002F4.cache","i-tabler-database",{"title":184,"icon":185,"path":186,"stem":187,"children":188,"page":22},"Upgrading","i-tabler-circle-arrow-up","\u002Fpackages\u002Fadonisjs-permission\u002Fupgrading","2.packages\u002Fadonisjs-permission\u002F4.upgrading",[189],{"title":190,"path":191,"stem":192,"icon":193},"From adonis-lucid-permission","\u002Fpackages\u002Fadonisjs-permission\u002Fupgrading\u002Ffrom-adonis-lucid-permission","2.packages\u002Fadonisjs-permission\u002F4.upgrading\u002F1.from-adonis-lucid-permission","i-tabler-git-compare",{"title":195,"icon":196,"path":197,"stem":198,"children":199,"page":22},"Simple Auth","i-tabler-key","\u002Fpackages\u002Fadonisjs-simple-auth","2.packages\u002Fadonisjs-simple-auth",[200,214,233],{"title":5,"icon":38,"path":201,"stem":202,"children":203,"page":22},"\u002Fpackages\u002Fadonisjs-simple-auth\u002Fgetting-started","2.packages\u002Fadonisjs-simple-auth\u002F1.getting-started",[204,208,211],{"title":10,"path":205,"stem":206,"icon":207},"\u002Fpackages\u002Fadonisjs-simple-auth\u002Fgetting-started\u002Fintroduction","2.packages\u002Fadonisjs-simple-auth\u002F1.getting-started\u002F1.introduction","i-tabler-info-circle",{"title":47,"path":209,"stem":210,"icon":50},"\u002Fpackages\u002Fadonisjs-simple-auth\u002Fgetting-started\u002Finstallation","2.packages\u002Fadonisjs-simple-auth\u002F1.getting-started\u002F2.installation",{"title":52,"path":212,"stem":213,"icon":55},"\u002Fpackages\u002Fadonisjs-simple-auth\u002Fgetting-started\u002Fconfiguration","2.packages\u002Fadonisjs-simple-auth\u002F1.getting-started\u002F3.configuration",{"title":215,"icon":110,"path":216,"stem":217,"children":218,"page":22},"Usage","\u002Fpackages\u002Fadonisjs-simple-auth\u002Fusage","2.packages\u002Fadonisjs-simple-auth\u002F2.usage",[219,224,229],{"title":220,"path":221,"stem":222,"icon":223},"Generating API Keys","\u002Fpackages\u002Fadonisjs-simple-auth\u002Fusage\u002Fgenerating-api-keys","2.packages\u002Fadonisjs-simple-auth\u002F2.usage\u002F1.generating-api-keys","i-tabler-terminal-2",{"title":225,"path":226,"stem":227,"icon":228},"Protecting Routes","\u002Fpackages\u002Fadonisjs-simple-auth\u002Fusage\u002Fprotecting-routes","2.packages\u002Fadonisjs-simple-auth\u002F2.usage\u002F2.protecting-routes","i-tabler-lock",{"title":230,"path":231,"stem":232,"icon":107},"Error Handling & i18n","\u002Fpackages\u002Fadonisjs-simple-auth\u002Fusage\u002Ferror-handling","2.packages\u002Fadonisjs-simple-auth\u002F2.usage\u002F3.error-handling",{"title":158,"icon":89,"path":234,"stem":235,"children":236,"page":22},"\u002Fpackages\u002Fadonisjs-simple-auth\u002Fadvanced","2.packages\u002Fadonisjs-simple-auth\u002F3.advanced",[237,242],{"title":238,"path":239,"stem":240,"icon":241},"Testing with Japa","\u002Fpackages\u002Fadonisjs-simple-auth\u002Fadvanced\u002Ftesting-with-japa","2.packages\u002Fadonisjs-simple-auth\u002F3.advanced\u002F1.testing-with-japa","i-tabler-flask",{"title":243,"path":244,"stem":245,"icon":246},"API Reference","\u002Fpackages\u002Fadonisjs-simple-auth\u002Fadvanced\u002Fapi-reference","2.packages\u002Fadonisjs-simple-auth\u002F3.advanced\u002F2.api-reference","i-tabler-code",{"title":248,"icon":249,"path":250,"stem":251,"children":252,"page":22},"AdonisJS Soft Deletes","i-tabler-trash-off","\u002Fpackages\u002Fadonisjs-soft-deletes","2.packages\u002Fadonisjs-soft-deletes",[253,263],{"title":5,"icon":38,"path":254,"stem":255,"children":256,"page":22},"\u002Fpackages\u002Fadonisjs-soft-deletes\u002Fgetting-started","2.packages\u002Fadonisjs-soft-deletes\u002F1.getting-started",[257,260],{"title":10,"path":258,"stem":259,"icon":207},"\u002Fpackages\u002Fadonisjs-soft-deletes\u002Fgetting-started\u002Fintroduction","2.packages\u002Fadonisjs-soft-deletes\u002F1.getting-started\u002F1.introduction",{"title":47,"path":261,"stem":262,"icon":50},"\u002Fpackages\u002Fadonisjs-soft-deletes\u002Fgetting-started\u002Finstallation","2.packages\u002Fadonisjs-soft-deletes\u002F1.getting-started\u002F2.installation",{"title":215,"icon":45,"path":264,"stem":265,"children":266,"page":22},"\u002Fpackages\u002Fadonisjs-soft-deletes\u002Fusage","2.packages\u002Fadonisjs-soft-deletes\u002F2.usage",[267,270],{"title":215,"path":268,"stem":269,"icon":246},"\u002Fpackages\u002Fadonisjs-soft-deletes\u002Fusage\u002Fusage","2.packages\u002Fadonisjs-soft-deletes\u002F2.usage\u002F1.usage",{"title":243,"path":271,"stem":272,"icon":45},"\u002Fpackages\u002Fadonisjs-soft-deletes\u002Fusage\u002Fapi-reference","2.packages\u002Fadonisjs-soft-deletes\u002F2.usage\u002F2.api-reference",{"id":274,"title":52,"body":275,"description":1120,"extension":1121,"meta":1122,"navigation":1123,"path":53,"seo":1124,"stem":54,"__hash__":1125},"docs\u002F2.packages\u002Fadonisjs-api-query\u002F1.getting-started\u002F3.configuration.md",{"type":276,"value":277,"toc":1109},"minimark",[278,295,300,649,653,659,665,774,788,794,815,839,845,860,863,867,896,899,971,977,992,1012,1016,1105],[279,280,281,282,286,287,290,291,294],"p",{},"When you configure the package, a ",[283,284,285],"code",{},"config\u002Fapiquery.ts"," file is created in your project. It uses the ",[283,288,289],{},"defineConfig"," helper from ",[283,292,293],{},"@eienjs\u002Fadonisjs-api-query",".",[296,297,299],"h2",{"id":298},"default-configuration","Default Configuration",[301,302,307],"pre",{"className":303,"code":304,"filename":285,"language":305,"meta":306,"style":306},"language-ts shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","import { defineConfig } from '@eienjs\u002Fadonisjs-api-query';\n\nconst apiQueryConfig = defineConfig({\n  parameters: {\n    include: 'include',\n    filter: 'filter',\n    sort: 'sort',\n    fields: 'fields',\n    append: 'append',\n  },\n\n  countSuffix: 'Count',\n  existsSuffix: 'Exists',\n\n  disableInvalidFilterQueryException: false,\n  disableInvalidSortQueryException: false,\n  disableInvalidIncludesQueryException: false,\n\n  convertRelationNamesToSnakeCasePlural: false,\n  convertRelationTableNameStrategy: false,\n  convertFieldNamesToSnakeCase: false,\n\n  autoValidate: true,\n});\n\nexport default apiQueryConfig;\n","ts","",[283,308,309,344,351,373,386,404,421,438,455,472,478,483,500,517,522,536,548,560,565,577,589,601,606,619,630,635],{"__ignoreMap":306},[310,311,314,318,322,326,329,332,335,338,341],"span",{"class":312,"line":313},"line",1,[310,315,317],{"class":316},"s7zQu","import",[310,319,321],{"class":320},"sMK4o"," {",[310,323,325],{"class":324},"sTEyZ"," defineConfig",[310,327,328],{"class":320}," }",[310,330,331],{"class":316}," from",[310,333,334],{"class":320}," '",[310,336,293],{"class":337},"sfazB",[310,339,340],{"class":320},"'",[310,342,343],{"class":320},";\n",[310,345,347],{"class":312,"line":346},2,[310,348,350],{"emptyLinePlaceholder":349},true,"\n",[310,352,354,358,361,364,367,370],{"class":312,"line":353},3,[310,355,357],{"class":356},"spNyl","const",[310,359,360],{"class":324}," apiQueryConfig ",[310,362,363],{"class":320},"=",[310,365,325],{"class":366},"s2Zo4",[310,368,369],{"class":324},"(",[310,371,372],{"class":320},"{\n",[310,374,376,380,383],{"class":312,"line":375},4,[310,377,379],{"class":378},"swJcz","  parameters",[310,381,382],{"class":320},":",[310,384,385],{"class":320}," {\n",[310,387,389,392,394,396,399,401],{"class":312,"line":388},5,[310,390,391],{"class":378},"    include",[310,393,382],{"class":320},[310,395,334],{"class":320},[310,397,398],{"class":337},"include",[310,400,340],{"class":320},[310,402,403],{"class":320},",\n",[310,405,407,410,412,414,417,419],{"class":312,"line":406},6,[310,408,409],{"class":378},"    filter",[310,411,382],{"class":320},[310,413,334],{"class":320},[310,415,416],{"class":337},"filter",[310,418,340],{"class":320},[310,420,403],{"class":320},[310,422,424,427,429,431,434,436],{"class":312,"line":423},7,[310,425,426],{"class":378},"    sort",[310,428,382],{"class":320},[310,430,334],{"class":320},[310,432,433],{"class":337},"sort",[310,435,340],{"class":320},[310,437,403],{"class":320},[310,439,441,444,446,448,451,453],{"class":312,"line":440},8,[310,442,443],{"class":378},"    fields",[310,445,382],{"class":320},[310,447,334],{"class":320},[310,449,450],{"class":337},"fields",[310,452,340],{"class":320},[310,454,403],{"class":320},[310,456,458,461,463,465,468,470],{"class":312,"line":457},9,[310,459,460],{"class":378},"    append",[310,462,382],{"class":320},[310,464,334],{"class":320},[310,466,467],{"class":337},"append",[310,469,340],{"class":320},[310,471,403],{"class":320},[310,473,475],{"class":312,"line":474},10,[310,476,477],{"class":320},"  },\n",[310,479,481],{"class":312,"line":480},11,[310,482,350],{"emptyLinePlaceholder":349},[310,484,486,489,491,493,496,498],{"class":312,"line":485},12,[310,487,488],{"class":378},"  countSuffix",[310,490,382],{"class":320},[310,492,334],{"class":320},[310,494,495],{"class":337},"Count",[310,497,340],{"class":320},[310,499,403],{"class":320},[310,501,503,506,508,510,513,515],{"class":312,"line":502},13,[310,504,505],{"class":378},"  existsSuffix",[310,507,382],{"class":320},[310,509,334],{"class":320},[310,511,512],{"class":337},"Exists",[310,514,340],{"class":320},[310,516,403],{"class":320},[310,518,520],{"class":312,"line":519},14,[310,521,350],{"emptyLinePlaceholder":349},[310,523,525,528,530,534],{"class":312,"line":524},15,[310,526,527],{"class":378},"  disableInvalidFilterQueryException",[310,529,382],{"class":320},[310,531,533],{"class":532},"sfNiH"," false",[310,535,403],{"class":320},[310,537,539,542,544,546],{"class":312,"line":538},16,[310,540,541],{"class":378},"  disableInvalidSortQueryException",[310,543,382],{"class":320},[310,545,533],{"class":532},[310,547,403],{"class":320},[310,549,551,554,556,558],{"class":312,"line":550},17,[310,552,553],{"class":378},"  disableInvalidIncludesQueryException",[310,555,382],{"class":320},[310,557,533],{"class":532},[310,559,403],{"class":320},[310,561,563],{"class":312,"line":562},18,[310,564,350],{"emptyLinePlaceholder":349},[310,566,568,571,573,575],{"class":312,"line":567},19,[310,569,570],{"class":378},"  convertRelationNamesToSnakeCasePlural",[310,572,382],{"class":320},[310,574,533],{"class":532},[310,576,403],{"class":320},[310,578,580,583,585,587],{"class":312,"line":579},20,[310,581,582],{"class":378},"  convertRelationTableNameStrategy",[310,584,382],{"class":320},[310,586,533],{"class":532},[310,588,403],{"class":320},[310,590,592,595,597,599],{"class":312,"line":591},21,[310,593,594],{"class":378},"  convertFieldNamesToSnakeCase",[310,596,382],{"class":320},[310,598,533],{"class":532},[310,600,403],{"class":320},[310,602,604],{"class":312,"line":603},22,[310,605,350],{"emptyLinePlaceholder":349},[310,607,609,612,614,617],{"class":312,"line":608},23,[310,610,611],{"class":378},"  autoValidate",[310,613,382],{"class":320},[310,615,616],{"class":532}," true",[310,618,403],{"class":320},[310,620,622,625,628],{"class":312,"line":621},24,[310,623,624],{"class":320},"}",[310,626,627],{"class":324},")",[310,629,343],{"class":320},[310,631,633],{"class":312,"line":632},25,[310,634,350],{"emptyLinePlaceholder":349},[310,636,638,641,644,647],{"class":312,"line":637},26,[310,639,640],{"class":316},"export",[310,642,643],{"class":316}," default",[310,645,646],{"class":324}," apiQueryConfig",[310,648,343],{"class":320},[296,650,652],{"id":651},"configuration-options","Configuration Options",[654,655,657],"h3",{"id":656},"parameters",[283,658,656],{},[279,660,661,662,294],{},"Customizes the query string parameter names inspected by ",[283,663,664],{},"ApiQueryBuilderRequest",[666,667,668,685],"table",{},[669,670,671],"thead",{},[672,673,674,679,682],"tr",{},[675,676,678],"th",{"align":677},"left","Option",[675,680,681],{"align":677},"Default",[675,683,684],{"align":677},"Example URL",[686,687,688,706,723,740,757],"tbody",{},[672,689,690,696,701],{},[691,692,693],"td",{"align":677},[283,694,695],{},"parameters.include",[691,697,698],{"align":677},[283,699,700],{},"'include'",[691,702,703],{"align":677},[283,704,705],{},"GET \u002Fusers?include=posts,profile",[672,707,708,713,718],{},[691,709,710],{"align":677},[283,711,712],{},"parameters.filter",[691,714,715],{"align":677},[283,716,717],{},"'filter'",[691,719,720],{"align":677},[283,721,722],{},"GET \u002Fusers?filter[name]=john",[672,724,725,730,735],{},[691,726,727],{"align":677},[283,728,729],{},"parameters.sort",[691,731,732],{"align":677},[283,733,734],{},"'sort'",[691,736,737],{"align":677},[283,738,739],{},"GET \u002Fusers?sort=-createdAt",[672,741,742,747,752],{},[691,743,744],{"align":677},[283,745,746],{},"parameters.fields",[691,748,749],{"align":677},[283,750,751],{},"'fields'",[691,753,754],{"align":677},[283,755,756],{},"GET \u002Fusers?fields[users]=id,name",[672,758,759,764,769],{},[691,760,761],{"align":677},[283,762,763],{},"parameters.append",[691,765,766],{"align":677},[283,767,768],{},"'append'",[691,770,771],{"align":677},[283,772,773],{},"GET \u002Fusers?append=fullName",[279,775,776,777,780,781,784,785,294],{},"For example, if you set ",[283,778,779],{},"filter: 'filters'"," and ",[283,782,783],{},"sort: 'order_by'",", the package will read ",[283,786,787],{},"?filters[name]=john&order_by=-createdAt",[654,789,791],{"id":790},"countsuffix",[283,792,793],{},"countSuffix",[795,796,797,808],"ul",{},[798,799,800,804,805],"li",{},[801,802,803],"strong",{},"Type",": ",[283,806,807],{},"string",[798,809,810,804,812],{},[801,811,681],{},[283,813,814],{},"'Count'",[279,816,817,818,820,821,823,824,827,828,831,832,835,836,294],{},"Suffix used when requesting relationship counts via ",[283,819,398],{},". With the default value ",[283,822,814],{},", allowing ",[283,825,826],{},"'posts'"," or ",[283,829,830],{},"'postsCount'"," lets clients request ",[283,833,834],{},"GET \u002Fusers?include=postsCount"," to execute ",[283,837,838],{},"query.withCount('posts')",[654,840,842],{"id":841},"existssuffix",[283,843,844],{},"existsSuffix",[795,846,847,853],{},[798,848,849,804,851],{},[801,850,803],{},[283,852,807],{},[798,854,855,804,857],{},[801,856,681],{},[283,858,859],{},"'Exists'",[279,861,862],{},"Suffix configuration for existence includes.",[654,864,866],{"id":865},"disabling-invalid-query-exceptions","Disabling Invalid Query Exceptions",[279,868,869,870,873,874,877,878,881,882,885,886,873,889,877,892,895],{},"By default, when a client requests a filter, sort, or include that is not listed in ",[283,871,872],{},".allowedFilters()",", ",[283,875,876],{},".allowedSorts()",", or ",[283,879,880],{},".allowedIncludes()",", the package throws an HTTP ",[283,883,884],{},"400 Bad Request"," exception (",[283,887,888],{},"InvalidFilterQuery",[283,890,891],{},"InvalidSortQuery",[283,893,894],{},"InvalidIncludeQuery",").",[279,897,898],{},"You can silence these exceptions so disallowed parameters are simply ignored:",[666,900,901,912],{},[669,902,903],{},[672,904,905,907,909],{},[675,906,678],{"align":677},[675,908,681],{"align":677},[675,910,911],{"align":677},"Description",[686,913,914,935,953],{},[672,915,916,921,926],{},[691,917,918],{"align":677},[283,919,920],{},"disableInvalidFilterQueryException",[691,922,923],{"align":677},[283,924,925],{},"false",[691,927,928,929,932,933,294],{"align":677},"When ",[283,930,931],{},"true",", unknown filters in the URL are ignored instead of throwing ",[283,934,888],{},[672,936,937,942,946],{},[691,938,939],{"align":677},[283,940,941],{},"disableInvalidSortQueryException",[691,943,944],{"align":677},[283,945,925],{},[691,947,928,948,950,951,294],{"align":677},[283,949,931],{},", unknown sorts in the URL are ignored instead of throwing ",[283,952,891],{},[672,954,955,960,964],{},[691,956,957],{"align":677},[283,958,959],{},"disableInvalidIncludesQueryException",[691,961,962],{"align":677},[283,963,925],{},[691,965,928,966,968,969,294],{"align":677},[283,967,931],{},", unknown includes in the URL are ignored instead of throwing ",[283,970,894],{},[654,972,974],{"id":973},"autovalidate",[283,975,976],{},"autoValidate",[795,978,979,986],{},[798,980,981,804,983],{},[801,982,803],{},[283,984,985],{},"boolean",[798,987,988,804,990],{},[801,989,681],{},[283,991,931],{},[279,993,994,995,827,998,1001,1002,1004,1005,1008,1009,1011],{},"Controls whether queries with validation rules defined (via ",[996,997,78],"a",{"href":79},[283,999,1000],{},"AllowedFilter.rule()",") automatically validate the incoming request before executing the database query. Set to ",[283,1003,925],{}," if you prefer to trigger validation manually via ",[283,1006,1007],{},".validate()",". See ",[996,1010,83],{"href":84}," for full details.",[654,1013,1015],{"id":1014},"field-relation-naming-options","Field & Relation Naming Options",[666,1017,1018,1030],{},[669,1019,1020],{},[672,1021,1022,1024,1026,1028],{},[675,1023,678],{"align":677},[675,1025,803],{"align":677},[675,1027,681],{"align":677},[675,1029,911],{"align":677},[686,1031,1032,1054,1076],{},[672,1033,1034,1039,1043,1047],{},[691,1035,1036],{"align":677},[283,1037,1038],{},"convertRelationNamesToSnakeCasePlural",[691,1040,1041],{"align":677},[283,1042,985],{},[691,1044,1045],{"align":677},[283,1046,925],{},[691,1048,1049,1050,1053],{"align":677},"Keep relationship names in ",[283,1051,1052],{},"fields[relation]"," as-is instead of converting to camelCase plural.",[672,1055,1056,1061,1066,1070],{},[691,1057,1058],{"align":677},[283,1059,1060],{},"convertRelationTableNameStrategy",[691,1062,1063],{"align":677},[283,1064,1065],{},"'snake_case' | 'camelCase' | 'none' | false",[691,1067,1068],{"align":677},[283,1069,925],{},[691,1071,1072,1073,294],{"align":677},"Strategy for resolving table names in ",[283,1074,1075],{},"fields[table]",[672,1077,1078,1083,1087,1091],{},[691,1079,1080],{"align":677},[283,1081,1082],{},"convertFieldNamesToSnakeCase",[691,1084,1085],{"align":677},[283,1086,985],{},[691,1088,1089],{"align":677},[283,1090,925],{},[691,1092,1093,1094,1097,1098,1101,1102,895],{"align":677},"Convert requested field names (e.g., ",[283,1095,1096],{},"firstName",") to ",[283,1099,1100],{},"snake_case"," (",[283,1103,1104],{},"first_name",[1106,1107,1108],"style",{},"html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .sfNiH, html code.shiki .sfNiH{--shiki-light:#FF5370;--shiki-default:#FF9CAC;--shiki-dark:#FF9CAC}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":306,"searchDepth":313,"depth":346,"links":1110},[1111,1112],{"id":298,"depth":346,"text":299},{"id":651,"depth":346,"text":652,"children":1113},[1114,1115,1116,1117,1118,1119],{"id":656,"depth":353,"text":656},{"id":790,"depth":353,"text":793},{"id":841,"depth":353,"text":844},{"id":865,"depth":353,"text":866},{"id":973,"depth":353,"text":976},{"id":1014,"depth":353,"text":1015},"Customize query parameter names, suffixes, and exception behavior in config\u002Fapiquery.ts.","md",{},{"icon":55},{"title":52,"description":1120},"Obns1H6lJq-RzmKp5-9KUGkDcQ1RQDAjPDsZ265y2p4",[1127,1129],{"title":47,"path":48,"stem":49,"description":1128,"icon":50,"children":-1},"Install and configure @eienjs\u002Fadonisjs-api-query in your AdonisJS application.",{"title":63,"path":64,"stem":65,"description":1130,"icon":66,"children":-1},"Filter Lucid queries using partial, exact, operator, scope, trashed, and callback filters.",{"id":1132,"extension":1133,"meta":1134,"packages":1135,"stem":1178,"__hash__":1179},"packages\u002Fdata\u002Fpackages.json","json",{},[1136,1143,1149,1155,1160,1166,1172],{"name":1137,"title":1138,"description":1139,"icon":86,"category":1140,"repo":1141,"version":1142,"docs":349},"adonisjs-permission","Permission","Associate users with roles and permissions in your AdonisJS app","adonisjs","https:\u002F\u002Fgithub.com\u002Feienjs\u002Fadonisjs-permission","1.0.0",{"name":1144,"title":1145,"description":1146,"icon":33,"category":1140,"repo":1147,"version":1148,"docs":349},"adonisjs-api-query","API Query","Easily build Lucid queries from API requests","https:\u002F\u002Fgithub.com\u002Feienjs\u002Fadonisjs-api-query","3.0.1",{"name":1150,"title":1151,"description":1152,"icon":249,"category":1140,"repo":1153,"version":1154,"docs":349},"adonisjs-soft-deletes","Soft Deletes","Provider-based Soft deletes for AdonisJS","https:\u002F\u002Fgithub.com\u002Feienjs\u002Fadonisjs-soft-deletes","1.0.2",{"name":1156,"title":195,"description":1157,"icon":196,"category":1140,"repo":1158,"version":1159,"docs":349},"adonisjs-simple-auth","Single API key authentication for AdonisJS v7 applications","https:\u002F\u002Fgithub.com\u002Feienjs\u002Fadonisjs-simple-auth","2.1.0",{"name":1161,"title":1162,"description":1163,"icon":1164,"category":1140,"repo":1165,"docs":22},"adonisjs-sentry","Sentry","Sentry service provider for AdonisJS v7.","i-tabler-bug","https:\u002F\u002Fgithub.com\u002Feienjs\u002Fadonisjs-sentry",{"name":1167,"title":1168,"description":1169,"icon":141,"category":1170,"repo":1171,"docs":22},"eslint-config","ESLint Config","The EienJS ESLint config preset.","tooling","https:\u002F\u002Fgithub.com\u002Feienjs\u002Feslint-config",{"name":1173,"title":1174,"description":1175,"icon":1176,"category":1170,"repo":1177,"docs":22},"adonisjs-pkg-boilerplate","Package Boilerplate","A boilerplate for creating AdonisJS packages.","i-tabler-package","https:\u002F\u002Fgithub.com\u002Feienjs\u002Fadonisjs-pkg-boilerplate","data\u002Fpackages","5fILU7Jigsw2ib-NQg4Fr4sWgIkg0kLgpVm371gTzVY",1793868428880]