OpenAPI Specification: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
Line 31: Line 31:
         - tag-a
         - tag-a
         - other-tag
         - other-tag
Each API [[#Operation|operation]]


=Organizatorium=
=Organizatorium=

Revision as of 21:27, 25 March 2019

Internal

Overview

The document addresses both OpenAPI 2.0 and OpenAPI 3.0. The differences will be emphasized.

Swagger Java Model

SwaggerJavaModel.png

info

title

When imported in AWS API Gateway, the title provides the API name.

Paths

Operations

Tags

https://swagger.io/docs/specification/grouping-operations-with-tags/ Grouping Operations with Tags
paths:
  /a:
    get:
      tags:
        - tag-a
        - other-tag

Each API operation

Organizatorium

x-nullable

Appears in automatically generated Swagger files, as such:

definitions:
    LibraryAccount:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          x-nullable: true
definitions:
  A:
    type: string
    title: A
    x-nullable: true

When used for an API Gateway import, it errors out as:

Unable to create model for 'LibraryAccount': Invalid model specified: Validation Result: warnings : [], errors : [Invalid model schema specified. Unsupported keyword(s): ["x-nullable"]]