zero-rails_openapi
zero-rails_openapi copied to clipboard
zhandao
Concise DSL for generating OpenAPI Specification 3 (OAS3) JSON documentation for Ruby application.
Hi, Maybe a stupid newbie question: I defined an action like this: ``` api :show, 'return a single instance' do param :path, :id, Integer, :req, range: { gt: 0}, desc:...
Attempting to provide more specifications on the parameter object itself, such as `style` or `explode` seems impossible right now, as any options provided are nested under the `schema` object itself....
Examples should have different location and format according to OAS 3.0.
I have a Rails 6 application and the initializer for open api. Here's the content: ``` # frozen_string_literal: true require 'open_api' OpenApi::Config.class_eval do # Part 1: configs of this gem...
In the API spec it has information on the `discriminator` property to specify a hierarchy - https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/ ``` allOf OpenAPI lets you combine and extend model definitions using the allOf...
Currently I do not see a way to denote that an endpoint requires multiple security schemas via AND. Is there support for this? ```ruby # defined in our ApplicationController components...
One issue we encountered was when two routes are pointing to the same Controller method. E.g. ``` GET /api/posts GET /api/users/{user-id}/posts ``` Which point to controller ``` class API::PostsController def...
I'm trying to use Scooma to validate the API but it requires OpenAPI 3.1.0. I'm not sure if there are any breaking changes that affect the generator - https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0 Either...
This allows any Rails application that requires this gem to exclude any Rails gems they don't use.
