env0 / env0/serverless-openapi-typescript

Full sample?

Ouverte
#42 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
TypeScript
Étoiles
14
Forks
7
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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: ~
```

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Commencez par reproduire la commande signalée avec le modèle aws-nodejs-typescript et l’erreur de documentation affichée. Suivez ensuite la manière dont le plugin découvre les attributs de documentation, puis ajoutez un exemple basique de Hello World qui rende claire la configuration requise et confirme que la génération de la documentation aboutit.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
nodejs, typescript
Domaine
api, documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.