Requesting Generation of the OpenApi (Swagger) specification from Lambda Annotations

Open
#1,957 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
28/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
aws, csharp, openapi

Research direction

Start by reviewing Amazon.Lambda.Annotations and its generated API Gateway integration, then identify how function inputs and outputs are currently represented. Define the required OpenAPI/Swagger output and generated models, including how the specification would be exposed. Done means the feature produces a usable specification for annotated Lambda functions, with models derived from their inputs and outputs.

Written by the indexing model from the issue text.

Description

annotations feature-request p2 queued
Describe the feature

Lambda Annotations should cause the ApiGateway to have a swagger specification complete with generated models based on the inputs / outputs of the functions.

Use Case

My team depends heavily on OpenApi specifications. It would be extremely valuable for the generated functions to produce the specs.

Proposed Solution

No response

Other Information

No response

Acknowledgements
  • I may be able to implement this feature request
  • This feature might incur a breaking change
AWS .NET SDK and/or Package version used

Amazon.Lambda.Annotations

Targeted .NET Platform

.Net 8

Operating System and version

Lambda

Dominant language
C#
Stars
1.7k
Forks
503
Avg merge
1d 18h
Merged PRs (30d)
21

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aws/aws-lambda-dotnet

All issues in aws/aws-lambda-dotnet

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.