Merge pull request #45 from appersonlabs/master

Add support for custom params on the OPERATION OBJECT
z0mt3c · Aug 29, 2015 · 1bdda1f · 1bdda1f
2 parents 0aa08c5 + 87647da
commit 1bdda1f
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 1 deletion.
diff --git a/lib/resources.js b/lib/resources.js
@@ -196,6 +196,10 @@ module.exports = function (settings, routes, tags) {
         operation.deprecated = true
       }
 
+      if (routesPluginOptions.custom) {
+        operation = _.merge(operation, routesPluginOptions.custom)
+      }
+
       utils.setNotEmpty(operation, 'tags', internals.prepareTags(path, routeSettings.tags, settings))
       utils.setNotEmpty(operation, 'parameters', parameters)
       utils.setNotEmpty(operation, 'summary', routeSettings.description)

diff --git a/lib/schema.js b/lib/schema.js
@@ -132,7 +132,7 @@ schemas.Operation = Joi.object({
   schemes: arrayOfStrings.optional(),
   deprecated: Joi.boolean().optional(),
   security: Joi.any()
-}).meta({
+}).pattern(/^x-[A-Za-z]*-?[A-Za-z]*/, Joi.string().optional()).meta({
   className: 'Operation'
 })
 
@@ -306,5 +306,6 @@ schemas.RoutesPluginOptions = Joi.object({
     description: Joi.string().required(),
     schema: Joi.object().optional()
   })),
+  custom: Joi.object().pattern(/^x-[A-Za-z]*-?[A-Za-z]*/, Joi.string().required()),
   operationId: Joi.string().optional()
 }).optional()
diff --git a/test/resources-test.js b/test/resources-test.js
@@ -141,6 +141,30 @@ describe('resources', function () {
     })
   })
 
+  describe('custom params', function () {
+    it('allows params that start with x-', function (done) {
+      var resources = internals.resources(Hoek.applyToDefaults(baseRoute, {
+        path: '/foo',
+        config: {
+          plugins: {
+            'hapi-swaggered': {
+              custom: {
+                'x-test-foo': 'test value'
+              }
+            }
+          }
+        }
+      }))
+
+      expect(resources).to.exist()
+      expect(resources.paths['/foo'].get).to.include({
+        'x-test-foo': 'test value'
+      })
+
+      done()
+    })
+  })
+
   describe('responses', function () {
     // TODO: description, test with primary types + arrays
     it('only response model', function (done) {