env0 / env0/serverless-openapi-typescript

Full sample?

Abierto
#42 0 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
TypeScript
Estrellas
14
Forks
7
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Do you happen to have a sample of a basic "Hello World" type serverless project with this in it? It's unclear where all the docs come from... I just made a project with `--template aws-nodejs-typescript` and added this to it, but can't get docs to generate:

```
[serverless-openapi-typescript] Scanning functions for documentation attribute
Environment: darwin, node 16.17.1, framework 3.30.0 (local), plugin 6.2.3, SDK 4.3.2
Docs: docs.serverless.com
Support: forum.serverless.com
Bugs: github.com/serverless/serverless/issues

Error:
Error: Some functions have http events which are not documented:
hello

Please add a documentation attribute.
If you wish to keep the function undocumented, please explicitly set
documentation: ~
```

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Línea de trabajo

Comienza reproduciendo el comando indicado con la plantilla aws-nodejs-typescript y el error de documentación mostrado. Traza cómo el plugin descubre los atributos de documentación y, después, añade un ejemplo básico de Hello World que deje clara la configuración necesaria y confirme que la generación de documentación se realiza correctamente.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
nodejs, typescript
Área
api, documentation
Tipo de issue
Documentación
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.