oas3-api-snippet-enricher

oas3-api-snippet-enricher copied to clipboard

Code samples should only be added onto operations. This fixes issues #13 and #17

ylavoie

Code samples do not generate parameters for multipart/form-data

1

When doing this ``` requestBody: content: multipart/form-data: ``` Instead of this ``` requestBody: content: application/json: ``` Specified fields from the schema are not generated in the code samples E.g. all...

ebrake

👋 Hello! Trying this out for the first time. I rearranged the [expanded petstore example](https://github.com/OAI/OpenAPI-Specification/blob/main/examples/v3.0/petstore-expanded.yaml) to have... ```yaml paths: /pets: $ref: paths/pets.yaml ``` Here is the directory for the rearranged...

timganter

How to handle {}

1

In the OpenAPI spec we use ``` '/lists/v2/audiences/{audienceId}': GET: .... ``` This results in the examples ``` curl --request GET \ --url https://example.com/lists/v2/audiences/%7BaudienceId%7D \ --header 'X-ApiKey: REPLACE_KEY_VALUE' ``` The {}...

thim81

URL should match format "uri"

3

Hi, I try to enrich a JSON generated file that is in a valid openapi JSON format and properly renders in Redoc. But still I get this error: ``` [Error...

thim81

Fix #12 Also add error handling so partial transformation can still happen as openapi-snippet doesn't support some minor things (like oneOf/allOf in parameter schemas)

rohit-gohri

Skip custom properties

1

I am using [openapi-filter](https://github.com/Mermade/openapi-filter) to filter some paths, due to which methods have invalid boolean properties and this error is thrown: ``` TypeError: Cannot create property 'x-codeSamples' on boolean 'true'...

rohit-gohri

Add Ruby support

1

Adding ruby to the targets array generates Ruby code snippets. Tested it on Mac and Ubuntu. Code: ```js 'use strict'; const fs = require('fs'); const OpenAPISnippet = require('openapi-snippet'); const yaml...

bparanj

## Issue Description The `snippet-enricher-cli` library currently depends on the `openapi-snippet` library version `^0.9.0`. However, the latest version of openapi-snippet is `0.14.0` (at the time of writing this issue), which...

afif-fahim