hapi-swagger / hapi-swagger

A Swagger interface for hapi
https://hapi.dev/
MIT License
913 stars 420 forks source link

"auth" must be a boolean #232

Closed bartonhammond closed 8 years ago

bartonhammond commented 8 years ago

I have Basic Auth installed and working on other endpoints

Options for UI: auth: (false || string || object) The authentication configuration for plug-in routes. - default: false

For Swagger declaration:

  const swaggerOptions = {
    info: {
      'title': 'Snowflake - API Documentation',
      'version': Pack.version
    },
    'auth': 'simple'
  };

Runtime error:

[1] "auth" must be a boolean
    at Object.internals.Err.toString.exports.process (/Users/barton/projects/stargazers/openshift-stargazers/node_modules/hapi-swagger/node_modules/joi/lib/errors.js:141:19)
    at internals.Any.applyFunctionToChildren.internals.Any._validateWithOptions (/Users/barton/projects/stargazers/openshift-stargazers/node_modules/hapi-swagger/node_modules/joi/lib/any.js:649:27)
    at root.validate (/Users/barton/projects/stargazers/openshift-stargazers/node_modules/hapi-swagger/node_modules/joi/lib/index.js:102:23)
    at root.attempt (/Users/barton/projects/stargazers/openshift-stargazers/node_modules/hapi-swagger/node_modules/joi/lib/index.js:131:29)
    at root.assert (/Users/barton/projects/stargazers/openshift-stargazers/node_modules/hapi-swagger/node_modules/joi/lib/index.js:126:14)
    at plugin.route.config.handler (/Users/barton/projects/stargazers/openshift-stargazers/node_modules/hapi-swagger/lib/index.js:76:21)
    at Object.exports.execute.internals.prerequisites.internals.handler.callback [as handler] (/Users/barton/projects/stargazers/openshift-stargazers/node_modules/hapi/lib/handler.js:96:36)
    at /Users/barton/projects/stargazers/openshift-stargazers/node_modules/hapi/lib/handler.js:30:23
    at internals.Protect.run.finish [as run] (/Users/barton/projects/stargazers/openshift-stargazers/node_modules/hapi/lib/protect.js:64:5)
    at exports.execute.finalize (/Users/barton/projects/stargazers/openshift-stargazers/node_modules/hapi/lib/handler.js:24:22)
glennjones commented 8 years ago

Hi before I looking into this in detail, can I ask you make sure you are using the latest verision 4.2.0. A quick check of the code in the current version should allow alt types. If you are running 4.2.0 then I will try and replicate your problem.

bartonhammond commented 8 years ago

No - I'm on 3.0.1 - wow...

I'll update and report back

bartonhammond commented 8 years ago

works like a charm - thanks!

glennjones commented 8 years ago

Great to hear, I only updated auth property support with the release of v4.2.0 today, so it's good to know it's working.

bartonhammond commented 8 years ago

Hehe!