openapi
Here are 1,262 public repositories matching this topic...
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:
Is your feature request related to a problem
Coming from this issue: tiangolo/fastapi#817
The docs have some sections with functions using *,
in the parameters.
It is explained here: https://fastapi.tiangolo.com/tutorial/path-params-numeric-validations/#order-the-parameters-as-you-need-tricks
But in other sections like: https://fastapi.tiangolo.com/tutor
Just a FYI when people start trying to submit bugs about this, mobx-react shipped a funky build which is causing broken-ness (at least when using redoc-cli bundle)
Currently breaks with an error like:
Cannot find module '..../.npm/_npx/1868/lib/node_modules/redoc-cli/node_modules/mobx-react/dist/mobxreact.js
(added for searchability)
Can
Flaky Timeout test
As illustrated by https://app.circleci.com/pipelines/github/grpc-ecosystem/grpc-gateway/281/workflows/57fdb518-e3ee-4f16-9a55-0f417732ca80/jobs/7654/steps, one of the integration tests is sometimes failing with the wrong error. We should figure out why this is happening and fix it.
This should be a good issue to get introduced to the codebase. The test is here: https://github.com/grpc-ecosystem
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"
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue? not relevant
- Have you validated the input using an OpenAPI validator (example)? not relevant
- What's the version of OpenAPI Generator used?
- Have you search for related issues/PRs?
- What's the actual output vs expected output?
Version: 2.9.2
What kind of issue is this?
- Question.
How do I disable pageable sort param from showing in docs?
I am using Cassandra database, where sorting doesn't apply like with relational databases, so I want to use page and size only with pageable param. How do I do this?
, done.
remote: Compressin
Description
The issue #1210 made me think it would be great to document request context management when using aiohttp server. At least inform that the given example in the doc does not work for aiohttp server.
I'm trying to find the docs with the config options for java. I can't find anything on the docs here on github, but if I run $ autorest --help
I see this:
But If i run $ autorest --help --java
there are no java specific config options that exist when running with c#
instead.
autorest 3 beta?
This is a follow-up issue for #5000 where we moved datasource config from JSON files to TS files and discovered few aspects of the datasource template that can be improved.
- Update https://github.com/strongloop/loopback4-example-shopping and https://github.com/strongloop/loopback-next/blob/master/docs/site/Inside-Loopback-Application.md to follow the new style
- Make the static DataSo
-
Updated
Jun 4, 2020 - Java
Describe the bug
The data type formats link in the README does not point at anything.
To Reproduce
Steps to reproduce the behavior:
- Go to https://github.com/swaggo/swag/blob/ab69c2399a4b62ecf9fe39ebe2cab91e91a437e9/README.md#available
- Click on Data Type Formats
- It goes nowhere
Expected behavior
To show me the documentation for Data Type formats.
**Desktop (pleas
In #434, it was reported that there were inline scripts that caused the docs to break when a CSP policy blocked those inline scripts. This was fixed in DRS 2.0.
In #637, another inline script was introduced, causing this to break again.
As of first congrats for this package - I'm using it quite often & it's a great help.
I'd like to ask a feature request - add support for MSSQL DB.
The main official mode of connection recommended by MS is ODBC/PDO.
[https://docs.microsoft.com/en-us/sql/connect/odbc/linux-mac/installing-the-microsoft-odbc-driver-for-sql-server?view=sql-server-2017#microsoft-odbc-driver-17-for-sql-server](ht
add auth to docs
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)
.
*Describe the solution you'd like
The official API docs are here
https://developers.google.com/maps/documentation/geocoding/start
I wanted to know if it would be possible to add this API's Swagger doc (and that of similar Google APIs like this).
-
Updated
May 27, 2020 - Python
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
User story.
As a developer, I can change a referenced example file, so that I can see the changes after a request to prism
.
Is your feature request related to a problem?
Prism only watches the spec file for changes and even if it changes, it doesn't reload referenced examples. This is useful because spec files can get extremely big so $ref
usage is a must to keep it manageable.
Verbose logging
$ curl 'http://127.0.0.1:5000/auth/oauth2/token?grant_type=client_credentials' --user 'documentation:KQ()SWK)SQK)QWSKQW(SKQ)S(QWSQW(SJ*HQ&HQW*SQ*^SSQWSGQSG'
{"access_token": "lYoijoYaTgXZi1bLQTs4PuItKsNHNY", "token_type": "Bearer", "expires_in": 3600, "scope": "users:write teams:write auth:write users:read auth:read teams:read"}
Grab the above access_token and access protected resour
Since MySQL is removed from the opensource version in version 3.0, and all users are stored in MySQL as the default storage, I guess we will have to migrate that to SQLite that is the new default storage for config and DF users. But there are no documentation at all about upgrading from 2.x -> 3.x, nor any release notes in the Wiki for 3.x.
Are there more breaking changes or things to consider
Looks like it should be "Not all child routes satisfy compojure.api.routes/Routing."
Maybe a fix could use (str ::Routing)
or some derivative
-Victor
Description
OpenApi/Swagger specs: https://swagger.io/docs/specification/adding-examples/
I've prepared' very simple specs, based on much more complex structure from my current project:
openapi: 3.0.0
info:
version: development
title: Hello World
paths:
/hello_world/:
get:
operationId: api.views.hello_world
responses:
200:
des
Feature Request
Hi Fusio is a great project! Many thanks for that!
I'm looking for a feature to export a existing API to a fusio.yml file, so you can deploy it easyly form your dev server to an production server.
Most thinks like Actions and Routes can be change on the UI. For beginners it is also easy to build a complete API only with the the UI.
As I have seen you can export the A
Improve this page
Add a description, image, and links to the openapi topic page so that developers can more easily learn about it.
Add this topic to your repo
To associate your repository with the openapi topic, visit your repo's landing page and select "manage topics."
Q&A (please complete the following information)