strongbugman/apiman

Api document support for any python web framework

apiman's Issues

Question: Does this tool provide security schemes?

I.e. if i have authenticated API, that uses JWT token, is there a way to have it enabled using apiman?

{
  "openapi": "3.0.1",
  "info": {
    "title": "Example app",
    "description": "Application home page",
    "version": "v2"
  },
  "securitySchemes": {
      "JWT": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "<JWT>"
        }
    }
}

For example having this template, can i have the authorization button on the swagger page? Like in the screenshot below?

Feature: request scheme "default" support

Nested models schema mapping

Using the flask extension via

from apiman.flask import Extension

spec_path = "openapi.yml"
openapi = Extension(template=spec_path, decorators=(lambda f: f,))
openapi.init_app(app)

...

with this openapi.yml file

openapi: 3.0.0
servers:
  - url: 'http://localhost'
info:
  version: 0.0.1
  title: Run it
paths:
  /run:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunDocument'
      responses:
        '200':
          description: Success

components:
  schemas:
    RunDocument:
      type: object
      required:
        - Prices
      properties:
        Prices:
          $ref: '#/components/schemas/PriceTimeseries'
    PriceTimeseries:
      type: array
      items:
        $ref: '#/components/schemas/PriceRecord'
    PriceRecord:
      type: object
      required:
        - Timestamp
      properties:
        Timestamp:
          type: number
          description: Unix Epoch in seconds

leads to

where the RunDocument is composed correctly, but the TimeSeries wrongly says it is composed of TimeSeries (should be PriceRecord) although the tooltip shows the correct schema #components/schemas/PriceRecord.

Am I missing something?