env0 / env0/serverless-openapi-typescript

unrecognized property 'documentation'

Open
#23 1 comment 2 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
14
Forks
7
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.