goadesign / goadesign/goa

OpenAPI 3.1 Support

Open
#3,758 0 comments 2 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
6.1k
Forks
583
Avg merge
2d 10h
Merged PRs (30d)
15

Description

Hi I think Goa would profit from OpenAPI 3.1 support.

Therefore I create this PR initially implementing it: https://github.com/goadesign/goa/pull/3755

This issue is to discuss it in a more formal way so we can shape and refine it till it is mergeable (if desired ofc).

I tried to do it in a way that:

- Respects Goa's existing patterns and conventions
- Provides a clean, intuitive API for developers
- Properly leverages OpenAPI 3.1's webhook support
- Maintains backward compatibility (webhooks are additive, not breaking)

```
API Service Type ResultType
├── Title ├── Description ├── Extend ├── TypeName
├── Description ├── Docs ├── Reference ├── ContentType
├── Version ├── Security ├── ConvertTo ├── Extend
├── Docs ├── Error ├── CreateFrom ├── Reference
├── License ├── GRPC ├── Attribute ├── ConvertTo
├── TermsOfService ├── HTTP ├── Field ├── CreateFrom
├── Contact ├── Method └── Required ├── Attributes
├── Server │ ├── Payload └── View
└── HTTP │ ├── Result
│ ├── Error
│ ├── GRPC
│ └── HTTP
├── Files
└── Webhook
├── WebhookDescription
├── WebhookPayload
└── WebhookHTTP
├── WebhookMethod/POST/GET/etc.
├── WebhookPath
├── WebhookHeaders
└── WebhookResponse

```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.