[BUG] Cannot Include Json Schema in serverless.yml about nx-plugins

[tstackhouse]

Checked my config, this is actually the way to make offline and apigw work simultaneously with a schema in serverless.yml:

    events:
      - http:
          path: my/endpoint
          method: post
          request:
            schema:
              application/json: ${
                file(src/my-endpoint/post.request.schema.json),
                file(apps/my-app/src/my-endpoint/post.request.schema.json)}

using 2 file() declarations inside the ${} substitution separated by a comma provides failover should one file fail to be found.

I've actually taken to doing both validations you mention though, doing a basic validation at the APIGW level and then doing more complex schema validations deeper in my code, just before my business logic at the API layer. Partly due to the fact that the implementation of schemas on APIGW leave something to be desired in comparison with e.g. AJV. things like oneOf rules don't work as expected and lots of little gotchas in complex schemas that I don't recall off the top of my head.

[brian-weasner]

Note: Not the same as dherault/serverless-offline#894, as I am expecting serverless to find the schema, and at least use it when deployed.

[tstackhouse]

I've ran into this, I don't have the code in front of me, but the workaround is to do something like this in your serverless.yml

functions:
  location:
    handler: src/controllers/location.saveLocation
    events:
      - http:
          path: location
          method: post
          request:
            schemas:
              application/json:
                - ${file(src/schemas/location.json)}
                - ${file(apps/my-app/src/schemas/location.json)}

The syntax might be different, I'd have to look at my config at $WORK, but that's the gist, you need to define the path twice, once for offline and once for APIGW, because of path resolution differrences. You might also need to make sure that the packaging step is including your schema in the generated zip file.

[brian-weasner]

I decided against this approach as I couldn't get it to work, and we want validation working locally with serverless-offline, so we decided to do request body validation in our lambda functions.

Thank you for the pointers though in case anyone else runs across this. Gonna keep this issue open, as it is an issue, just no longer an issue for me as I am not using this functionality.

[wickstargazer]

can we close this?

[brian-weasner]

Yeah, I think so. there is a workaround in place and honestly I decided to just use the latest version of AJS within my code so I could handle the response body to send back to the calling client.