Skip to content

Instantly share code, notes, and snippets.

@msjoshi
Created March 29, 2018 15:12
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save msjoshi/08f95f35610656ec7d45bacb48f7bd22 to your computer and use it in GitHub Desktop.
Save msjoshi/08f95f35610656ec7d45bacb48f7bd22 to your computer and use it in GitHub Desktop.
Nested array with enums spec.
{
"swagger": "2.0",
"info": {
"title": "Patrocinium",
"description": "Patrocinium API",
"version": "1.0.0",
"termsOfService": "https://www.patrocinium.com/end-user-licensing-agreement/",
"contact": {
"name": "Patrocinium",
"url": "https://www.patrocinium.com",
"email": "support@patrocinium.com"
}
},
"host": "papi.patrocinium.com",
"basePath": "/v1",
"schemes": [
"https",
"http"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json"
],
"paths": {
"/db/ActionRole/findAndCountAll": {
"post": {
"tags": [
"db"
],
"description": "Find all instances of ActionRole",
"operationId": "findActionRole",
"parameters": [
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"$ref": "#/definitions/ActionRoleSearch"
}
}
],
"responses": {
"200": {
"description": "Successful Operation"
},
"400": {
"description": "Bad Request"
},
"403": {
"description": "Unauthorized"
},
"500": {
"description": "Internal Server Error"
}
}
}
}
},
"definitions": {
"ActionRoleSearch": {
"type": "object",
"properties": {
"attributes": {
"description": "A list of the attributes that you want to return.",
"type": "array",
"items": {
"type": "string",
"enum": [
"id",
"actionId",
"roleId",
"createdAt",
"updatedAt",
"deletedAt"
]
}
},
"where": {
"description": "A hash of attributes to describe your search.",
"type": "object"
},
"order": {
"description": "A collection of grouped attribute names and directions.",
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string",
"enum": [
"id",
"actionId",
"roleId",
"createdAt",
"updatedAt",
"deletedAt",
"ASC",
"DESC"
]
}
}
},
"limit": {
"description": "The number of ActionRole instances to return.",
"type": "integer",
"format": "int64",
"default": 100,
"minimum": 1,
"maximum": 1000
},
"offset": {
"description": "The number of ActionRole instances to offset the returned rows.",
"type": "integer",
"format": "int64",
"minimum": 0,
"default": 0
}
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment