{ "uuid": "415c6dde-46f9-4cf8-ad30-af83c09a9fa7", "lastMigration": 29, "name": "API Endpoints", "endpointPrefix": "api/v1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "e4f9b27d-64a5-4042-8276-25d4544577a3", "documentation": "Get metadata about the current project", "method": "get", "endpoint": "", "responses": [ { "uuid": "a443f835-8318-48bb-8ab1-f4c0d7047f68", "body": "", "latency": 0, "statusCode": 200, "label": "Project data", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6041b45a-5f47-4374-8b0f-e9840e6900cd", "documentation": "Get API specification metadata", "method": "get", "endpoint": "api-specification", "responses": [ { "uuid": "0859bc5d-eaca-44d6-9e6d-d4cf505bbf49", "body": "", "latency": 0, "statusCode": 200, "label": "Successfully retrieved API specification metadata.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Link", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c8510a6c-3eba-45a1-9202-29b221e9714a", "documentation": "Upload an API specification to ReadMe. Or, to use a newer solution see https://docs.readme.com/guides/docs/automatically-sync-api-specification-with-github", "method": "post", "endpoint": "api-specification", "responses": [ { "uuid": "4cad8de5-0791-4c5a-a67b-0d96c0bcc599", "body": "", "latency": 0, "statusCode": 201, "label": "The API specification successfully imported", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e5a5b715-dc4c-48f7-8bf8-5eb593789ce2", "body": "", "latency": 0, "statusCode": 400, "label": "There was a validation error during import", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a14c99fc-103d-4da4-a982-1e5287be881a", "documentation": "Delete an API specification in ReadMe", "method": "delete", "endpoint": "api-specification/:id", "responses": [ { "uuid": "e3d739ab-6863-47cd-95bc-f19f819be44d", "body": "", "latency": 0, "statusCode": 204, "label": "The API specification was deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "199a8010-4d39-4c95-8c41-1f823cf19d87", "body": "", "latency": 0, "statusCode": 404, "label": "There is no API specification with that ID", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1c2f80ee-d37f-46a7-be41-b9457710656a", "documentation": "Update an API specification in ReadMe", "method": "put", "endpoint": "api-specification/:id", "responses": [ { "uuid": "8e52ee9f-ed81-4090-8df5-914d34ae191a", "body": "", "latency": 0, "statusCode": 200, "label": "The API specification was updated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "123b67a9-ed11-4ac8-9074-d90522ea65eb", "body": "", "latency": 0, "statusCode": 400, "label": "There was a validation error during import", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1a89cbaa-3b2f-44df-b2a5-3f39532f9d23", "body": "", "latency": 0, "statusCode": 404, "label": "There is no API specification with that ID", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bcfb73f8-6ab1-48d9-813f-85ca6fb28829", "documentation": "Get category", "method": "get", "endpoint": "categories/:slug", "responses": [ { "uuid": "f85164ea-4a26-4cea-878b-c052323256e9", "body": "", "latency": 0, "statusCode": 200, "label": "The category exists and has been returned", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "78f484d8-2d04-4b55-8ec9-0452cb3d582e", "body": "", "latency": 0, "statusCode": 404, "label": "There is no category with that slug", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "40fab9d0-16f9-494a-a8fd-2d04898008d7", "documentation": "Get docs for category", "method": "get", "endpoint": "categories/:slug/docs", "responses": [ { "uuid": "3a1f471a-4a38-4d12-9481-e76d9a4af7e2", "body": "", "latency": 0, "statusCode": 200, "label": "The category exists and all of the docs have been returned", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8eb32409-b690-40b0-9d8d-0f24dd70bb5c", "body": "", "latency": 0, "statusCode": 404, "label": "There is no category with that slug", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5021647b-b076-4b3d-af7c-a684224b8258", "documentation": "Get changelogs", "method": "get", "endpoint": "changelogs", "responses": [ { "uuid": "b5b100eb-7088-44fa-9020-8159071c31da", "body": "", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Link", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b01ca877-213a-4acd-8121-6fdba470c8db", "documentation": "Create changelog", "method": "post", "endpoint": "changelogs", "responses": [ { "uuid": "9fab567f-fde0-4985-86e2-1047ed27e8c3", "body": "", "latency": 0, "statusCode": 201, "label": "The changelog has successfully been created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "879c2413-fa95-45c6-ac29-5fbbf5de9e9c", "body": "", "latency": 0, "statusCode": 400, "label": "There was a validation error during creation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "88076af9-d083-4b41-b806-134209e9ca45", "documentation": "Delete changelog", "method": "delete", "endpoint": "changelogs/:slug", "responses": [ { "uuid": "f874dc6f-358b-4052-a5b1-bfc25a76f875", "body": "", "latency": 0, "statusCode": 204, "label": "The changelog has successfully been updated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0aec1403-656f-4122-a0f8-79d6b95e2c20", "body": "", "latency": 0, "statusCode": 404, "label": "There is no changelog with that slug", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b1645fe6-251d-43c3-b924-47f58867f318", "documentation": "Get changelog", "method": "get", "endpoint": "changelogs/:slug", "responses": [ { "uuid": "f39dd06b-424e-4a4f-ad3b-07e2bd6f69c5", "body": "", "latency": 0, "statusCode": 200, "label": "The changelog exists and has been returned", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "615eded6-6bb8-4e9f-b17c-eb97de06d7f9", "body": "", "latency": 0, "statusCode": 404, "label": "There is no changelog with that slug", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a9602716-f972-4042-9e44-f2cb14366708", "documentation": "Update changelog", "method": "put", "endpoint": "changelogs/:slug", "responses": [ { "uuid": "710acb39-8b2d-49b8-8264-922b931b9b05", "body": "", "latency": 0, "statusCode": 200, "label": "The changelog has successfully been updated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8559e302-877c-4bf0-b8fe-1debb82e9c08", "body": "", "latency": 0, "statusCode": 400, "label": "There was a validation error during update", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8ddea4d0-f9ec-4963-834f-b0752f8e1cbd", "body": "", "latency": 0, "statusCode": 404, "label": "There is no changelog with that slug", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e3965e29-4dc8-4ba4-a57b-3ad734565ce7", "documentation": "Get custom pages", "method": "get", "endpoint": "custompages", "responses": [ { "uuid": "8b031c83-b1ce-4d4f-9084-80d9c0107325", "body": "", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Link", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "70eae1a6-6152-48d7-9bb5-d14dfbb337d0", "documentation": "Create custom page", "method": "post", "endpoint": "custompages", "responses": [ { "uuid": "19c64c5a-8097-4ec8-b4df-2bbe2d55c9f9", "body": "", "latency": 0, "statusCode": 201, "label": "The custom page has successfully been created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4332c640-b58e-4ae8-9470-a99278c5e72b", "body": "", "latency": 0, "statusCode": 400, "label": "There was a validation error during creation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7a294317-454e-427c-8984-0ba6ac7a0d91", "documentation": "Delete custom page", "method": "delete", "endpoint": "custompages/:slug", "responses": [ { "uuid": "8ee6c750-fcf8-479a-84d5-6fa313a8a4f1", "body": "", "latency": 0, "statusCode": 204, "label": "The custom page has successfully been updated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f9cdbe30-c4d3-4a20-bc4d-4f9deb5c1a0e", "body": "", "latency": 0, "statusCode": 404, "label": "There is no custom page with that slug", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "826feaea-048b-403a-be43-0a015a65c7a9", "documentation": "Get custom page", "method": "get", "endpoint": "custompages/:slug", "responses": [ { "uuid": "33c81237-1aac-440e-b285-e4ac9843475f", "body": "", "latency": 0, "statusCode": 200, "label": "The custom page exists and has been returned", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bd12002a-b92c-4e8a-a993-3d6dd720da32", "body": "", "latency": 0, "statusCode": 404, "label": "There is no custom page with that slug", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "027ce4a6-8592-420d-8900-0b13b043bb25", "documentation": "Update custom page", "method": "put", "endpoint": "custompages/:slug", "responses": [ { "uuid": "40f2085c-fc1c-4fd5-9f76-0fe654984018", "body": "", "latency": 0, "statusCode": 200, "label": "The custom page has successfully been updated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "11380a02-e066-4b8b-a1a2-70bdf44e221c", "body": "", "latency": 0, "statusCode": 400, "label": "There was a validation error during update", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6d5590b8-70b2-4790-ba70-9d00b40b1b8a", "body": "", "latency": 0, "statusCode": 404, "label": "There is no custom page with that slug", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "df937f80-add7-4905-aca1-bde9cf0a63ba", "documentation": "Create doc", "method": "post", "endpoint": "docs", "responses": [ { "uuid": "30fc09d6-9417-4fc3-95b0-0f3e12b5b2fa", "body": "", "latency": 0, "statusCode": 201, "label": "The doc has successfully been created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a0e44d5a-a803-413e-b2a4-4545505ecdab", "body": "", "latency": 0, "statusCode": 400, "label": "There was a validation error during creation", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "251de0f5-dad7-43bb-ba32-c057ec49bb07", "documentation": "Search docs", "method": "post", "endpoint": "docs/search", "responses": [ { "uuid": "67167280-606a-4d08-ba7e-a52ba1c366d3", "body": "", "latency": 0, "statusCode": 200, "label": "The search was successful and results were returned", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "03ef994d-0062-4a62-9515-c85d4fe42a47", "body": "", "latency": 0, "statusCode": 500, "label": "There is an internal error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3c2afd18-8aa9-43f4-abf8-007c9ce4acb7", "documentation": "Delete doc", "method": "delete", "endpoint": "docs/:slug", "responses": [ { "uuid": "d1cfa5e8-9dae-4262-9adb-303fa8e13ae3", "body": "", "latency": 0, "statusCode": 204, "label": "The doc has successfully been updated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "12a0e33e-bc82-4404-8c05-b490a3060654", "body": "", "latency": 0, "statusCode": 404, "label": "There is no doc with that slug", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "738b29c8-373f-4c58-9ce3-37d51fdc2e87", "documentation": "Get doc", "method": "get", "endpoint": "docs/:slug", "responses": [ { "uuid": "97fa8e90-7766-4e6d-9a4f-651c58a08f6e", "body": "", "latency": 0, "statusCode": 200, "label": "The doc exists and has been returned", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fce42410-2198-40c8-a70c-d35730f7404c", "body": "", "latency": 0, "statusCode": 404, "label": "There is no doc with that slug", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9138a173-0352-4ccc-b927-5d6a5836db40", "documentation": "Update doc", "method": "put", "endpoint": "docs/:slug", "responses": [ { "uuid": "97580191-ab7b-4e61-8476-b6cbae3da0ec", "body": "", "latency": 0, "statusCode": 200, "label": "The doc has successfully been updated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d4af84cb-6094-4ac2-928d-1fc6645d4515", "body": "", "latency": 0, "statusCode": 400, "label": "There was a validation error during update", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7306796c-1fd5-46b0-8f84-3e15b4420641", "body": "", "latency": 0, "statusCode": 404, "label": "There is no doc with that slug", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0edbb111-927f-47f4-bea9-63e402e5a818", "documentation": "Get errors", "method": "get", "endpoint": "errors", "responses": [ { "uuid": "2c87b77c-670e-4c11-b69d-3aef3904fd8e", "body": "", "latency": 0, "statusCode": 200, "label": "An array of the errors", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5f2f9abb-1334-444a-ae6b-3a75f3186dee", "documentation": "DEPRECATED. Instead use https://docs.readme.com/developers/reference/api-specification#uploadapispecification to upload a Swagger file to ReadMe", "method": "post", "endpoint": "swagger", "responses": [ { "uuid": "31d767a4-4edb-4ab5-ad7e-9d694ce6aacb", "body": "", "latency": 0, "statusCode": 201, "label": "The Swagger file was successfully imported", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b6a07e66-e595-40a8-a6dc-7a633f8d40be", "body": "", "latency": 0, "statusCode": 400, "label": "There was a validation error during import", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "824c659b-8b3b-4ce3-a700-64edc45d01e5", "documentation": "DEPRECATED. Instead, use https://docs.readme.com/developers/reference/api-specification#deleteapispecification to delete a Swagger file in ReadMe", "method": "delete", "endpoint": "swagger/:id", "responses": [ { "uuid": "c9fb7435-e346-4088-8e2e-e0df570a2ba0", "body": "", "latency": 0, "statusCode": 204, "label": "The Swagger file was successfully deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bffcb670-fcc2-49df-9daf-d6b6d649deb5", "body": "", "latency": 0, "statusCode": 404, "label": "There is no Swagger file with that ID", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "996dfe91-2c18-41bd-a04c-81b756034893", "documentation": "DEPRECATED. Instead, use https://docs.readme.com/developers/reference/api-specification#updateapispecification to update a Swagger file.", "method": "put", "endpoint": "swagger/:id", "responses": [ { "uuid": "610b39d8-a303-430f-90fc-f58da0fa35e3", "body": "", "latency": 0, "statusCode": 200, "label": "The Swagger file was successfully updated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7aab7ca1-b430-4b31-b735-d91350b786e4", "body": "", "latency": 0, "statusCode": 400, "label": "There was a validation error during import", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "eeb60201-7c52-4a81-8364-87f5e45a8f44", "body": "", "latency": 0, "statusCode": 404, "label": "There is no Swagger file with that ID", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9c14fd78-db7e-42a7-804e-78b03906c932", "documentation": "Get versions", "method": "get", "endpoint": "version", "responses": [ { "uuid": "e986d1fa-c794-430d-b7df-b412950ac35f", "body": "", "latency": 0, "statusCode": 200, "label": "JSON list of versions", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b36a2493-d682-4a5c-bf7d-f831bf1e2961", "documentation": "Create version", "method": "post", "endpoint": "version", "responses": [ { "uuid": "963f4bb1-afb5-4ff4-a34d-9b3318b12856", "body": "", "latency": 0, "statusCode": 200, "label": "The model was successfully created and associated with the target project", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e23e3582-2392-46fe-9f3b-545ae751e156", "body": "", "latency": 0, "statusCode": 400, "label": "That version already exists in the project, or there are validation errors with the request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "019d8891-f131-45ff-873b-ae46afb87289", "body": "", "latency": 0, "statusCode": 404, "label": "Could not find target fork in database", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6975982e-dd20-4b79-94db-41767d8f89a8", "documentation": "Delete version", "method": "delete", "endpoint": "version/:versionId", "responses": [ { "uuid": "1c4616b2-8984-434d-9689-fcc763e0a393", "body": "", "latency": 0, "statusCode": 200, "label": "The target version was successfully deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "283f57d1-61d4-404d-b555-1f3e8c2e0243", "body": "", "latency": 0, "statusCode": 400, "label": "Cannot delete the main version for a project", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "97b877a0-8092-4146-958c-eae511384e07", "body": "", "latency": 0, "statusCode": 404, "label": "Could not find target version in database", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7ccc9e73-38fb-4668-b221-d52b280eca81", "documentation": "Get version", "method": "get", "endpoint": "version/:versionId", "responses": [ { "uuid": "42cf3c26-4187-49ab-9a52-2c627cba9748", "body": "", "latency": 0, "statusCode": 200, "label": "JSON version model", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "778af234-9ab9-48c4-bc3f-13ec8ca9c3bc", "body": "", "latency": 0, "statusCode": 404, "label": "Could not find target version in database", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9ae62084-0084-436e-a05a-4800ef0092d5", "documentation": "Update version", "method": "put", "endpoint": "version/:versionId", "responses": [ { "uuid": "53a488bb-8866-4c5e-b29e-7d64ef918519", "body": "", "latency": 0, "statusCode": 200, "label": "The target version was successfully updated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bc56ca88-7bad-45ca-b8d5-75c063ed6dbc", "body": "", "latency": 0, "statusCode": 400, "label": "Cannot demote a version through update", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6add45f9-e1cf-4c77-b2dd-5954d60a5f51", "body": "", "latency": 0, "statusCode": 404, "label": "Could not find target version in database", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "e4f9b27d-64a5-4042-8276-25d4544577a3" }, { "type": "route", "uuid": "6041b45a-5f47-4374-8b0f-e9840e6900cd" }, { "type": "route", "uuid": "c8510a6c-3eba-45a1-9202-29b221e9714a" }, { "type": "route", "uuid": "a14c99fc-103d-4da4-a982-1e5287be881a" }, { "type": "route", "uuid": "1c2f80ee-d37f-46a7-be41-b9457710656a" }, { "type": "route", "uuid": "bcfb73f8-6ab1-48d9-813f-85ca6fb28829" }, { "type": "route", "uuid": "40fab9d0-16f9-494a-a8fd-2d04898008d7" }, { "type": "route", "uuid": "5021647b-b076-4b3d-af7c-a684224b8258" }, { "type": "route", "uuid": "b01ca877-213a-4acd-8121-6fdba470c8db" }, { "type": "route", "uuid": "88076af9-d083-4b41-b806-134209e9ca45" }, { "type": "route", "uuid": "b1645fe6-251d-43c3-b924-47f58867f318" }, { "type": "route", "uuid": "a9602716-f972-4042-9e44-f2cb14366708" }, { "type": "route", "uuid": "e3965e29-4dc8-4ba4-a57b-3ad734565ce7" }, { "type": "route", "uuid": "70eae1a6-6152-48d7-9bb5-d14dfbb337d0" }, { "type": "route", "uuid": "7a294317-454e-427c-8984-0ba6ac7a0d91" }, { "type": "route", "uuid": "826feaea-048b-403a-be43-0a015a65c7a9" }, { "type": "route", "uuid": "027ce4a6-8592-420d-8900-0b13b043bb25" }, { "type": "route", "uuid": "df937f80-add7-4905-aca1-bde9cf0a63ba" }, { "type": "route", "uuid": "251de0f5-dad7-43bb-ba32-c057ec49bb07" }, { "type": "route", "uuid": "3c2afd18-8aa9-43f4-abf8-007c9ce4acb7" }, { "type": "route", "uuid": "738b29c8-373f-4c58-9ce3-37d51fdc2e87" }, { "type": "route", "uuid": "9138a173-0352-4ccc-b927-5d6a5836db40" }, { "type": "route", "uuid": "0edbb111-927f-47f4-bea9-63e402e5a818" }, { "type": "route", "uuid": "5f2f9abb-1334-444a-ae6b-3a75f3186dee" }, { "type": "route", "uuid": "824c659b-8b3b-4ce3-a700-64edc45d01e5" }, { "type": "route", "uuid": "996dfe91-2c18-41bd-a04c-81b756034893" }, { "type": "route", "uuid": "9c14fd78-db7e-42a7-804e-78b03906c932" }, { "type": "route", "uuid": "b36a2493-d682-4a5c-bf7d-f831bf1e2961" }, { "type": "route", "uuid": "6975982e-dd20-4b79-94db-41767d8f89a8" }, { "type": "route", "uuid": "7ccc9e73-38fb-4668-b221-d52b280eca81" }, { "type": "route", "uuid": "9ae62084-0084-436e-a05a-4800ef0092d5" } ] }