Describe the bug

Hello! I could really use some help and guidance!

I have an Open API spec that is valid when I used Spectral

I can successfully run it with Prism

I have unit tests that validate an endpoint, so I am using Prism like so prism proxy --errors example.yaml http://localhost:8080

When I send an invalid request it keeps giving me this error

{
  type: 'https://stoplight.io/prism/errors#UNPROCESSABLE_ENTITY',
  title: 'Invalid request',
  status: 422,
  detail: 'Your request is not valid and no HTTP validation response was found in the spec, so Prism is generating this error for you.',
  validation: [
    {
      location: [Array],
      severity: 'Error',
      code: 'required',
      message: "should have required property 'firstname'"
    },
    {
      location: [Array],
      severity: 'Error',
      code: 'required',
      message: "should have required property 'lastname'"
    },
    {
      location: [Array],
      severity: 'Error',
      code: 'required',
      message: "should have required property 'email'"
    },
    {
      location: [Array],
      severity: 'Error',
      code: 'required',
      message: "should have required property 'password'"
    }
  ]
}

Which is wild because this DOES exist.

It keeps stating Your request is not valid and no HTTP validation response was found in the spec, so Prism is generating this error for you which is not true at all because I have a 422 response declared for the endpoint that’s being hit!

I have tried setting a 400 response. I’ve tried setting different data for the response. And nothing is working.

What am I doing wrong?

To Reproduce

Use this file

---
openapi: '3.0.2'

servers:
    - url: http://localhost:8080
      description: Local deployment from your computer

paths:
    /api/users/register:
        post:
            summary: 'Register New User'
            description: 'Register a new user'
            operationId: 'registerNewUser'
            tags: ['Users']
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: 'object'
                            properties:
                                firstname:
                                    type: 'string'
                                    minLength: 2
                                    maxLength: 100
                                    example: 'John'
                                lastname:
                                    type: 'string'
                                    minLength: 2
                                    maxLength: 100
                                    example: 'Roberts'
                                email:
                                    type: 'string'
                                    minLength: 4
                                    maxLength: 100
                                    example: 'john@example.com'
                                password:
                                    type: 'string'
                                    minLength: 8
                                    maxLength: 50
                                    example: 'abc123456'
                            required:
                                - firstname
                                - lastname
                                - email
                                - password
            responses:
                '201':
                    description: Successful registration of a new user
                '422':
                    description: Failed to register new user
                    content:
                        application/json:
                            schema:
                                type: 'object'
                                properties:
                                    message:
                                        type: 'string'
                                        example: 'firstname is required'

Run prism proxy --errors example.yaml http://localhost:8080

Run this curl command to confirm it works

curl --location --request POST 'localhost:4010/api/users/register' \
--header 'Content-Type: application/json' \
--data-raw '{
	"firstname": "First",
	"lastname": "Last",
	"email": "example@example.com",
	"password": "This_is_4_str0ng_password!"
}'

If you want pretty printing you can add json_pp

curl --location --request POST 'localhost:4010/api/users/register' \
--header 'Content-Type: application/json' \
--data-raw '{
	"firstname": "First",
	"lastname": "Last",
	"email": "example@example.com",
	"password": "This_is_4_str0ng_password!"
}'

Run this command to confirm it fails

curl --location --request POST 'localhost:4010/api/users/register' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Same, but with pretty printing

curl --location --request POST 'localhost:4010/api/users/register' \
--header 'Content-Type: application/json' \
--data-raw '{}' | json_pp

And the final output is this

~/Repositories/example   feature/api_spec_and_test_reconciliation ±  ⬡ v12.17.0  curl --location --request POST 'localhost:4010/api/users/register' \
--header 'Content-Type: application/json' \
--data-raw '{}' | json_pp
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   702  100   700  100     2   113k    333 --:--:-- --:--:-- --:--:--  114k
{
   "detail" : "Your request is not valid and no HTTP validation response was found in the spec, so Prism is generating this error for you.",
   "title" : "Invalid request",
   "type" : "https://stoplight.io/prism/errors#UNPROCESSABLE_ENTITY",
   "status" : 422,
   "validation" : [
      {
         "severity" : "Error",
         "location" : [
            "body"
         ],
         "message" : "should have required property 'firstname'",
         "code" : "required"
      },
      {
         "message" : "should have required property 'lastname'",
         "location" : [
            "body"
         ],
         "severity" : "Error",
         "code" : "required"
      },
      {
         "code" : "required",
         "severity" : "Error",
         "location" : [
            "body"
         ],
         "message" : "should have required property 'email'"
      },
      {
         "message" : "should have required property 'password'",
         "location" : [
            "body"
         ],
         "severity" : "Error",
         "code" : "required"
      }
   ]
}

Expected behavior

I expect the responses I created for 422 to be used so that I don’t have to worry about Prism returning different payloads than what my server does.

Questions

How do I get Prism to not return a generated 422 override?

Because it keeps generating that validation response I can’t integrate it with my tests, because the tests expect a message property to be there.

I’ve read through the documentation here:

• https://meta.stoplight.io/docs/prism/docs/guides/errors.md#unprocessable_entity
• https://meta.stoplight.io/docs/prism/docs/guides/02-request-validation.md#request-validation

And none of it provides an explicit example on how to make it so that Prism does not return an auto-generated response.

Additional context

• Prism: 4.1.2
• OS: MacOS