diff --git a/README.md b/README.md index a08a645fc..cf674018d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ogen svg logo

-# ogen [![Go Reference](https://img.shields.io/badge/go-pkg-00ADD8)](https://pkg.go.dev/github.com/ogen-go/ogen#section-documentation) [![codecov](https://img.shields.io/codecov/c/github/ogen-go/ogen?label=cover)](https://codecov.io/gh/ogen-go/ogen) [![beta](https://img.shields.io/badge/-beta-yellow)](https://go-faster.org/docs/projects/status#beta) +# ogen [![Go Reference](https://img.shields.io/badge/go-pkg-00ADD8)](https://pkg.go.dev/github.com/ogen-go/ogen#section-documentation) [![codecov](https://img.shields.io/codecov/c/github/ogen-go/ogen?label=cover)](https://codecov.io/gh/ogen-go/ogen) [![stable](https://img.shields.io/badge/-stable-brightgreen)](https://go-faster.org/docs/projects/status#stable) OpenAPI v3 Code Generator for Go. @@ -10,9 +10,6 @@ OpenAPI v3 Code Generator for Go. - [Sample project](https://github.com/ogen-go/example) - [Security policy](https://github.com/ogen-go/ogen/blob/-/SECURITY.md) - [Telegram group `@ogen_dev`](https://t.me/ogen_dev) -- [Roadmap](https://github.com/ogen-go/ogen/blob/-/ROADMAP.md) - -API should be pretty stable, but some rare changes can occur until v1.0.0. # Install diff --git a/ROADMAP.md b/ROADMAP.md deleted file mode 100644 index 4007ca143..000000000 --- a/ROADMAP.md +++ /dev/null @@ -1,68 +0,0 @@ -### OpenAPI - -- [ ] Encoding - - [ ] XML (#169) - - [ ] MessagePack (?) - - [ ] Custom (?) - - [ ] Other (?) -- [ ] Parameters - - [ ] Complex types - - [ ] Any type (?) - - [ ] Sum types - - [ ] Complex object schemas (e.g `additionalProperties`) - - [ ] Cookie parameters -- [ ] Request body - - [ ] `Content-Type` masks - - [ ] Forms - - [ ] Complex form schemas (e.g `additionalProperties`) - - [ ] Multipart - - [ ] Part headers - - [ ] `Content-Type` part header (special encoding field) -- [ ] Security - - [ ] OAuth2 - - [ ] OpenID Connect - - [ ] HTTP Digest - - [ ] Other (?) -- [x] Webhooks -- [ ] Callbacks - - [ ] Links (?) -- [ ] Documentation - - [ ] Handle Common Mark in description (#142) - -### JSON Schema - -- [ ] Complex `anyOf` -- [ ] Default values for `object` -- [ ] ECMA-262 Regex (#419) -- [ ] Enum - - [ ] `enum` with `format` - - [ ] Object `enum` -- [ ] Tuples -- [ ] Validation - - [ ] Validate Any type - - [ ] `uniqueItems` - - [ ] `not` (?) -- [ ] `format` - - [ ] Make validators compliant with spec - - [ ] Support more formats (?) -- [ ] [Code generation for regex (?)](https://github.com/CAFxX/regexp2go) -- [ ] Support more drafts (?) - -### General code generator features - -- [ ] User-friendly error reporting - - [x] Print location - - [ ] Report multiple errors -- [ ] Optimization - - [ ] Streaming (?) -- [ ] Use generics -- [ ] Websocket extension (?) -- [ ] [`asyncapi` support (?)](https://github.com/asyncapi/spec/blob/v2.2.0/spec/asyncapi.md) -- [ ] Client retries (?) - -### OAS Tooling - -- [ ] Lint specification (?) - - [ ] Lint HTTP compliance of definitions - - [ ] Handle possible bugs in specification -- [ ] Backward compatibility check