Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

validation error even if format declared in unknownFormats

See original GitHub issue

Describe the bug Title says it. Trying to verify schema with custom format. Error is thrown even if the format name is included in unknownFormats array.

To Reproduce run with supplied .yaml

Actual behavior See error output

Expected behavior No errors, rest of schema is valid

Examples and context

YAML:

servers:
  - url: http://localhost:3010/api
    description: Sandbox
openapi: "3.0.0"
info:
  title: Example API
  description: example
  version: v1
  contact:
    email: examle@example.com
tags:
  - name: Account Service
paths:
  /get-should-have-no-body:
    uuid: accounts
    get:
      tags:
        - Account Service
      summary: get without a schema
      responses:
        "200":
          description: OK

ERROR:


error: openapi.validator: Validating schema
error: openapi.validator: validation errors [
  {
    "keyword": "additionalProperties",
    "dataPath": ".paths['/get-should-have-no-body']",
    "schemaPath": "#/additionalProperties",
    "params": {
      "additionalProperty": "uuid"
    },
    "message": "should NOT have additional properties"
  }
]
error: openapi.validator: Validating schema
error: openapi.validator: validation errors [
  {
    "keyword": "additionalProperties",
    "dataPath": ".paths['/get-should-have-no-body']",
    "schemaPath": "#/additionalProperties",
    "params": {
      "additionalProperty": "uuid"
    },
    "message": "should NOT have additional properties"
  }
]
error: (node:11795) UnhandledPromiseRejectionWarning: Error: openapi.validator: args.apiDoc was invalid.  See the output.
    at OpenAPIFramework.initialize (removedPath/node_modules/express-openapi-validator/dist/framework/index.js:31:23)
    at processTicksAndRejections (internal/process/task_queues.js:97:5)
    at async OpenApiSpecLoader.discoverRoutes (removedPath/node_modules/express-openapi-validator/dist/framework/openapi.spec.loader.js:46:39)
error: (node:11795) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
error: (node:11795) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

        new OpenApiValidator({
          apiSpec: apiGatewayConfigurator._configPath,
          validateResponses: false, // <-- to validate responses
          unknownFormats: ["uuid"], // <-- to provide custom formats
        }).install(app);

Issue Analytics

State:
Created 3 years ago
Comments:7 (3 by maintainers)

Top GitHub Comments

1reaction

hpl002commented, May 7, 2020

Great! 🥇 👏

Appreciate the swift support!

0reactions

cdimasciocommented, May 7, 2020

fixed the issue with vendor extension declared in path. see v3.12.9

Top Results From Across the Web

ajv-cli can't see regex format in ajv-formats · Issue #188 - GitHub

I get lots of unknown formats, as expected (I guess). ... process.exit(0); } else { console.log(validator.errors); process.exit(1); } ...

Strict mode - Ajv JSON schema validator

Unknown formats. By default unknown formats throw exception during schema compilation (and fail validation in case format keyword value is $data reference). It ......

ValidationError when submitting a form with custom date format

You need to set formats on DateInput widget when you declare your variable on the form, plus input_formats, like: data_quota = forms.

Ajv: Another JSON Schema Validator - npm

Validates schema. This method should be used to validate schemas rather than validate due to the inconsistency of uri format in JSON-Schema ...

Resolve template validation or template format errors in ... - AWS

I receive an error message when I try to create my AWS ... Confirm that resource logical IDs and parameters are defined in...