Created
May 25, 2016 18:34
-
-
Save patcon/deff2236cd9e5c97b6612187bebdff0a to your computer and use it in GitHub Desktop.
JSONdoc API for a hypothetical city hall API.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "apis": { | |
| "": [ | |
| { | |
| "auth": null, | |
| "description": "The user services", | |
| "group": "", | |
| "jsondocId": "ea51f3cf-a403-4325-ae6e-9814d7ed7d0f", | |
| "methods": [ | |
| { | |
| "apierrors": [], | |
| "auth": null, | |
| "bodyobject": null, | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "description": "", | |
| "displayMethodAs": "URI", | |
| "displayedMethodString": [ | |
| "/users" | |
| ], | |
| "headers": [], | |
| "id": null, | |
| "jsondocId": "73d3e2fd-f139-4979-b5df-d25ce5c3abed", | |
| "jsondocerrors": [], | |
| "jsondochints": [ | |
| "Add description to ApiMethod" | |
| ], | |
| "jsondocwarnings": [], | |
| "path": [ | |
| "/users" | |
| ], | |
| "pathparameters": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "queryparameters": [], | |
| "response": { | |
| "jsondocId": "3e6b4596-8232-48b9-8ad1-618e579aa9bc", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "list of user", | |
| "type": [ | |
| "list", | |
| "user" | |
| ] | |
| } | |
| }, | |
| "responsestatuscode": "200 - OK", | |
| "stage": "UNDEFINED", | |
| "summary": "", | |
| "supportedversions": null, | |
| "verb": [ | |
| "GET" | |
| ], | |
| "visibility": "UNDEFINED" | |
| }, | |
| { | |
| "apierrors": [ | |
| { | |
| "code": "404", | |
| "description": "When the user with the given id is not found", | |
| "jsondocId": "f392d869-7df1-4993-9291-b4cbec1cc69f" | |
| } | |
| ], | |
| "auth": null, | |
| "bodyobject": null, | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "description": "", | |
| "displayMethodAs": "URI", | |
| "displayedMethodString": [ | |
| "/users/{id}" | |
| ], | |
| "headers": [], | |
| "id": "USER_FIND_ONE", | |
| "jsondocId": "075a4146-c9b9-4c3a-8aa0-81b0d0fd8a53", | |
| "jsondocerrors": [], | |
| "jsondochints": [ | |
| "Add description to ApiPathParam", | |
| "Add description to ApiMethod" | |
| ], | |
| "jsondocwarnings": [], | |
| "path": [ | |
| "/users/{id}" | |
| ], | |
| "pathparameters": [ | |
| { | |
| "allowedvalues": [], | |
| "defaultvalue": "", | |
| "description": "", | |
| "format": null, | |
| "jsondocId": "bae75caf-0738-4d72-bc50-1c27b9ab2b62", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "long", | |
| "type": [ | |
| "long" | |
| ] | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "id", | |
| "required": "true" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "queryparameters": [], | |
| "response": { | |
| "jsondocId": "7139f2d3-30e1-411d-8b6b-3f67da34a680", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "user", | |
| "type": [ | |
| "user" | |
| ] | |
| } | |
| }, | |
| "responsestatuscode": "200 - OK", | |
| "stage": "UNDEFINED", | |
| "summary": "", | |
| "supportedversions": null, | |
| "verb": [ | |
| "GET" | |
| ], | |
| "visibility": "UNDEFINED" | |
| } | |
| ], | |
| "name": "User services", | |
| "stage": "UNDEFINED", | |
| "supportedversions": null, | |
| "visibility": "UNDEFINED" | |
| } | |
| ], | |
| "Library": [ | |
| { | |
| "auth": { | |
| "roles": [ | |
| "*" | |
| ], | |
| "scheme": "Bearer", | |
| "testtokens": [ | |
| "abc" | |
| ], | |
| "testusers": {}, | |
| "type": "TOKEN" | |
| }, | |
| "description": "The author services", | |
| "group": "Library", | |
| "jsondocId": "4bda352b-f7bc-4527-9227-4a3a192e8ee5", | |
| "methods": [ | |
| { | |
| "apierrors": [], | |
| "auth": { | |
| "roles": [ | |
| "*" | |
| ], | |
| "scheme": "Bearer", | |
| "testtokens": [ | |
| "abc" | |
| ], | |
| "testusers": {}, | |
| "type": "TOKEN" | |
| }, | |
| "bodyobject": null, | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "description": "", | |
| "displayMethodAs": "URI", | |
| "displayedMethodString": [ | |
| "/authors" | |
| ], | |
| "headers": [], | |
| "id": "AUTHOR_FIND_ALL", | |
| "jsondocId": "5e886c0c-5062-4e32-931a-b110aa2ff6e1", | |
| "jsondocerrors": [], | |
| "jsondochints": [ | |
| "Add description to ApiMethod" | |
| ], | |
| "jsondocwarnings": [], | |
| "path": [ | |
| "/authors" | |
| ], | |
| "pathparameters": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "queryparameters": [], | |
| "response": { | |
| "jsondocId": "3e9ffb8d-7395-4973-b038-3841dd89e2fb", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "list of Author", | |
| "type": [ | |
| "list", | |
| "Author" | |
| ] | |
| } | |
| }, | |
| "responsestatuscode": "200 - OK", | |
| "stage": "UNDEFINED", | |
| "summary": "", | |
| "supportedversions": null, | |
| "verb": [ | |
| "GET" | |
| ], | |
| "visibility": "UNDEFINED" | |
| }, | |
| { | |
| "apierrors": [], | |
| "auth": { | |
| "roles": [ | |
| "*" | |
| ], | |
| "scheme": "", | |
| "testtokens": [], | |
| "testusers": {}, | |
| "type": "TOKEN" | |
| }, | |
| "bodyobject": null, | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "description": "", | |
| "displayMethodAs": "URI", | |
| "displayedMethodString": [ | |
| "/authors/{id}" | |
| ], | |
| "headers": [], | |
| "id": "AUTHOR_FIND_ONE", | |
| "jsondocId": "b0cb3491-f0d3-4565-842c-24fc8adef548", | |
| "jsondocerrors": [], | |
| "jsondochints": [ | |
| "Add description to ApiPathParam", | |
| "Add description to ApiMethod" | |
| ], | |
| "jsondocwarnings": [], | |
| "path": [ | |
| "/authors/{id}" | |
| ], | |
| "pathparameters": [ | |
| { | |
| "allowedvalues": [], | |
| "defaultvalue": "", | |
| "description": "", | |
| "format": "", | |
| "jsondocId": "0d17886c-3060-4014-987d-2a2d1ea30c77", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "long", | |
| "type": [ | |
| "long" | |
| ] | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "id", | |
| "required": "true" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "queryparameters": [], | |
| "response": { | |
| "jsondocId": "9a1631f6-121c-429b-a042-140cd350e370", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "Author", | |
| "type": [ | |
| "Author" | |
| ] | |
| } | |
| }, | |
| "responsestatuscode": "200 - OK", | |
| "stage": "UNDEFINED", | |
| "summary": "", | |
| "supportedversions": null, | |
| "verb": [ | |
| "GET" | |
| ], | |
| "visibility": "UNDEFINED" | |
| }, | |
| { | |
| "apierrors": [], | |
| "auth": { | |
| "roles": [ | |
| "*" | |
| ], | |
| "scheme": "Bearer", | |
| "testtokens": [ | |
| "abc" | |
| ], | |
| "testusers": {}, | |
| "type": "TOKEN" | |
| }, | |
| "bodyobject": null, | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "description": "", | |
| "displayMethodAs": "URI", | |
| "displayedMethodString": [ | |
| "/authors/{id}" | |
| ], | |
| "headers": [], | |
| "id": "AUTHOR_DELETE", | |
| "jsondocId": "ca05fc9b-cc92-43a8-b3c6-fc2ff1c99731", | |
| "jsondocerrors": [], | |
| "jsondochints": [ | |
| "Add description to ApiPathParam", | |
| "Add description to ApiMethod" | |
| ], | |
| "jsondocwarnings": [], | |
| "path": [ | |
| "/authors/{id}" | |
| ], | |
| "pathparameters": [ | |
| { | |
| "allowedvalues": [], | |
| "defaultvalue": "", | |
| "description": "", | |
| "format": "", | |
| "jsondocId": "11110186-d43b-4ddb-8282-bf5a412572a2", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "long", | |
| "type": [ | |
| "long" | |
| ] | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "id", | |
| "required": "true" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "queryparameters": [], | |
| "response": { | |
| "jsondocId": "e07e5744-f283-40f9-b7d3-d2023bf15d7e", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "void", | |
| "type": [ | |
| "void" | |
| ] | |
| } | |
| }, | |
| "responsestatuscode": "200 - OK", | |
| "stage": "UNDEFINED", | |
| "summary": "", | |
| "supportedversions": null, | |
| "verb": [ | |
| "DELETE" | |
| ], | |
| "visibility": "UNDEFINED" | |
| }, | |
| { | |
| "apierrors": [], | |
| "auth": { | |
| "roles": [ | |
| "*" | |
| ], | |
| "scheme": "Bearer", | |
| "testtokens": [ | |
| "abc" | |
| ], | |
| "testusers": {}, | |
| "type": "TOKEN" | |
| }, | |
| "bodyobject": { | |
| "jsondocId": "3ff166f8-e8ce-4d5f-b094-52ce5a35e421", | |
| "jsondocTemplate": { | |
| "books": [], | |
| "id": 0, | |
| "name": "" | |
| }, | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "Author", | |
| "type": [ | |
| "Author" | |
| ] | |
| } | |
| }, | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "description": "", | |
| "displayMethodAs": "URI", | |
| "displayedMethodString": [ | |
| "/authors" | |
| ], | |
| "headers": [], | |
| "id": "AUTHOR_SAVE", | |
| "jsondocId": "11d936ca-dc11-4c5d-8797-5935a39afb97", | |
| "jsondocerrors": [], | |
| "jsondochints": [ | |
| "Add description to ApiMethod" | |
| ], | |
| "jsondocwarnings": [], | |
| "path": [ | |
| "/authors" | |
| ], | |
| "pathparameters": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "queryparameters": [], | |
| "response": { | |
| "jsondocId": "f3ecb454-c957-40d1-92c6-aebb580fc3d8", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "void", | |
| "type": [ | |
| "void" | |
| ] | |
| } | |
| }, | |
| "responsestatuscode": "201 - Created", | |
| "stage": "UNDEFINED", | |
| "summary": "", | |
| "supportedversions": null, | |
| "verb": [ | |
| "POST" | |
| ], | |
| "visibility": "UNDEFINED" | |
| } | |
| ], | |
| "name": "Author services", | |
| "stage": "UNDEFINED", | |
| "supportedversions": null, | |
| "visibility": "UNDEFINED" | |
| }, | |
| { | |
| "auth": null, | |
| "description": "The books controller", | |
| "group": "Library", | |
| "jsondocId": "973de453-6275-4fe8-acfd-01d2ac885402", | |
| "methods": [ | |
| { | |
| "apierrors": [], | |
| "auth": null, | |
| "bodyobject": null, | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "description": "", | |
| "displayMethodAs": "URI", | |
| "displayedMethodString": [ | |
| "/books" | |
| ], | |
| "headers": [], | |
| "id": "BOOK_FIND_ALL", | |
| "jsondocId": "58485e77-4234-4a33-b2bc-1e93e1c30996", | |
| "jsondocerrors": [], | |
| "jsondochints": [ | |
| "Add description to ApiMethod" | |
| ], | |
| "jsondocwarnings": [], | |
| "path": [ | |
| "/books" | |
| ], | |
| "pathparameters": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "queryparameters": [], | |
| "response": { | |
| "jsondocId": "654b883e-1e7a-407c-bdc5-aa67c98301ff", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "list of Book", | |
| "type": [ | |
| "list", | |
| "Book" | |
| ] | |
| } | |
| }, | |
| "responsestatuscode": "200 - OK", | |
| "stage": "UNDEFINED", | |
| "summary": "", | |
| "supportedversions": null, | |
| "verb": [ | |
| "GET" | |
| ], | |
| "visibility": "UNDEFINED" | |
| }, | |
| { | |
| "apierrors": [], | |
| "auth": null, | |
| "bodyobject": null, | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "description": "", | |
| "displayMethodAs": "URI", | |
| "displayedMethodString": [ | |
| "/books/{id}" | |
| ], | |
| "headers": [], | |
| "id": "BOOK_FIND_ONE", | |
| "jsondocId": "e21d0b8a-c966-40e0-a1b5-aff0e9791e7f", | |
| "jsondocerrors": [], | |
| "jsondochints": [ | |
| "Add description to ApiPathParam", | |
| "Add description to ApiMethod" | |
| ], | |
| "jsondocwarnings": [], | |
| "path": [ | |
| "/books/{id}" | |
| ], | |
| "pathparameters": [ | |
| { | |
| "allowedvalues": [], | |
| "defaultvalue": "", | |
| "description": "", | |
| "format": "", | |
| "jsondocId": "12f05a14-cab2-48d8-98ed-c81d9c243ca2", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "long", | |
| "type": [ | |
| "long" | |
| ] | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "id", | |
| "required": "true" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "queryparameters": [], | |
| "response": { | |
| "jsondocId": "747debf1-588c-402b-bff0-805fedec609c", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "Book", | |
| "type": [ | |
| "Book" | |
| ] | |
| } | |
| }, | |
| "responsestatuscode": "200 - OK", | |
| "stage": "UNDEFINED", | |
| "summary": "Gets a book given the book ID", | |
| "supportedversions": null, | |
| "verb": [ | |
| "GET" | |
| ], | |
| "visibility": "UNDEFINED" | |
| }, | |
| { | |
| "apierrors": [], | |
| "auth": null, | |
| "bodyobject": null, | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "description": "", | |
| "displayMethodAs": "URI", | |
| "displayedMethodString": [ | |
| "/books/{id}" | |
| ], | |
| "headers": [], | |
| "id": "BOOK_DELETE", | |
| "jsondocId": "470ad189-1045-4b34-91b9-c4da8e30f90d", | |
| "jsondocerrors": [], | |
| "jsondochints": [ | |
| "Add description to ApiPathParam", | |
| "Add description to ApiMethod" | |
| ], | |
| "jsondocwarnings": [], | |
| "path": [ | |
| "/books/{id}" | |
| ], | |
| "pathparameters": [ | |
| { | |
| "allowedvalues": [], | |
| "defaultvalue": "", | |
| "description": "", | |
| "format": "", | |
| "jsondocId": "9f5ccbbf-fd0d-45d4-b20e-a9c131d674b1", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "long", | |
| "type": [ | |
| "long" | |
| ] | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "id", | |
| "required": "true" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "queryparameters": [], | |
| "response": { | |
| "jsondocId": "7d762983-519e-42e8-af24-2682caae1998", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "void", | |
| "type": [ | |
| "void" | |
| ] | |
| } | |
| }, | |
| "responsestatuscode": "200 - OK", | |
| "stage": "UNDEFINED", | |
| "summary": "", | |
| "supportedversions": null, | |
| "verb": [ | |
| "DELETE" | |
| ], | |
| "visibility": "UNDEFINED" | |
| }, | |
| { | |
| "apierrors": [], | |
| "auth": null, | |
| "bodyobject": { | |
| "jsondocId": "6711f85f-cedf-4afd-bc54-16cfc5e39385", | |
| "jsondocTemplate": { | |
| "author": { | |
| "books": [], | |
| "id": 0, | |
| "name": "" | |
| }, | |
| "id": 0, | |
| "price": 0, | |
| "title": "" | |
| }, | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "Book", | |
| "type": [ | |
| "Book" | |
| ] | |
| } | |
| }, | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "description": "", | |
| "displayMethodAs": "URI", | |
| "displayedMethodString": [ | |
| "/books" | |
| ], | |
| "headers": [], | |
| "id": "BOOK_SAVE", | |
| "jsondocId": "608bfc5f-da20-47ca-b56a-36cdda5bce6f", | |
| "jsondocerrors": [], | |
| "jsondochints": [ | |
| "Add description to ApiMethod" | |
| ], | |
| "jsondocwarnings": [], | |
| "path": [ | |
| "/books" | |
| ], | |
| "pathparameters": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "queryparameters": [], | |
| "response": { | |
| "jsondocId": "47ff52c1-5e47-466b-af0d-e94fdf2b12c7", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "void", | |
| "type": [ | |
| "void" | |
| ] | |
| } | |
| }, | |
| "responsestatuscode": "201 - Created", | |
| "stage": "UNDEFINED", | |
| "summary": "", | |
| "supportedversions": null, | |
| "verb": [ | |
| "POST" | |
| ], | |
| "visibility": "UNDEFINED" | |
| } | |
| ], | |
| "name": "Books services", | |
| "stage": "UNDEFINED", | |
| "supportedversions": null, | |
| "visibility": "UNDEFINED" | |
| } | |
| ] | |
| }, | |
| "basePath": "http://jsondoc-fabiomaffioletti.rhcloud.com", | |
| "displayMethodAs": "URI", | |
| "flows": { | |
| "": [ | |
| { | |
| "description": "Gets an author's details starting from the book's list", | |
| "group": "", | |
| "jsondocId": "c2ade696-b2a9-467d-87d3-262247e94fa6", | |
| "methods": [ | |
| { | |
| "apierrors": [], | |
| "auth": null, | |
| "bodyobject": null, | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "description": "", | |
| "displayMethodAs": "URI", | |
| "displayedMethodString": [ | |
| "/books" | |
| ], | |
| "headers": [], | |
| "id": "BOOK_FIND_ALL", | |
| "jsondocId": "58485e77-4234-4a33-b2bc-1e93e1c30996", | |
| "jsondocerrors": [], | |
| "jsondochints": [ | |
| "Add description to ApiMethod" | |
| ], | |
| "jsondocwarnings": [], | |
| "path": [ | |
| "/books" | |
| ], | |
| "pathparameters": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "queryparameters": [], | |
| "response": { | |
| "jsondocId": "654b883e-1e7a-407c-bdc5-aa67c98301ff", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "list of Book", | |
| "type": [ | |
| "list", | |
| "Book" | |
| ] | |
| } | |
| }, | |
| "responsestatuscode": "200 - OK", | |
| "stage": "UNDEFINED", | |
| "summary": "", | |
| "supportedversions": null, | |
| "verb": [ | |
| "GET" | |
| ], | |
| "visibility": "UNDEFINED" | |
| }, | |
| { | |
| "apierrors": [], | |
| "auth": null, | |
| "bodyobject": null, | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "description": "", | |
| "displayMethodAs": "URI", | |
| "displayedMethodString": [ | |
| "/books/{id}" | |
| ], | |
| "headers": [], | |
| "id": "BOOK_FIND_ONE", | |
| "jsondocId": "e21d0b8a-c966-40e0-a1b5-aff0e9791e7f", | |
| "jsondocerrors": [], | |
| "jsondochints": [ | |
| "Add description to ApiPathParam", | |
| "Add description to ApiMethod" | |
| ], | |
| "jsondocwarnings": [], | |
| "path": [ | |
| "/books/{id}" | |
| ], | |
| "pathparameters": [ | |
| { | |
| "allowedvalues": [], | |
| "defaultvalue": "", | |
| "description": "", | |
| "format": "", | |
| "jsondocId": "12f05a14-cab2-48d8-98ed-c81d9c243ca2", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "long", | |
| "type": [ | |
| "long" | |
| ] | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "id", | |
| "required": "true" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "queryparameters": [], | |
| "response": { | |
| "jsondocId": "747debf1-588c-402b-bff0-805fedec609c", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "Book", | |
| "type": [ | |
| "Book" | |
| ] | |
| } | |
| }, | |
| "responsestatuscode": "200 - OK", | |
| "stage": "UNDEFINED", | |
| "summary": "Gets a book given the book ID", | |
| "supportedversions": null, | |
| "verb": [ | |
| "GET" | |
| ], | |
| "visibility": "UNDEFINED" | |
| }, | |
| { | |
| "apierrors": [], | |
| "auth": { | |
| "roles": [ | |
| "*" | |
| ], | |
| "scheme": "", | |
| "testtokens": [], | |
| "testusers": {}, | |
| "type": "TOKEN" | |
| }, | |
| "bodyobject": null, | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "description": "", | |
| "displayMethodAs": "URI", | |
| "displayedMethodString": [ | |
| "/authors/{id}" | |
| ], | |
| "headers": [], | |
| "id": "AUTHOR_FIND_ONE", | |
| "jsondocId": "b0cb3491-f0d3-4565-842c-24fc8adef548", | |
| "jsondocerrors": [], | |
| "jsondochints": [ | |
| "Add description to ApiPathParam", | |
| "Add description to ApiMethod" | |
| ], | |
| "jsondocwarnings": [], | |
| "path": [ | |
| "/authors/{id}" | |
| ], | |
| "pathparameters": [ | |
| { | |
| "allowedvalues": [], | |
| "defaultvalue": "", | |
| "description": "", | |
| "format": "", | |
| "jsondocId": "0d17886c-3060-4014-987d-2a2d1ea30c77", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "long", | |
| "type": [ | |
| "long" | |
| ] | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "id", | |
| "required": "true" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "queryparameters": [], | |
| "response": { | |
| "jsondocId": "9a1631f6-121c-429b-a042-140cd350e370", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "Author", | |
| "type": [ | |
| "Author" | |
| ] | |
| } | |
| }, | |
| "responsestatuscode": "200 - OK", | |
| "stage": "UNDEFINED", | |
| "summary": "", | |
| "supportedversions": null, | |
| "verb": [ | |
| "GET" | |
| ], | |
| "visibility": "UNDEFINED" | |
| } | |
| ], | |
| "name": "Author detail flow", | |
| "preconditions": [], | |
| "steps": [ | |
| { | |
| "apimethoddoc": { | |
| "apierrors": [], | |
| "auth": null, | |
| "bodyobject": null, | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "description": "", | |
| "displayMethodAs": "URI", | |
| "displayedMethodString": [ | |
| "/books" | |
| ], | |
| "headers": [], | |
| "id": "BOOK_FIND_ALL", | |
| "jsondocId": "58485e77-4234-4a33-b2bc-1e93e1c30996", | |
| "jsondocerrors": [], | |
| "jsondochints": [ | |
| "Add description to ApiMethod" | |
| ], | |
| "jsondocwarnings": [], | |
| "path": [ | |
| "/books" | |
| ], | |
| "pathparameters": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "queryparameters": [], | |
| "response": { | |
| "jsondocId": "654b883e-1e7a-407c-bdc5-aa67c98301ff", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "list of Book", | |
| "type": [ | |
| "list", | |
| "Book" | |
| ] | |
| } | |
| }, | |
| "responsestatuscode": "200 - OK", | |
| "stage": "UNDEFINED", | |
| "summary": "", | |
| "supportedversions": null, | |
| "verb": [ | |
| "GET" | |
| ], | |
| "visibility": "UNDEFINED" | |
| }, | |
| "apimethodid": "BOOK_FIND_ALL", | |
| "jsondocId": "ca64ec3b-870f-4286-9705-dfdec6e96150" | |
| }, | |
| { | |
| "apimethoddoc": { | |
| "apierrors": [], | |
| "auth": null, | |
| "bodyobject": null, | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "description": "", | |
| "displayMethodAs": "URI", | |
| "displayedMethodString": [ | |
| "/books/{id}" | |
| ], | |
| "headers": [], | |
| "id": "BOOK_FIND_ONE", | |
| "jsondocId": "e21d0b8a-c966-40e0-a1b5-aff0e9791e7f", | |
| "jsondocerrors": [], | |
| "jsondochints": [ | |
| "Add description to ApiPathParam", | |
| "Add description to ApiMethod" | |
| ], | |
| "jsondocwarnings": [], | |
| "path": [ | |
| "/books/{id}" | |
| ], | |
| "pathparameters": [ | |
| { | |
| "allowedvalues": [], | |
| "defaultvalue": "", | |
| "description": "", | |
| "format": "", | |
| "jsondocId": "12f05a14-cab2-48d8-98ed-c81d9c243ca2", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "long", | |
| "type": [ | |
| "long" | |
| ] | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "id", | |
| "required": "true" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "queryparameters": [], | |
| "response": { | |
| "jsondocId": "747debf1-588c-402b-bff0-805fedec609c", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "Book", | |
| "type": [ | |
| "Book" | |
| ] | |
| } | |
| }, | |
| "responsestatuscode": "200 - OK", | |
| "stage": "UNDEFINED", | |
| "summary": "Gets a book given the book ID", | |
| "supportedversions": null, | |
| "verb": [ | |
| "GET" | |
| ], | |
| "visibility": "UNDEFINED" | |
| }, | |
| "apimethodid": "BOOK_FIND_ONE", | |
| "jsondocId": "3b3f9728-cde2-41e5-8387-eb6eae34689f" | |
| }, | |
| { | |
| "apimethoddoc": { | |
| "apierrors": [], | |
| "auth": { | |
| "roles": [ | |
| "*" | |
| ], | |
| "scheme": "", | |
| "testtokens": [], | |
| "testusers": {}, | |
| "type": "TOKEN" | |
| }, | |
| "bodyobject": null, | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "description": "", | |
| "displayMethodAs": "URI", | |
| "displayedMethodString": [ | |
| "/authors/{id}" | |
| ], | |
| "headers": [], | |
| "id": "AUTHOR_FIND_ONE", | |
| "jsondocId": "b0cb3491-f0d3-4565-842c-24fc8adef548", | |
| "jsondocerrors": [], | |
| "jsondochints": [ | |
| "Add description to ApiPathParam", | |
| "Add description to ApiMethod" | |
| ], | |
| "jsondocwarnings": [], | |
| "path": [ | |
| "/authors/{id}" | |
| ], | |
| "pathparameters": [ | |
| { | |
| "allowedvalues": [], | |
| "defaultvalue": "", | |
| "description": "", | |
| "format": "", | |
| "jsondocId": "0d17886c-3060-4014-987d-2a2d1ea30c77", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "long", | |
| "type": [ | |
| "long" | |
| ] | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "id", | |
| "required": "true" | |
| } | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "queryparameters": [], | |
| "response": { | |
| "jsondocId": "9a1631f6-121c-429b-a042-140cd350e370", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "Author", | |
| "type": [ | |
| "Author" | |
| ] | |
| } | |
| }, | |
| "responsestatuscode": "200 - OK", | |
| "stage": "UNDEFINED", | |
| "summary": "", | |
| "supportedversions": null, | |
| "verb": [ | |
| "GET" | |
| ], | |
| "visibility": "UNDEFINED" | |
| }, | |
| "apimethodid": "AUTHOR_FIND_ONE", | |
| "jsondocId": "168166ad-410d-4fe0-9428-080adfaf30c4" | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| "global": { | |
| "changelogset": { | |
| "changelogs": [ | |
| { | |
| "changes": [ | |
| "Changelog #5", | |
| "Changelog #6" | |
| ], | |
| "jsondocId": "7feb7653-861d-42dd-8ab3-abeb4fbe941a", | |
| "version": "2.0" | |
| }, | |
| { | |
| "changes": [ | |
| "Changelog #2", | |
| "Changelog #3", | |
| "Changelog #4" | |
| ], | |
| "jsondocId": "80624b50-c1db-4412-846d-4fdcf99a8a77", | |
| "version": "1.1" | |
| }, | |
| { | |
| "changes": [ | |
| "Changelog #1" | |
| ], | |
| "jsondocId": "ad6696fa-ce40-4564-95e0-fb17b2f59fae", | |
| "version": "1.0" | |
| } | |
| ], | |
| "jsondocId": "888edfad-ddeb-4429-b9fc-45132114c320" | |
| }, | |
| "jsondocId": "8415a697-a6f6-4df9-9077-020a8b44a596", | |
| "migrationset": { | |
| "jsondocId": "8ae2f10f-f423-470a-8072-e54fa339fd55", | |
| "migrations": [ | |
| { | |
| "fromVersion": "1.1", | |
| "jsondocId": "22c1fc58-0982-49d6-9aca-8fabba61e111", | |
| "steps": [ | |
| "Step #3" | |
| ], | |
| "toVersion": "2.0" | |
| }, | |
| { | |
| "fromVersion": "1.0", | |
| "jsondocId": "ff10cc25-d872-4ac7-9f04-6d945b24a823", | |
| "steps": [ | |
| "Step #1", | |
| "Step #2" | |
| ], | |
| "toVersion": "1.1" | |
| } | |
| ] | |
| }, | |
| "sections": [ | |
| { | |
| "jsondocId": "f7de2d41-90c6-4043-9257-81839caedad2", | |
| "paragraphs": [ | |
| "<table><tr><th>Type</th><th>Description</th></tr><tr><td><code>None</code></td><td>Endpoints starting with <code>/public</code> do not need any authentication</td></tr><tr><td><code>Basic</code></td><td>Endpoints starting with <code>/basic</code> need Basic Authentication and a header with name <code>X-JSONDoc-Secure</code> and value <code>true</code></td></tr></table>" | |
| ], | |
| "title": "Authentication" | |
| }, | |
| { | |
| "jsondocId": "8c007259-2278-4566-9cc2-99571c6ca688", | |
| "paragraphs": [ | |
| "<table><tr><th>Status code</th><th>Description</th></tr><tr><td><code>200</code></td><td>Request has been correctly processed</td></tr></table>" | |
| ], | |
| "title": "Status codes" | |
| }, | |
| { | |
| "jsondocId": "c10be325-a568-404d-99a8-4a7ba99cec87", | |
| "paragraphs": [ | |
| "<table><tr><th>Header name</th><th>Header value</th><th>Description</th></tr><tr><td><code>X-JSONDoc-name</code></td><td>jsondoc-header-value</td><td>This is a header that every request should have</td></tr><tr><td><code>X-JSONDoc-api-key</code></td><td></td><td>This is a the api key assigned to every api user</td></tr></table>" | |
| ], | |
| "title": "Headers" | |
| }, | |
| { | |
| "jsondocId": "5fb22a13-44c1-4848-a809-8ca9b4563c72", | |
| "paragraphs": [ | |
| "HTTP Verbs paragraph 1", | |
| "HTTP Verbs paragraph 2", | |
| "<table><tr><th>Verb</th><th>Description</th></tr><tr><td><code>GET</code></td><td>Gets resources</td></tr><tr><td><code>POST</code></td><td>Posts resources</td></tr></table>", | |
| "HTTP Verbs paragraph 3" | |
| ], | |
| "title": "HTTP Verbs" | |
| } | |
| ] | |
| }, | |
| "objects": { | |
| "": [ | |
| { | |
| "allowedvalues": [], | |
| "description": "", | |
| "fields": [ | |
| { | |
| "allowedvalues": null, | |
| "description": null, | |
| "displayedFormat": "", | |
| "format": [], | |
| "jsondocId": "1caaa27c-e465-49fd-96c6-2b94e07bbc3b", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "long", | |
| "type": [ | |
| "long" | |
| ] | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "id", | |
| "order": 2147483647, | |
| "required": "UNDEFINED", | |
| "supportedversions": null | |
| }, | |
| { | |
| "allowedvalues": null, | |
| "description": null, | |
| "displayedFormat": "may not be empty, length must be between 5 and 20", | |
| "format": [ | |
| "may not be empty", | |
| "length must be between 5 and 20" | |
| ], | |
| "jsondocId": "8b4b9733-952f-45ec-a55f-8e2e2ec01bc1", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "string", | |
| "type": [ | |
| "string" | |
| ] | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "username", | |
| "order": 2147483647, | |
| "required": "UNDEFINED", | |
| "supportedversions": null | |
| } | |
| ], | |
| "group": "", | |
| "jsondocId": "03e0a756-9ef2-45d1-9b45-3a02273f7bde", | |
| "jsondocTemplate": { | |
| "id": 0, | |
| "username": "" | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [ | |
| "Add description to field: id", | |
| "Add description to field: username" | |
| ], | |
| "jsondocwarnings": [], | |
| "name": "User", | |
| "show": true, | |
| "stage": "UNDEFINED", | |
| "supportedversions": null, | |
| "visibility": "UNDEFINED" | |
| } | |
| ], | |
| "Library": [ | |
| { | |
| "allowedvalues": [], | |
| "description": "Represents an author. Every author has a list of <code>Book</code>s", | |
| "fields": [ | |
| { | |
| "allowedvalues": [], | |
| "description": "", | |
| "displayedFormat": "", | |
| "format": [], | |
| "jsondocId": "bee3358f-3e4d-4a17-a362-0cfff8784e00", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "list of Book", | |
| "type": [ | |
| "list", | |
| "Book" | |
| ] | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "books", | |
| "order": 2147483647, | |
| "required": "false", | |
| "supportedversions": null | |
| }, | |
| { | |
| "allowedvalues": [], | |
| "description": "", | |
| "displayedFormat": "", | |
| "format": [], | |
| "jsondocId": "55a3b6b5-2692-421c-961d-0d3f95ee013b", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "long", | |
| "type": [ | |
| "long" | |
| ] | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "id", | |
| "order": 2147483647, | |
| "required": "false", | |
| "supportedversions": null | |
| }, | |
| { | |
| "allowedvalues": [], | |
| "description": "Name and surname of the author", | |
| "displayedFormat": "may not be empty, length must be between 5 and 20", | |
| "format": [ | |
| "may not be empty", | |
| "length must be between 5 and 20" | |
| ], | |
| "jsondocId": "0dda6695-d213-4f7f-94f8-37bf1cd25423", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "string", | |
| "type": [ | |
| "string" | |
| ] | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "name", | |
| "order": 2147483647, | |
| "required": "true", | |
| "supportedversions": null | |
| } | |
| ], | |
| "group": "Library", | |
| "jsondocId": "0af115d8-9a34-4577-b771-2866c89e23fe", | |
| "jsondocTemplate": { | |
| "books": [], | |
| "id": 0, | |
| "name": "" | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [ | |
| "Add description to field: books", | |
| "Add description to field: id" | |
| ], | |
| "jsondocwarnings": [], | |
| "name": "Author", | |
| "show": true, | |
| "stage": "UNDEFINED", | |
| "supportedversions": null, | |
| "visibility": "UNDEFINED" | |
| }, | |
| { | |
| "allowedvalues": [], | |
| "description": "Represents a book. Every book has an <code>Author</code> and a price.", | |
| "fields": [ | |
| { | |
| "allowedvalues": [], | |
| "description": "The book's author", | |
| "displayedFormat": "", | |
| "format": [], | |
| "jsondocId": "2c1dfa69-cf50-4aa8-9c10-784d311bbf25", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "Author", | |
| "type": [ | |
| "Author" | |
| ] | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "author", | |
| "order": 1, | |
| "required": "false", | |
| "supportedversions": null | |
| }, | |
| { | |
| "allowedvalues": [], | |
| "description": "The book's title", | |
| "displayedFormat": "", | |
| "format": [], | |
| "jsondocId": "1fc44ef2-e6cf-4f41-8cd6-16c7dc3aafec", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "string", | |
| "type": [ | |
| "string" | |
| ] | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "title", | |
| "order": 2, | |
| "required": "false", | |
| "supportedversions": null | |
| }, | |
| { | |
| "allowedvalues": [], | |
| "description": "The book's ID", | |
| "displayedFormat": "", | |
| "format": [], | |
| "jsondocId": "72f3654d-73b7-4026-bc0f-e48ae8aa22da", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "long", | |
| "type": [ | |
| "long" | |
| ] | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "id", | |
| "order": 4, | |
| "required": "false", | |
| "supportedversions": null | |
| }, | |
| { | |
| "allowedvalues": [], | |
| "description": "The price of the book", | |
| "displayedFormat": "Must be a double", | |
| "format": [ | |
| "Must be a double" | |
| ], | |
| "jsondocId": "20579ebd-e924-45dc-8070-27dbd5f890bd", | |
| "jsondocType": { | |
| "mapKey": null, | |
| "mapValue": null, | |
| "oneLineText": "double", | |
| "type": [ | |
| "double" | |
| ] | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "price", | |
| "order": 2147483647, | |
| "required": "true", | |
| "supportedversions": null | |
| } | |
| ], | |
| "group": "Library", | |
| "jsondocId": "097d5547-a08f-40c1-b9b3-b175b6653df7", | |
| "jsondocTemplate": { | |
| "author": { | |
| "books": [], | |
| "id": 0, | |
| "name": "" | |
| }, | |
| "id": 0, | |
| "price": 0, | |
| "title": "" | |
| }, | |
| "jsondocerrors": [], | |
| "jsondochints": [], | |
| "jsondocwarnings": [], | |
| "name": "Book", | |
| "show": true, | |
| "stage": "UNDEFINED", | |
| "supportedversions": null, | |
| "visibility": "UNDEFINED" | |
| } | |
| ] | |
| }, | |
| "playgroundEnabled": true, | |
| "version": "1.0" | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment