Skip to content

unrecognized property 'documentation' #23

Description

@gianlucainnocentevegans

Hello,
i have my serverless.ts with this function:

functions: {
		getPatients
 }

and the documentation section of the serverless.ts with this configuration:

documentation: {
      version: '1',
      title: 'Claire API',
      description: 'Claire API',
      securitySchemes: {},
      security: {},
      models: {}
    }

My getPatients function is imported and has this content:

import schema from './schema';
import { handlerPath } from '@libs/handler-resolver';

export default {
  handler: `${handlerPath(__dirname)}/handler.main`,
  events: [
    {
      http: {
        method: 'GET',
        path: 'patients',
        request: {
          schemas: {
            'application/json': schema,
          },
        },
      }
    }
  ],
};

The problem is i got this error: "Some functions have http events which are not documented: getPatients".

If i add this json to the http event:

documentation: {
          summary: "get patients",
          methodResponses: [
            {
              statusCode: 200,
              responseBody: "OK"
            }
          ]
        },

then i got this error: No root type "undefined.GetPatients.Response" found.
And this warning: Invalid configuration encountered
at 'functions.getPatients.events.0.http': unrecognized property 'documentation'

Cacn anyone help me? Thank you

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions