Q&A (please complete the following information)

• Method of installation: [npm, dist assets]
• Swagger-UI version: [>=3.25.1]
• Swagger/OpenAPI versi

In the OpenAPI spec, section "Link Object",
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#linkObject

the "Examples" table following after the text
"The table below provides examples of runtime expressions and examples of their use in a value:"

contains a confusing "note" in the third row, and I think a "note" is missing in the second row.

Proposed changes:

Description

Need support for Ssource code annotation to specify a different endpoint or URL in swagger documentation (swagger.json) from actual specified in code via @path?

First of all, the following repository has all the code (and description as well) to reproduce this problem: https://github.com/elgleidson/swagger-problem

I have the following JSON:

{
  "nonNullableField": "not null",
  "nullableField": null,
  "nonNullableObjectField": {
    "someField": "some value"
  },
  "nullableObjectField": null,
  "nonNullableList": [
    "not null"

There is absolutely no documentation (other than "this is how you drop an existing file". What is the point of releasing such a product if you do not document it?

Is there any documentation regarding CORS preflight requests? Seems like these should automatically be configured based on the swagger definition.

I'm looking to return the verbs defined in swagger for my resources (paths) but I can't even find how to control "preFlightContinue" option.

Thanks in advance.

Copied from #103

I've resolved the issue of authentication using the next code:
swagger_template = { ..., 'securityDefinitions': { 'basicAuth': { 'type': 'basic' } }, ... }
app = Flask(__name__)
Swagger(app, config=config[config_name].swagger_config, template=swagger_template)

![image](https://use

It would be nice to have a note or two on which OAS versions this project supports.
Similar to https://github.com/swagger-api/swagger-ui/#compatibility

cc @webron

I'm new to rest_framework but I'm using drf in combination with redoc and this library and it seems to work fantastic.

I was wondering how can I generate custom sections of the documentation for objects that are commonly reused across all API calls. For example, I have a token object that is query/post parameter so I would like this to be explained topic in its own section.

With the help of

In many warning/error messages, we stringify and print the faulty schema. This is a problem when we deal with circular schemas. Perhaps we can write a custom function or use a library.

When I run the sample from https://github.com/marshmallow-code/apispec/blob/dev/docs/quickstart.rst

the expected output

# {'components': {'parameters': {},
#                 'responses': {},
#                 'schemas': {'Gist': {'properties': {'id': {'format': 'int64',
#                                                            'type': 'integer'},
#                                

Chore summary
Provide some guidance to the custom function writer with regards to errors

Tasks

• Add a section to functions.md

From https://github.com/stoplightio/spectral/pull/1058/files#r408418822

@P0lip What's the effect from throwing from within a function? Does the whole process crash down? Do we get a special kind of result or a console log?

We'd get a console.l

One of the most frustrating aspects of Swagger 2 annotations is the removal of the class-level @Api annotation, which was logical, clear and easy to understand.

Can you please update the Petstore example to clearly show how to group related REST operations together. I looked at the Resource classes and there are no annotations at the class level whatsoever.

• Guidance on adding a linter new rule-action (if none of the existing ones can perform the action, or be extended)
• Expand on guidelines re: keeping commits to logical areas of the code / individual packages where possible
• Use of conventional-commit standard going forward
• Advice not to include any package-lock.json changes PRs, for security reasons. File will be regene

"false".equalsIgnoreCase(defaultValue) should be "false".equalsIgnoreCase(example)

...
            } else if (BooleanProperty.TYPE.equals(type)) {
                if ("true".equalsIgnoreCase(example) || "false".equalsIgnoreCase(defaultValue)) {
                    return Boolean.valueOf(example);
                }
            }
...

In our project we have need to pass Request object to our controller. This is the routes file
POST /check controllers.CheckConotroller.checkStatus(request: Request)
Swagger is generating this output for the parameters object:
`
"parameters": [
{
"name": "request",
"in": "query",

Only HTTP API docs solves part of the problem for most users. What about rending code examples in different languages.

I'm currently using ReDoc which provides such feature taking code examples from OpenAPI x-examples fields.

Are you guys planning to support a similar feature? It would be great for the Developer Experience.

Current swagger-ui does not show the validator-badge.

I thought it is relevant to mention this issue in this repo as well, since the docker-container you provide comes with a swagger-ui which has the same issue and won't show the validator-badge.

See: swagger-api/swagger-ui#5669

We are using this library to power a GitHub Action that generates a backward compatibility report between two versions of an OpenAPI spec. We love this library, but it is not clear what changes are detectable by this library, and what changes this library classifies as "breaking" or "non-breaking" changes. It would be really valuable to us if this repo could include a markdown file outlining all t

Steps to reproduce:

1. Download http://petstore.swagger.io/v2/swagger.json
2. Open swagger.json in Swagger Parser
3. Find the POST /pet endpoint and click "send to repeater"

POST /v2/pet HTTP/1.1
Host: petstore.swagger.io
Accept: application/xml, application/json
Content-Type: application/json, application/xml

id={integer}&id={integer}&name={string}&name={string}&photoUrls={array}

Affecting model markdown docs like: https://github.com/square/connect-csharp-sdk/blob/master/docs/V1EmployeesApi.md#createemployee

This is likely an issue with a repeated print from the template, or possibly printing two different variables from the template that we have assigned to b