https://github.com/eclipse-vertx/vertx-openapi

OpenAPI repository
https://github.com/eclipse-vertx/vertx-openapi

Last synced: 3 months ago
JSON representation

OpenAPI repository

• Host: GitHub
• URL: https://github.com/eclipse-vertx/vertx-openapi
• Owner: eclipse-vertx
• License: other
• Created: 2022-11-08T15:27:46.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2025-01-29T11:37:57.000Z (12 months ago)
• Last Synced: 2025-01-29T12:31:03.431Z (12 months ago)
• Language: Java
• Size: 576 KB
• Stars: 11
• Watchers: 9
• Forks: 10
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Vert.x OpenAPI

[![Build Status (5.x)](https://github.com/eclipse-vertx/vertx-openapi/actions/workflows/ci-5.x.yml/badge.svg)](https://github.com/eclipse-vertx/vertx-openapi/actions/workflows/ci-5.x.yml)

[![Build Status (4.x)](https://github.com/eclipse-vertx/vertx-openapi/actions/workflows/ci-4.x.yml/badge.svg)](https://github.com/eclipse-vertx/vertx-openapi/actions/workflows/ci-4.x.yml)

Please see the in-source asciidoc documentation or the main documentation on the web-site for a full description

of this component:

* [web-site docs](https://vertx.io/docs/vertx-openapi/java/)

* [in-source docs](src/main/asciidoc/index.adoc)

## Spotless Formatter

Spotless will be executed on the `check` goal during the `validation` phase. If you want to apply the formatter rules automatically run `mvn spotless::apply`

## TODOs

### LabelTransformer

How to handle type `number` when style `Label` and exploded is `true`? Because all values are seperated by a '.' (dot), and this char is also used as floating point.

### FormTransformer

How does Cookie Parameter Parser behave when explode is true? see https://swagger.io/docs/specification/serialization/

### Missing Transformer

Due to wrong or insufficient documentation the following transformers are postponed:

- PipeDelimitedTransformer

- SpaceDelimitedTransformer

- DeepObjectTransformer