docs.html

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>apiary</title>
</head>
<body>
  <script src="https://api.apiary.io/seeds/embed.js"></script>
  <script>
    var embed = new Apiary.Embed({
      apiBlueprint: "FORMAT: 1A\n# XcodeServer API Docs\nThis API documentation attempts to describe the Xcode Server API (Xcode 7 version).\nExample Bot fetch request to an Xcode Server running at `192.168.1.64` would be `GET https://192.168.1.64:20343/api/bots`.\nFor real world examples of how most of the following APIs are used, see [XcodeServerSDK](https://github.com/czechboy0/XcodeServerSDK).\n\nCreated by [@czechboy0](https://twitter.com/czechboy0).\n\n# Group Bots\nBot (one build job description). A bot is the logic which pulls your code and builds it based on its configuration.\n\n# Bots [/bots]\n\n## Create a new Bot [POST]\n\n+ Request (application/json)\n\n        {\n            \"group\": {\n                \"name\": \"E4F21264-9C46-4B10-8613-244E48958233\"\n            },\n            \"configuration\": {\n                \"builtFromClean\": 0,\n                \"periodicScheduleInterval\": 1,\n                \"codeCoveragePreference\": 2,\n                \"performsTestAction\": true,\n                \"triggers\": [\n                    {\n                        \"phase\": 1,\n                        \"scriptBody\": \"echo \\\"Run before\\\"\\ncarthage update --no-build\",\n                        \"type\": 1,\n                        \"name\": \"Run Script\"\n                    }\n                ],\n                \"performsAnalyzeAction\": true,\n                \"schemeName\": \"XcodeServerSDK - iOS\",\n                \"exportsProductFromArchive\": true,\n                \"testingDeviceIDs\": [],\n                \"deviceSpecification\": {\n                    \"filters\": [\n                        {\n                            \"platform\": {\n                                \"_id\": \"a85553a5b26a7c1a4998f3b237000da9\",\n                                \"displayName\": \"iOS\",\n                                \"_rev\": \"12-162b2b9d57b73b66724426eea53bfcaf\",\n                                \"simulatorIdentifier\": \"com.apple.platform.iphonesimulator\",\n                                \"identifier\": \"com.apple.platform.iphoneos\",\n                                \"buildNumber\": \"13A4280e\",\n                                \"version\": \"9.0\"\n                            },\n                            \"filterType\": 3,\n                            \"architectureType\": 0\n                        }\n                    ],\n                    \"deviceIdentifiers\": [\n                        \"ad2fac04895bd1bb06c1d50e3409698b\",\n                        \"ad2fac04895bd1bb06c1d50e34007e54\"\n                    ]\n                },\n                \"weeklyScheduleDay\": 0,\n                \"minutesAfterHourToIntegrate\": 0,\n                \"scheduleType\": 1,\n                \"hourOfIntegration\": 0,\n                \"performsArchiveAction\": true,\n                \"sourceControlBlueprint\": {\n                    \"DVTSourceControlWorkspaceBlueprintLocationsKey\": {\n                        \"A36AEFA3F9FF1F738E92F0C497C14977DCE02B97\": {\n                            \"DVTSourceControlBranchIdentifierKey\": \"hd/tested_devices_xcode_7\",\n                            \"DVTSourceControlBranchOptionsKey\": 156,\n                            \"DVTSourceControlWorkspaceBlueprintLocationTypeKey\": \"DVTSourceControlBranch\"\n                        }\n                    },\n                    \"DVTSourceControlWorkspaceBlueprintPrimaryRemoteRepositoryKey\": \"A36AEFA3F9FF1F738E92F0C497C14977DCE02B97\",\n                    \"DVTSourceControlWorkspaceBlueprintRemoteRepositoryAuthenticationStrategiesKey\": {\n                        \"A36AEFA3F9FF1F738E92F0C497C14977DCE02B97\": {\n                            \"DVTSourceControlWorkspaceBlueprintRemoteRepositoryUsernameKey\": \"git\",\n                            \"DVTSourceControlWorkspaceBlueprintRemoteRepositoryAuthenticationStrategiesKey\": \"BASE_64_ENCODED_PRIVATE_KEY\",\n                            \"DVTSourceControlWorkspaceBlueprintRemoteRepositoryAuthenticationTypeKey\": \"DVTSourceControlSSHKeysAuthenticationStrategy\",\n                            \"DVTSourceControlWorkspaceBlueprintRemoteRepositoryPublicKeyDataKey\": \"BASE_64_ENCODED_PUBLIC_KEY\",\n                            \"DVTSourceControlWorkspaceBlueprintRemoteRepositoryPasswordKey\": \"YOUR_SSH_KEYPHRASE_OR_EMPTY\"\n                        }\n                    },\n                    \"DVTSourceControlWorkspaceBlueprintWorkingCopyStatesKey\": {\n                        \"A36AEFA3F9FF1F738E92F0C497C14977DCE02B97\": 0\n                    },\n                    \"DVTSourceControlWorkspaceBlueprintIdentifierKey\": \"B67842EF-128D-4AB7-A3C7-7E560085550A\",\n                    \"DVTSourceControlWorkspaceBlueprintWorkingCopyPathsKey\": {\n                        \"A36AEFA3F9FF1F738E92F0C497C14977DCE02B97\": \"XcodeServerSDK/\"\n                    },\n                    \"DVTSourceControlWorkspaceBlueprintNameKey\": \"XcodeServerSDK\",\n                    \"DVTSourceControlWorkspaceBlueprintVersion\": 203,\n                    \"DVTSourceControlWorkspaceBlueprintRelativePathToProjectKey\": \"XcodeServerSDK.xcworkspace\",\n                    \"DVTSourceControlWorkspaceBlueprintRemoteRepositoriesKey\": [\n                        {\n                            \"DVTSourceControlWorkspaceBlueprintRemoteRepositorySystemKey\": \"com.apple.dt.Xcode.sourcecontrol.Git\",\n                            \"DVTSourceControlWorkspaceBlueprintRemoteRepositoryURLKey\": \"git@github.com:czechboy0/XcodeServerSDK.git\",\n                            \"DVTSourceControlWorkspaceBlueprintRemoteRepositoryTrustedCertFingerprintKey\": \"1627ACA576282D36631B564DEBDFA648\",\n                            \"DVTSourceControlWorkspaceBlueprintRemoteRepositoryIdentifierKey\": \"A36AEFA3F9FF1F738E92F0C497C14977DCE02B97\",\n                            \"DVTSourceControlWorkspaceBlueprintRemoteRepositoryTrustSelfSignedCertKey\": true\n                        }\n                    ]\n                },\n                \"testingDestinationType\": 0\n            },\n            \"requiresUpgrade\": false,\n            \"name\": \"My first iOS Bot\",\n            \"type\": 1\n        }\n\n+ Response 201\n\n    [Bot][]\n\n## List all Bots [GET]\n\n+ Response 200\n        \n        [\n            [Bot][],\n            [Bot][],\n            ...\n        ]\n        \n## Delete all Bots [DELETE]\n\n+ Response 204\n\n# Bot [/bots/{id}]\n\n+ Model (application/json)\n\n        {\n            \"_id\": \"963bc95f1c1a56f69f3392b4aa03302f\",\n            \"tinyID\": \"4807518\",\n            \"_rev\": \"10-117b73f201ea103229a2e8cd26a01845\",\n            \"requiresUpgrade\": false,\n            \"integration_counter\": 4,\n            \"lastRevisionBlueprint\": {\n                \"DVTSourceControlWorkspaceBlueprintLocationsKey\": {\n                    \"A36AEFA3F9FF1F738E92F0C497C14977DCE02B97\": {\n                        \"DVTSourceControlBranchIdentifierKey\": \"hd/tested_devices_xcode_7\",\n                        \"DVTSourceControlLocationRevisionKey\": \"f33492a458777330edcac4c77adbb18d3ba7f1f8\",\n                        \"DVTSourceControlBranchOptionsKey\": 50,\n                        \"DVTSourceControlWorkspaceBlueprintLocationTypeKey\": \"DVTSourceControlBranch\"\n                    }\n                },\n                \"DVTSourceControlWorkspaceBlueprintPrimaryRemoteRepositoryKey\": \"A36AEFA3F9FF1F738E92F0C497C14977DCE02B97\",\n                \"DVTSourceControlWorkspaceBlueprintIdentifierKey\": \"71FFDDA2-4586-4EE9-AEF2-C798E9E45028\",\n                \"DVTSourceControlWorkspaceBlueprintWorkingCopyPathsKey\": {\n                    \"A36AEFA3F9FF1F738E92F0C497C14977DCE02B97\": \"XcodeServerSDK/\"\n                },\n                \"DVTSourceControlWorkspaceBlueprintNameKey\": \"XcodeServerSDK\",\n                \"DVTSourceControlWorkspaceBlueprintVersion\": 203,\n                \"DVTSourceControlWorkspaceBlueprintRelativePathToProjectKey\": \"XcodeServerSDK.xcworkspace\",\n                \"DVTSourceControlWorkspaceBlueprintRemoteRepositoriesKey\": [\n                    {\n                        \"DVTSourceControlWorkspaceBlueprintRemoteRepositorySystemKey\": \"com.apple.dt.Xcode.sourcecontrol.Git\",\n                        \"DVTSourceControlWorkspaceBlueprintRemoteRepositoryURLKey\": \"github.com:czechboy0/XcodeServerSDK.git\",\n                        \"DVTSourceControlWorkspaceBlueprintRemoteRepositoryIdentifierKey\": \"A36AEFA3F9FF1F738E92F0C497C14977DCE02B97\"\n                    }\n                ]\n            },\n            \"configuration\": {\n                \"builtFromClean\": 0,\n                \"periodicScheduleInterval\": 1,\n                \"codeCoveragePreference\": 2,\n                \"performsTestAction\": true,\n                \"triggers\": [\n                    {\n                        \"phase\": 1,\n                        \"scriptBody\": \"echo \\\"Run before\\\"\\ncarthage update --no-build\",\n                        \"type\": 1,\n                        \"name\": \"Run Script\"\n                    },\n                    {\n                        \"phase\": 2,\n                        \"scriptBody\": \"echo \\\"Run after\\\"\",\n                        \"type\": 1,\n                        \"name\": \"Run Script\",\n                        \"conditions\": {\n                            \"status\": 2,\n                            \"onWarnings\": true,\n                            \"onBuildErrors\": true,\n                            \"onInternalErrors\": true,\n                            \"onAnalyzerWarnings\": true,\n                            \"onFailingTests\": true,\n                            \"onSuccess\": true\n                        }\n                    },\n                    {\n                        \"phase\": 2,\n                        \"scriptBody\": \"\",\n                        \"emailConfiguration\": {\n                            \"includeCommitMessages\": true,\n                            \"additionalRecipients\": [\n                                \"email@committers.yo\"\n                            ],\n                            \"emailCommitters\": true,\n                            \"scmOptions\": {\n                                \"A36AEFA3F9FF1F738E92F0C497C14977DCE02B97\": true\n                            },\n                            \"includeIssueDetails\": true\n                        },\n                        \"type\": 2,\n                        \"name\": \"Send Email Notification\",\n                        \"conditions\": {\n                            \"status\": 2,\n                            \"onWarnings\": true,\n                            \"onBuildErrors\": true,\n                            \"onInternalErrors\": true,\n                            \"onAnalyzerWarnings\": true,\n                            \"onFailingTests\": true,\n                            \"onSuccess\": false\n                        }\n                    }\n                ],\n                \"performsAnalyzeAction\": true,\n                \"schemeName\": \"XcodeServerSDK - OS X\",\n                \"exportsProductFromArchive\": true,\n                \"testingDeviceIDs\": [],\n                \"deviceSpecification\": {\n                    \"filters\": [\n                        {\n                            \"platform\": {\n                                \"_id\": \"ad2fac04895bd1bb06c1d50e34001e3c\", \n                                \"_rev\": \"7-3a38313ad698143c5e407fa65769166b\", \n                                \"buildNumber\": \"13A4305g\", \n                                \"displayName\": \"iOS\", \n                                \"doc_type\": \"platform\", \n                                \"identifier\": \"com.apple.platform.iphoneos\", \n                                \"simulatorIdentifier\": \"com.apple.platform.iphonesimulator\", \n                                \"tinyID\": \"20FAFAB\", \n                                \"version\": \"9.0\"\n                            },\n                            \"filterType\": 3,\n                            \"architectureType\": 0\n                        }\n                    ],\n                    \"deviceIdentifiers\": [\n                        \"ad2fac04895bd1bb06c1d50e3409698b\",\n                        \"ad2fac04895bd1bb06c1d50e34007e54\"\n                    ]\n                },\n                \"weeklyScheduleDay\": 0,\n                \"minutesAfterHourToIntegrate\": 0,\n                \"scheduleType\": 1,\n                \"hourOfIntegration\": 0,\n                \"performsArchiveAction\": true,\n                \"sourceControlBlueprint\": {\n                    \"DVTSourceControlWorkspaceBlueprintLocationsKey\": {\n                        \"A36AEFA3F9FF1F738E92F0C497C14977DCE02B97\": {\n                            \"DVTSourceControlBranchIdentifierKey\": \"hd/tested_devices_xcode_7\",\n                            \"DVTSourceControlBranchOptionsKey\": 214,\n                            \"DVTSourceControlWorkspaceBlueprintLocationTypeKey\": \"DVTSourceControlBranch\"\n                        }\n                    },\n                    \"DVTSourceControlWorkspaceBlueprintPrimaryRemoteRepositoryKey\": \"A36AEFA3F9FF1F738E92F0C497C14977DCE02B97\",\n                    \"DVTSourceControlWorkspaceBlueprintWorkingCopyRepositoryLocationsKey\": {},\n                    \"DVTSourceControlWorkspaceBlueprintRemoteRepositoryAuthenticationStrategiesKey\": {\n                        \"A36AEFA3F9FF1F738E92F0C497C14977DCE02B97\": {\n                            \"DVTSourceControlWorkspaceBlueprintRemoteRepositoryAuthenticationTypeKey\": \"DVTSourceControlAuthenticationStrategy\"\n                        }\n                    },\n                    \"DVTSourceControlWorkspaceBlueprintWorkingCopyStatesKey\": {\n                        \"A36AEFA3F9FF1F738E92F0C497C14977DCE02B97\": 0\n                    },\n                    \"DVTSourceControlWorkspaceBlueprintIdentifierKey\": \"92561A51-010F-495B-8ED4-93087A6A8F5B\",\n                    \"DVTSourceControlWorkspaceBlueprintWorkingCopyPathsKey\": {\n                        \"A36AEFA3F9FF1F738E92F0C497C14977DCE02B97\": \"XcodeServerSDK/\"\n                    },\n                    \"DVTSourceControlWorkspaceBlueprintNameKey\": \"XcodeServerSDK\",\n                    \"DVTSourceControlWorkspaceBlueprintVersion\": 203,\n                    \"DVTSourceControlWorkspaceBlueprintRelativePathToProjectKey\": \"XcodeServerSDK.xcworkspace\",\n                    \"DVTSourceControlWorkspaceBlueprintRemoteRepositoriesKey\": [\n                        {\n                            \"DVTSourceControlWorkspaceBlueprintRemoteRepositoryTrustSelfSignedCertKey\": true,\n                            \"DVTSourceControlWorkspaceBlueprintRemoteRepositoryURLKey\": \"github.com:czechboy0/XcodeServerSDK.git\",\n                            \"DVTSourceControlWorkspaceBlueprintRemoteRepositorySystemKey\": \"com.apple.dt.Xcode.sourcecontrol.Git\",\n                            \"DVTSourceControlWorkspaceBlueprintRemoteRepositoryTrustedCertFingerprintKey\": \"1627ACA576282D36631B564DEBDFA648\",\n                            \"DVTSourceControlWorkspaceBlueprintRemoteRepositoryIdentifierKey\": \"A36AEFA3F9FF1F738E92F0C497C14977DCE02B97\"\n                        }\n                    ]\n                },\n                \"testingDestinationType\": 0\n            },\n            \"group\": {\n                \"name\": \"2FDD3BEB-D750-47EE-B386-07EA9BABA98B\"\n            },\n            \"type\": 1,\n            \"name\": \"My First iOS Bot\",\n            \"doc_type\": \"bot\"\n        }\n\n## Get a specific Bot [GET]\n    \n+ Parameters\n    + id (required, string) - Id of the specific Bot\n\n+ Response 200\n\n    [Bot][]\n\n## Edit a Bot [PATCH /bots/{id}{?overwriteBlueprint}]\n\n+ Parameters\n    + id (required, string) - Id of the specific Bot\n    + overwriteBlueprint (bool, required) - Send true when overwriting bot settings.\n\n+ Request (application/json)\n\n        {\n            \"TODO\": \"to be documented\"\n        }\n\n+ Response 204\n\n## Delete a Bot [DELETE /bots/{id}]\n\n+ Parameters\n    + id (required, string) - Id of the specific Bot\n\n+ Response 204\n\n## Bot stats [GET /bots/{id}/stats]\n\n+ Parameters\n    + id (required, string) - Id of the specific Bot\n\n+ Response 200 (application/json)\n\n        {\n            \"analysisWarnings\": {\n                \"avg\": 0, \n                \"count\": 0, \n                \"max\": 0, \n                \"min\": 0, \n                \"stdDev\": 0, \n                \"sum\": 0\n            }, \n            \"averageIntegrationTime\": {\n                \"avg\": 97.3485, \n                \"count\": 2, \n                \"max\": 110.717, \n                \"min\": 83.98, \n                \"stdDev\": 100, \n                \"sum\": 194.697\n            }, \n            \"bestSuccessStreak\": {\n                \"endedTime\": \"2015-07-23T22:09:23.547Z\", \n                \"integrationID\": \"ce1feecdb2db6bdef13e63a61c01837f\", \n                \"success_streak\": 2\n            }, \n            \"codeCoveragePercentageDelta\": 0, \n            \"errors\": {\n                \"avg\": 0, \n                \"count\": 2, \n                \"max\": 0, \n                \"min\": 0, \n                \"stdDev\": 0, \n                \"sum\": 0\n            }, \n            \"improvedPerfTests\": {\n                \"avg\": 0, \n                \"count\": 2, \n                \"max\": 0, \n                \"min\": 0, \n                \"stdDev\": 0, \n                \"sum\": 0\n            }, \n            \"lastCleanIntegration\": {\n                \"endedTime\": \"2015-07-23T22:09:23.547Z\", \n                \"integrationID\": \"ce1feecdb2db6bdef13e63a61c01837f\"\n            }, \n            \"numberOfCommits\": 0, \n            \"numberOfIntegrations\": 2, \n            \"regressedPerfTests\": {\n                \"avg\": 0, \n                \"count\": 2, \n                \"max\": 0, \n                \"min\": 0, \n                \"stdDev\": 0, \n                \"sum\": 0\n            }, \n            \"sinceDate\": \"2015-07-20T23:01:30.937Z\", \n            \"testAdditionRate\": 2, \n            \"testFailures\": {\n                \"avg\": 0, \n                \"count\": 2, \n                \"max\": 0, \n                \"min\": 0, \n                \"stdDev\": 0, \n                \"sum\": 0\n            }, \n            \"tests\": {\n                \"avg\": 2, \n                \"count\": 2, \n                \"max\": 2, \n                \"min\": 2, \n                \"stdDev\": 100, \n                \"sum\": 4\n            }, \n            \"warnings\": {\n                \"avg\": 0, \n                \"count\": 2, \n                \"max\": 0, \n                \"min\": 0, \n                \"stdDev\": 0, \n                \"sum\": 0\n            }\n        }\n\n# Group Integrations\n\n\n\n\n\n\n\n"
    });
  </script>
</body>
</html>