env0 / env0/serverless-openapi-typescript

Full sample?

Offen
#42 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
TypeScript
Sterne
14
Forks
7
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Beginne damit, den gemeldeten Befehl mit dem aws-nodejs-typescript-Template und dem gezeigten Dokumentationsfehler zu reproduzieren. Verfolge anschließend, wie das Plugin Dokumentationsattribute erkennt, und füge dann ein einfaches Hello-World-Beispiel hinzu, das die erforderliche Konfiguration verdeutlicht und bestätigt, dass die Dokumentationsgenerierung erfolgreich ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
nodejs, typescript
Bereich
api, documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.