Skip to content
#

api-documentation

Here are 511 public repositories matching this topic...

atlc
atlc commented Aug 6, 2019

Operating system: ALL
Last upstream commit: de496848c1e7b7116371ae25944aced1c22c47a9
Browser version(s): Chrome 75.0.3
Ruby version (run ruby -v): 2.5.1p57


In our use case, we added more deeply nested levels. This caused an issue where the ToC library would grab the HTML tags surrounding the current level and add those into the document.title, giving us such titles in our browser

redoc
baohx2000
baohx2000 commented Feb 6, 2020

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)

mobxjs/mobx-react#831

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

rochacbruno
rochacbruno commented Mar 11, 2020

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

supermiro
supermiro commented Apr 6, 2020

In Nelmio UI there is missing some yaml preview of generated API, is it possible to generate documentation in yaml format? Some tools for testing like soap ui are able to import yaml swagger file and then soap ui is able to work with this file and apis. Solution?

gfazioli
gfazioli commented Jun 25, 2019

hi there, in my package.json I have

... 
"build:utils": "jsdoc2md --files ./resources/assets/jsx/app/utils/*.ts* --configure ./jsdoc2md.json > ./resources/assets/jsx/docs/utils.md",

if I run by shell (MacOS, jsdoc2md v5.0.0)

$ jsdoc2md --files ./resources/assets/jsx/app/utils/*.ts* --configure ./jsdoc2md.json > ./resources/assets/jsx/docs/utils.md

all works fine,

tgirod
tgirod commented May 15, 2019

I want a resource with an array of a sub-resource, and everything properly checked for validity.

As a preamble, I found two ways of declaring a sub-resource and I fail to see the difference between them. First approach:

Fields: schema.Fields{
    "sub": {
        Schema: &subresource
    },
}

Second approach:

Fields: schema.Fields{
    "sub": {
        Valida
kingle
kingle commented Jun 29, 2019

For the maven plugin, could we add to the <reporting> section:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-plugin-plugin</artifactId>
    <version>3.0</version>
</plugin>

and have it automatically generate the plugin-info.html and cmp-report-mojo.html and other <goal>-report-mojo.html that are more consistent with how other maven plugins

create-openapi-repo
ShangyanLi
ShangyanLi commented Oct 30, 2018

I've really enjoyed using the tool for my project documentation.

In addition to API specs, however, I'm also hosting a lot of general software design documentation (that doesn't involve REST API paths at all, like class overview, state diagrams, execution concept & flow, etc.) using Markdown. Right now I'm using tags + x-tagGroups, where the description field for some tags can be hundreds an

Improve this page

Add a description, image, and links to the api-documentation topic page so that developers can more easily learn about it.

Curate this topic

Add this topic to your repo

To associate your repository with the api-documentation topic, visit your repo's landing page and select "manage topics."

Learn more

You can’t perform that action at this time.