Giters

ouropencode / OpenDocumenter

OpenDocumenter is a automatic documentation generator for OpenAPI v3 schemas. Simply provide your schema file in JSON or YAML, then sit back and enjoy the documentation.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

OpenAPI Specification - 3.0.3

R4wizard opened this issue · comments

commented
  • Specification (3.0.3)
    • OpenAPI Object
      • components field is ignored (not sure its needed?)
      • security
    • Info Object
    • Contact Object
    • License Object
    • Server Object
      • variables field is ignored and no support is provided
    • Server Variable Object
    • Components Object (mostly not needed?)
      • schemas
      • responses
      • parameters
      • examples
      • requestBodies
      • headers
      • securitySchemes
      • links
      • callbacks
    • Paths Object
    • Path Item Object
      • summary field is ignored
      • description field is ignored
      • servers field is ignored
      • parameters field is ignored
    • Operation Object
      • externalDocs field is ignored
      • operationId field is ignored
      • parameters field is ignored
      • callbacks field is ignored
      • deprecated field is ignored
      • security field is ignored
      • servers field is ignored
    • External Documentation Object
      • nothing implements the display of this (should be displayed as a link alongside the request)
    • Parameter Object
      • nothing implements the display of this (should be displayed as a table alongside the request)
    • Request Body Object
      • required field is ignored
    • Media Type Object
      • schema is ignored and application/json is expected
      • examples field is ignored (we do use the example field though. examples shall override example)
      • encoding field is ignored
    • Encoding Object
      • nothing implements the display of this
    • Responses Object
    • Response Object
      • headers field is ignored
      • links field is ignored
    • Callback Object
      • nothing implements the display of this
    • Example Object
      • nothing implements the display of this (the right side panel kinda does but doesn't implement multiple or anything?)
    • Link Object
      • nothing implements the display of this
    • Header Object
      • nothing implements the display of this
    • Tag Object
      • externalDocs is ignored
    • Reference Object
    • Schema Object
      • nothing implements the display of this
    • Discriminator Object
      • nothing implements the display of this
    • XML Object
      • nothing implements the display of this
    • Security Scheme Object
      • nothing implements the display of this
    • OAuth Flows Object
      • nothing implements the display of this
    • OAuth Flow Object
      • nothing implements the display of this
    • Security Requirement Object
      • nothing implements the display of this