Learn Open API Specification - aliconnect/aliconnect.sdk GitHub Wiki

Open API Specification 3.0

Introductie

Swagger editor example

Swagger editor example Swagger editor example with OAS dmomian

Standaardisatie RWS

Serverless computing

Object structure

Title blocks

header: [
    ['Name'], // title = titel
    ['Title'], // subject = onderwerp
    ['Description'], // summary = beschrijving / samenvatting
],

Object manager tree text modifier

treeTitleAttributeName: 'Name',

Attributes

placeholder

label

idname

options

type

text (default)
number
select
textarea
div

unit

step

min

max

Default schema's

Attributes

# API Definitions

OpenAPI Standard OAS 3.0

Ophalen van de API definitie

/{host}/api/v1/openapi.json

Properties

The following properties are taken directly from the JSON Schema definition and follow the same specifications:

Understanding json schema refrences

string

Draft 4

Werkt zo bij OAS 3.0

In JSON Schema Draft 4, exclusiveMinimum and exclusiveMaximum work differently. There they are boolean values, that indicate whether minimum and maximum are exclusive of the value. For example:

  • if exclusiveMinimum is false, x >= minimum.
  • if exclusiveMinimum is true, x > minimum.

This was changed to have better keyword independence.

Other than the JSON Schema subset fields, the following fields MAY be used for further schema documentation:

"type": "integer",
                "format": "int32",
                "description": "the size of the pack the dog is from",
                "default": 0,
                "minimum": 0

Schema definition

"type": "object",

"required": [ "Name" ],

"treeTitleAttributeName": "Name",

"header": [
  [ "Name" ],
  [ "Title" ],
  [ "Description" ]
],

Attributes / Properties

            "placeholder": "Name",

            "label": "Attribute",

            "idname": "name"

            "placeholder": "Name",

            "placeholder": "Name",

            "placeholder": "Name",

            "placeholder": "Name",

Attribute Type

  • radio
  • text

Enummerations

number no enumeration

  "type": "number",
  "enum": [ 1, 2, 3 ],

"value" = 2

  "type": "string",
  "enum": [ "one", "two", "three" ],

"value" = "two" displayvalue = "Two"

  "type": "string",
  "enum": [ "number_one", "number_two", "number_three" ],

"value" = "number_two" displayvalue = "Number two"

  "type": "number",
  "enum": [ 1, 2, 3 ],
  "display": [ "One", "Two", "Three" ],

"value" = 2

  "type": "number",
  "enum": [ 1, 2, 3 ],
  "display": [
    {
      "title": "Number One",
      "color": "red"
    },
    {
      "title": "Number Two",
      "color": "green"
    },
    {
      "title": "Number Three",
      "color": "blue"
    }
  ],

"value" = 2

  "type": "string",
  "enum": [ "one", "two", "three" ],
  "display": [
    {
      "title": "Number One",
      "color": "red"
    },
    {
      "title": "Number Two",
      "color": "green"
    },
    {
      "title": "Number Three",
      "color": "blue"
    }
  ],

"value" = "Two"

  "description": "The number of the player",

  "default": "number_one",

  "type": "number",
  "format": "int32",

Type

textarea = string url = string checkbox = boolean

files, textarea,url,checkbox,datetime,date,time,text,select,radio,div,email,tel,linkedin,twitter,hidden,options

json1,emailaddress,address

Profile Max van Kampen CEO, Founder, Alicon, Aliconnect [email protected]