Alias schema.query to schema.querystring (#1690)

docs/Fluent-Schema.md

@@ -43,7 +43,7 @@ const headersJsonSchema = S.object()
 
 const schema = {
   body: bodyJsonSchema.valueOf(),
-  querystring: queryStringJsonSchema.valueOf(),
+  querystring: queryStringJsonSchema.valueOf(), // (or) query: queryStringJsonSchema.valueOf()
   params: paramsJsonSchema.valueOf(),
   headers: headersJsonSchema.valueOf()
 }

docs/Validation-and-Serialization.md

@@ -14,7 +14,7 @@ Fastify uses a schema-based approach, and even if it is not mandatory we recomme
 ### Validation
 The route validation internally relies upon [Ajv](https://www.npmjs.com/package/ajv), which is a high-performance JSON schema validator. Validating the input is very easy: just add the fields that you need inside the route schema, and you are done! The supported validations are:
 - `body`: validates the body of the request if it is a POST or a PUT.
-- `querystring`: validates the query string. This can be a complete JSON Schema object (with a `type` property of `'object'` and a `'properties'` object containing parameters) or a simpler variation in which the `type` and `properties` attributes are forgone and the query parameters are listed at the top level (see the example below).
+- `querystring` or `query`: validates the query string. This can be a complete JSON Schema object (with a `type` property of `'object'` and a `'properties'` object containing parameters) or a simpler variation in which the `type` and `properties` attributes are forgone and the query parameters are listed at the top level (see the example below).
 - `params`: validates the route params.
 - `headers`: validates the request headers.
 

lib/schemas.js

@@ -38,6 +38,11 @@ Schemas.prototype.resolve = function (id) {
 }
 
 Schemas.prototype.resolveRefs = function (routeSchemas, dontClearId) {
+  // alias query to querystring schema
+  if (routeSchemas.query) {
+    routeSchemas.querystring = routeSchemas.query
+  }
+
   // let's check if our schemas have a custom prototype
   for (const key of ['headers', 'querystring', 'params', 'body']) {
     if (typeof routeSchemas[key] === 'object' && Object.getPrototypeOf(routeSchemas[key]) !== Object.prototype) {

test/internals/validation.test.js

@@ -74,6 +74,37 @@ test('build schema - payload schema', t => {
   t.is(typeof opts[symbols.bodySchema], 'function')
 })
 
+test('build schema - query schema', t => {
+  t.plan(2)
+  const opts = {
+    schema: {
+      query: {
+        type: 'object',
+        properties: {
+          hello: { type: 'string' }
+        }
+      }
+    }
+  }
+  validation.build(opts, schema => ajv.compile(schema), new Schemas())
+  t.type(opts[symbols.querystringSchema].schema.type, 'string')
+  t.is(typeof opts[symbols.querystringSchema], 'function')
+})
+
+test('build schema - query schema abbreviated', t => {
+  t.plan(2)
+  const opts = {
+    schema: {
+      query: {
+        hello: { type: 'string' }
+      }
+    }
+  }
+  validation.build(opts, schema => ajv.compile(schema), new Schemas())
+  t.type(opts[symbols.querystringSchema].schema.type, 'string')
+  t.is(typeof opts[symbols.querystringSchema], 'function')
+})
+
 test('build schema - querystring schema', t => {
   t.plan(2)
   const opts = {