Skip to content

Instantly share code, notes, and snippets.

@synopse

synopse/gist:6950a44753099a85f43343adda840623

Last active January 2, 2020 17:15
Show Gist options
  • Save synopse/6950a44753099a85f43343adda840623 to your computer and use it in GitHub Desktop.
Save synopse/6950a44753099a85f43343adda840623 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
gistfile1.txt
{
"swagger": "2.0",
"info": {
"description": "Generated by Project14ServerHttpWrapper (2020-01-02 18:13:12) using mORMot 1.18.5518 at 2020-01-02 18:14:13",
"title": "root API"
},
"host": "127.0.0.1:8888",
"basePath": "/root",
"tags": [
{
"name": "Calculator",
"description": "SOA endpoint for root/Calculator service"
},
{
"name": "AuthGroup",
"description": "ORM endpoint for root/AuthGroup record"
},
{
"name": "AuthUser",
"description": "ORM endpoint for root/AuthUser record"
},
{
"name": "SOA",
"description": "SOA endpoints"
},
{
"name": "ORM",
"description": "ORM endpoints"
}
],
"definitions": {
"AuthGroup": {
"type": "object",
"description": "ORM AuthGroup record definition",
"properties": {
"ID":{"type":"integer","format":"int64"},"Ident":{"type":"string"},"SessionTimeout":{"type":"integer"},"AccessRights":{"type":"string"}
}
},
"AuthUser": {
"type": "object",
"description": "ORM AuthUser record definition",
"properties": {
"ID":{"type":"integer","format":"int64"},"LogonName":{"type":"string"},"DisplayName":{"type":"string"},"PasswordHashHexa":{"type":"string"},"GroupRights":{"type":"integer","format":"int64"},"Data":{"type":"string","format":"binary"}
}
},
"__dummy__": {"type":"string"}
},
"paths": {
"/AuthGroup":{
"get": {
"tags": [
"ORM","AuthGroup"
],
"summary": "query ORM fields values on AuthGroup",
"description": "",
"produces": [
"application/json"
],
"parameters": [{
"name": "select",
"in": "query",
"example": "*",
"description": "defined returned fields of AuthGroup query, set * to return all fields",
"required": true,
"type":"string"
},{
"name": "where",
"in": "query",
"description": "SELECT-like where condition for AuthGroup query",
"required": false,
"type":"string"
},{
"name": "sort",
"in": "query",
"description": "order fields for AuthGroup query",
"required": false,
"type":"string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/AuthGroup"
}
},
"404": {
"description": "AuthGroup not found"
},
"405": {
"description": "Unauthorized access to AuthGroup"
}
}
}
},
"/AuthGroup/":{
"get": {
"tags": [
"ORM","AuthGroup"
],
"summary": "retrieve all AuthGroup ORM ids",
"description": "",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/AuthGroup"
}
},
"404": {
"description": "AuthGroup not found"
},
"405": {
"description": "Unauthorized access to AuthGroup"
}
}
}
, "post": {
"tags": [
"ORM","AuthGroup"
],
"summary": "creates a new AuthGroup ORM record",
"description": "",
"produces": [
"application/json"
],
"parameters": [{
"name": "body",
"in": "body",
"description": "new AuthGroup JSON object content",
"required": true
}],
"responses": {
"201": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/AuthGroup"
}
},
"403": {
"description": "AuthGroup not writable"
},
"404": {
"description": "AuthGroup not found"
},
"405": {
"description": "Unauthorized access to AuthGroup"
}
}
}
},
"/AuthGroup/{id}":{
"get": {
"tags": [
"ORM","AuthGroup"
],
"summary": "retrieve a AuthGroup ORM record by id",
"description": "",
"produces": [
"application/json"
],
"parameters": [{
"name": "id",
"in": "path",
"description": "id to query AuthGroup",
"required": true,
"type": "integer",
"format":"int64"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/AuthGroup"
}
},
"404": {
"description": "AuthGroup not found"
},
"405": {
"description": "Unauthorized access to AuthGroup"
}
}
}, "put": {
"tags": [
"ORM","AuthGroup"
],
"summary": "change a AuthGroup ORM record by id",
"description": "",
"produces": [
"application/json"
],
"parameters": [{
"name": "id",
"in": "path",
"description": "id to update AuthGroup",
"required": true
},{
"name": "body",
"in": "body",
"description": "modified AuthGroup JSON object content (partial fields accepted)",
"required": true
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/AuthGroup"
}
},
"403": {
"description": "AuthGroup not writable"
},
"404": {
"description": "AuthGroup not found"
},
"405": {
"description": "Unauthorized access to AuthGroup"
}
}
},"delete": {
"tags": [
"ORM","AuthGroup"
],
"summary": "remove a AuthGroup record by id",
"description": "",
"produces": [
"application/json"
],
"parameters": [{
"name": "id",
"in": "path",
"description": "id to delete AuthGroup",
"required": true,
"type": "integer",
"format":"int64"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/AuthGroup"
}
},
"403": {
"description": "AuthGroup not writable"
},
"404": {
"description": "AuthGroup not found"
},
"405": {
"description": "Unauthorized access to AuthGroup"
}
}
}
},
"/AuthUser":{
"get": {
"tags": [
"ORM","AuthUser"
],
"summary": "query ORM fields values on AuthUser",
"description": "",
"produces": [
"application/json"
],
"parameters": [{
"name": "select",
"in": "query",
"example": "*",
"description": "defined returned fields of AuthUser query, set * to return all fields",
"required": true,
"type":"string"
},{
"name": "where",
"in": "query",
"description": "SELECT-like where condition for AuthUser query",
"required": false,
"type":"string"
},{
"name": "sort",
"in": "query",
"description": "order fields for AuthUser query",
"required": false,
"type":"string"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/AuthUser"
}
},
"404": {
"description": "AuthUser not found"
},
"405": {
"description": "Unauthorized access to AuthUser"
}
}
}
},
"/AuthUser/":{
"get": {
"tags": [
"ORM","AuthUser"
],
"summary": "retrieve all AuthUser ORM ids",
"description": "",
"produces": [
"application/json"
],
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/AuthUser"
}
},
"404": {
"description": "AuthUser not found"
},
"405": {
"description": "Unauthorized access to AuthUser"
}
}
}
, "post": {
"tags": [
"ORM","AuthUser"
],
"summary": "creates a new AuthUser ORM record",
"description": "",
"produces": [
"application/json"
],
"parameters": [{
"name": "body",
"in": "body",
"description": "new AuthUser JSON object content",
"required": true
}],
"responses": {
"201": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/AuthUser"
}
},
"403": {
"description": "AuthUser not writable"
},
"404": {
"description": "AuthUser not found"
},
"405": {
"description": "Unauthorized access to AuthUser"
}
}
}
},
"/AuthUser/{id}":{
"get": {
"tags": [
"ORM","AuthUser"
],
"summary": "retrieve a AuthUser ORM record by id",
"description": "",
"produces": [
"application/json"
],
"parameters": [{
"name": "id",
"in": "path",
"description": "id to query AuthUser",
"required": true,
"type": "integer",
"format":"int64"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/AuthUser"
}
},
"404": {
"description": "AuthUser not found"
},
"405": {
"description": "Unauthorized access to AuthUser"
}
}
}, "put": {
"tags": [
"ORM","AuthUser"
],
"summary": "change a AuthUser ORM record by id",
"description": "",
"produces": [
"application/json"
],
"parameters": [{
"name": "id",
"in": "path",
"description": "id to update AuthUser",
"required": true
},{
"name": "body",
"in": "body",
"description": "modified AuthUser JSON object content (partial fields accepted)",
"required": true
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/AuthUser"
}
},
"403": {
"description": "AuthUser not writable"
},
"404": {
"description": "AuthUser not found"
},
"405": {
"description": "Unauthorized access to AuthUser"
}
}
},"delete": {
"tags": [
"ORM","AuthUser"
],
"summary": "remove a AuthUser record by id",
"description": "",
"produces": [
"application/json"
],
"parameters": [{
"name": "id",
"in": "path",
"description": "id to delete AuthUser",
"required": true,
"type": "integer",
"format":"int64"
}],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/AuthUser"
}
},
"403": {
"description": "AuthUser not writable"
},
"404": {
"description": "AuthUser not found"
},
"405": {
"description": "Unauthorized access to AuthUser"
}
}
}
}
,
"/Calculator/Add": {
"post": {
"description": "Calculator.Add",
"tags": [
"SOA","Calculator"
],
"parameters": [{
"in": "body",
"name": "body",
"schema": {
"type": "object",
"properties": {
"n1": {"type":"integer"},
"n2": {"type":"integer"}
}
}
}],
"responses": {
"200": {
"schema": {
"type": "object",
"properties": {
"Result": {"type":"integer"}
}
}
}
}
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment