Skip to content

Instantly share code, notes, and snippets.

@peterbartha

peterbartha/travis-swagger.json

Last active April 27, 2018 02:09
Show Gist options
  • Save peterbartha/c965404b8119e685b9b2c20b8140ec9c to your computer and use it in GitHub Desktop.
Save peterbartha/c965404b8119e685b9b2c20b8140ec9c to your computer and use it in GitHub Desktop.
Download ZIP
Travis CI Swagger 2.0 config
Raw
travis-swagger.json
{
"swagger": "2.0",
"info": {
"description": "Travis CI is a hosted continuous integration and deployment system. You can find out more about Travis at [https://developer.travis-ci.com](https://developer.travis-ci.com).",
"version": "3.0.0",
"title": "TravisHub",
"termsOfService": "https://billing.travis-ci.com/pages/terms",
"contact": {
"email": "[email protected]"
},
"license": {
"name": "MIT",
"url": "https://opensource.org/licenses/MIT"
}
},
"host": "api.travis-ci.org",
"basePath": "/",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
{
"name": "active",
"description": "A list of all the builds in an `active` state, either created or started.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/active"
}
},
{
"name": "betaFeature",
"description": "A beta feature (a Travis-CI feature currently in beta).",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/beta_feature"
}
},
{
"name": "betaFeatures",
"description": "A list of beta features. Beta features are new Travis CI features in beta mode. They can be toggled on or off via the API or on our site: https://travis-ci.com/features",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/beta_features"
}
},
{
"name": "branch",
"description": "The branch of a GitHub repository. Useful for obtaining information about the last build on a given branch.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/branch"
}
},
{
"name": "branches",
"description": "A list of branches. If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/branches"
}
},
{
"name": "broadcast",
"description": "There is currently no endpoint to request a single broadcast. Instead, load a list of all broadcasts for the current user.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/broadcast"
}
},
{
"name": "broadcasts",
"description": "A list of broadcasts for the current user.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/broadcasts"
}
},
{
"name": "build",
"description": "An individual build.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/build"
}
},
{
"name": "builds",
"description": "A list of builds. If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/builds"
}
},
{
"name": "caches",
"description": "A list of caches. If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/caches"
}
},
{
"name": "commit",
"description": "There is currently no endpoint to request a single commit. Commit information is obtained by requesting a build, job, or list of requests.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/commit"
}
},
{
"name": "cron",
"description": "An individual cron. There can be only one cron per branch on a repository. If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/cron"
}
},
{
"name": "crons",
"description": "A list of crons. If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/crons"
}
},
{
"name": "envVar",
"description": "An individual environment variable. If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/env_var"
}
},
{
"name": "envVars",
"description": "A list of environment variables. If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/env_vars"
}
},
{
"name": "error",
"description": "Responses indicating an error are represented by a proper response HTTP status code (403, 404, etc).",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/error"
}
},
{
"name": "installation",
"description": "Responses indicating an error are represented by a proper response HTTP status code (403, 404, etc).",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/installation"
}
},
{
"name": "job",
"description": "An individual job.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/job"
}
},
{
"name": "jobs",
"description": "A list of jobs. Currently this is nested within a build.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/jobs"
}
},
{
"name": "keyPair",
"description": "Users may add a public/private RSA key pair to a repository. This can be used within builds, for example to access third-party services or deploy code to production. Please note this feature is only available on the travis-ci.com domain.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/key_pair"
}
},
{
"name": "keyPairGenerated",
"description": "Every repository has an auto-generated RSA key pair. This is used when cloning the repository from GitHub and when encrypting/decrypting secure data for use in builds, e.g. via the Travis CI command line client. Users may read the public key and fingerprint via GET request, or generate a new key pair via POST, but otherwise this key pair cannot be edited or removed.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/key_pair_generated"
}
},
{
"name": "lint",
"description": "This validates the `.travis.yml` file and returns any warnings. The request body can contain the content of the .travis.yml file directly as a string, eg `foo: bar`.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/lint"
}
},
{
"name": "log",
"description": "An individual log.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/log"
}
},
{
"name": "message",
"description": "An individual Message.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/message"
}
},
{
"name": "messages",
"description": "A list of messages. Messages belong to resource types.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/messages"
}
},
{
"name": "organization",
"description": "An individual organization.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/organization"
}
},
{
"name": "organizations",
"description": "A list of organizations for the current user.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/organizations"
}
},
{
"name": "owner",
"description": "This will be either a user or organization.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/owner"
}
},
{
"name": "repositories",
"description": "A list of repositories for the current user.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/repositories"
}
},
{
"name": "repository",
"description": "An individual repository.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/repository"
}
},
{
"name": "request",
"description": "An individual request.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/request"
}
},
{
"name": "requests",
"description": "A list of requests. If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/requests"
}
},
{
"name": "setting",
"description": "An individual repository setting. These are settings on a repository that can be adjusted by the user. There are currently five different kinds of settings a user can modify: `builds_only_with_travis_yml` (boolean), `build_pushes` (boolean), `build_pull_requests` (boolean), `maximum_number_of_builds` (integer), `auto_cancel_pushes` (boolean), `auto_cancel_pull_requests` (boolean). If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/setting"
}
},
{
"name": "settings",
"description": "A list of user settings. These are settings on a repository that can be adjusted by the user. There are currently five different kinds of settings a user can modify: `builds_only_with_travis_yml` (boolean), `build_pushes` (boolean), `build_pull_requests` (boolean), `maximum_number_of_builds` (integer), `auto_cancel_pushes` (boolean), `auto_cancel_pull_requests` (boolean). If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/settings"
}
},
{
"name": "stage",
"description": "An individual stage.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/stage"
}
},
{
"name": "stages",
"description": "A list of stages. Currently this is nested within a build.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/stages"
}
},
{
"name": "user",
"description": "An individual user.",
"externalDocs": {
"description": "Find out more",
"url": "https://developer.travis-ci.com/resource/user"
}
}
],
"schemes": [
"https"
],
"paths": {
"/owner/{owner.login}/active": {
"get": {
"tags": [
"active"
],
"summary": "Get active builds",
"description": "Returns a list of \"active\" builds for the owner.",
"operationId": "getOwnerActiveBuilds",
"responses": {
"200": {
"description": "Active",
"schema": {
"$ref": "#/definitions/Active"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "owner.login",
"in": "path",
"description": "User or organization login set on GitHub.",
"required": true,
"type": "string"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/owner/github_id/{owner.github_id}/active": {
"get": {
"tags": [
"active"
],
"summary": "Get active builds",
"description": "Returns a list of \"active\" builds for the owner.",
"operationId": "getGithubUserActiveBuilds",
"responses": {
"200": {
"description": "Actives",
"schema": {
"$ref": "#/definitions/Active"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "owner.github_id",
"in": "path",
"description": "User or organization id set on GitHub.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/user/{user.id}/beta_feature/{beta_feature.id}": {
"patch": {
"tags": [
"betaFeature"
],
"summary": "Update a beta_feature",
"description": "This will update a user's beta_feature.",
"operationId": "updateBetaFeature",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "user.id",
"in": "path",
"description": "Value uniquely identifying the user.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "beta_feature.id",
"in": "path",
"description": "Value uniquely identifying the beta feature.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "beta_feature",
"in": "body",
"description": "beta_feature toggle",
"schema": {
"type": "object",
"required": [
"beta_feature.enabled"
],
"properties": {
"beta_feature.id": {
"type": "integer",
"format": "int64",
"description": "Value uniquely identifying the beta feature."
},
"beta_feature.enabled": {
"type": "boolean",
"description": "Indicates if the user has this feature turned on."
}
}
}
}
]
},
"delete": {
"tags": [
"betaFeature"
],
"summary": "Delete a beta_feature",
"description": "This will delete a user's beta feature.",
"operationId": "deleteBetaFeature",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "user.id",
"in": "path",
"description": "Value uniquely identifying the user.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "beta_feature.id",
"in": "path",
"description": "Value uniquely identifying the beta feature.",
"required": true,
"type": "integer",
"format": "int64"
}
]
}
},
"/user/{user.id}/beta_features": {
"get": {
"tags": [
"betaFeatures"
],
"summary": "Get beta_features",
"description": "This will return a list of beta features available to a user.",
"operationId": "getBetaFeatures",
"responses": {
"200": {
"description": "BetaFeatures",
"schema": {
"$ref": "#/definitions/BetaFeatures"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "user.id",
"in": "path",
"description": "Value uniquely identifying the user.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/repo/{repository.id}/branch/{branch.name}": {
"get": {
"tags": [
"branch"
],
"summary": "Get branch info",
"description": "This will return information about an individual branch. The request can include either the repository id or slug.",
"operationId": "getBranchInfo",
"responses": {
"200": {
"description": "Branch",
"schema": {
"$ref": "#/definitions/Branch"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "branch.name",
"in": "path",
"description": "Name of the git branch.",
"required": true,
"type": "string"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/repo/{repository.id}/branches": {
"get": {
"tags": [
"branches"
],
"summary": "Get branches of repository",
"description": "This will return a list of branches a repository has on GitHub.",
"operationId": "getBranches",
"responses": {
"200": {
"description": "Branches",
"schema": {
"$ref": "#/definitions/Branches"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "branch.exists_on_github",
"in": "query",
"description": "Filters branches by whether or not the branch still exists on GitHub.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "exists_on_github",
"in": "query",
"description": "Alias for branch.exists_on_github.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "How many branches to include in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "offset",
"in": "query",
"description": "How many branches to skip before the first entry in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "sort_by",
"in": "query",
"description": "Attributes to sort branches by. Used for pagination.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/broadcasts": {
"get": {
"tags": [
"broadcasts"
],
"summary": "Get broadcasts",
"description": "This will return a list of broadcasts for the current user.",
"operationId": "getBroadcasts",
"responses": {
"200": {
"description": "Broadcasts",
"schema": {
"$ref": "#/definitions/Broadcasts"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "active",
"in": "query",
"description": "Alias for broadcast.active.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "broadcast.active",
"in": "query",
"description": "Filters broadcasts by whether or not the brodacast should still be displayed.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/build/{build.id}": {
"get": {
"tags": [
"build"
],
"summary": "Get Build by ID",
"description": "This returns a single build.",
"operationId": "getBuild",
"responses": {
"200": {
"description": "Build",
"schema": {
"$ref": "#/definitions/Build"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "build.id",
"in": "path",
"description": "Value uniquely identifying the build.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/build/{build.id}/cancel": {
"post": {
"tags": [
"build"
],
"summary": "Cancel a build",
"description": "This cancels a currently running build. It will set the build and associated jobs to \"state\": \"canceled\".",
"operationId": "cancelBuild",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "build.id",
"in": "path",
"description": "Value uniquely identifying the build.",
"required": true,
"type": "integer",
"format": "int64"
}
]
}
},
"/build/{build.id}/restart": {
"post": {
"tags": [
"build"
],
"summary": "Restart a build",
"description": "This restarts a build that has completed or been canceled.",
"operationId": "restartBuild",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "build.id",
"in": "path",
"description": "Value uniquely identifying the build.",
"required": true,
"type": "integer",
"format": "int64"
}
]
}
},
"/builds": {
"get": {
"tags": [
"builds"
],
"summary": "Get builds",
"description": "This returns a list of builds for the current user. The result is paginated. The default limit is 100.",
"operationId": "getBuilds",
"responses": {
"200": {
"description": "Builds",
"schema": {
"$ref": "#/definitions/Builds"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "How many builds to include in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "offset",
"in": "query",
"description": "How many builds to skip before the first entry in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "sort_by",
"in": "query",
"description": "Attributes to sort builds by. Used for pagination.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/repo/{repository.id}/builds": {
"get": {
"tags": [
"builds"
],
"summary": "Get builds of repository",
"description": "This returns a list of builds for an individual repository. It is possible to use the repository id or slug in the request. The result is paginated. Each request will return 25 results.",
"operationId": "getRepositoryBuilds",
"responses": {
"200": {
"description": "Builds",
"schema": {
"$ref": "#/definitions/Builds"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "branch.name",
"in": "query",
"description": "Filters builds by name of the git branch.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "build.created_by",
"in": "query",
"description": "Filters builds by the User or Organization that created the build.",
"required": false,
"type": "string"
},
{
"name": "build.event_type",
"in": "query",
"description": "Filters builds by event that triggered the build.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "build.previous_state",
"in": "query",
"description": "Filters builds by state of the previous build (useful to see if state changed).",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "build.state",
"in": "query",
"description": "Filters builds by current state of the build.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "created_by",
"in": "query",
"description": "Alias for build.created_by.",
"required": false,
"type": "string"
},
{
"name": "event_type",
"in": "query",
"description": "Alias for build.event_type.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "How many builds to include in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "offset",
"in": "query",
"description": "How many builds to skip before the first entry in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "previous_state",
"in": "query",
"description": "Alias for build.previous_state.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Attributes to sort builds by. Used for pagination.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "state",
"in": "query",
"description": "Alias for build.state.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/cron/{cron.id}": {
"get": {
"tags": [
"cron"
],
"summary": "Get cron",
"description": "This returns a single cron.",
"operationId": "getCron",
"responses": {
"200": {
"description": "Cron",
"schema": {
"$ref": "#/definitions/Cron"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "cron.id",
"in": "path",
"description": "Value uniquely identifying the cron.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
},
"delete": {
"tags": [
"cron"
],
"summary": "Delete cron",
"description": "This deletes a single cron.",
"operationId": "deleteCron",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "cron.id",
"in": "path",
"description": "Value uniquely identifying the cron.",
"required": true,
"type": "integer",
"format": "int64"
}
]
}
},
"/repo/{repository.id}/branch/{branch.name}/cron": {
"get": {
"tags": [
"cron"
],
"summary": "Get branch specific crons",
"description": "This returns the cron set for the specified branch for the specified repository. It is possible to use the repository id or slug in the request.",
"operationId": "getBranchCrons",
"responses": {
"200": {
"description": "Cron",
"schema": {
"$ref": "#/definitions/Cron"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "branch.name",
"in": "path",
"description": "Name of the git branch.",
"required": true,
"type": "string"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
},
"post": {
"tags": [
"cron"
],
"summary": "Create a cron",
"description": "This creates a cron on the specified branch for the specified repository. It is possible to use the repository id or slug in the request. Content-Type MUST be set in the header and an interval for the cron MUST be specified as a parameter.",
"operationId": "createCronViaId",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "branch.name",
"in": "path",
"description": "Name of the git branch.",
"required": true,
"type": "string"
},
{
"name": "cron",
"in": "body",
"description": "Cron object",
"schema": {
"type": "object",
"required": [
"cron.interval"
],
"properties": {
"cron.interval": {
"type": "string",
"description": "Interval at which the cron will run (can be \"daily\", \"weekly\" or \"monthly\")."
},
"beta_feature.enabled": {
"type": "boolean",
"description": "Whether a cron build should run if there has been a build on this branch in the last 24 hours."
}
}
}
}
]
}
},
"/repo/{repository.id}/crons": {
"get": {
"tags": [
"crons"
],
"summary": "Get crons of repository",
"description": "This returns a list of crons for an individual repository. It is possible to use the repository id or slug in the request.",
"operationId": "getCrons",
"responses": {
"200": {
"description": "Crons",
"schema": {
"$ref": "#/definitions/Crons"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "How many crons to include in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "offset",
"in": "query",
"description": "How many crons to skip before the first entry in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
}
]
}
},
"/repo/{repository.id}/env_var/{env_var.id}": {
"get": {
"tags": [
"envVar"
],
"summary": "Get env var of repository",
"description": "This returns a single environment variable. It is possible to use the repository id or slug in the request.",
"operationId": "getEnvVar",
"responses": {
"200": {
"description": "EnvVar",
"schema": {
"$ref": "#/definitions/EnvVar"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "env_var.id",
"in": "path",
"description": "The environment variable id.",
"required": true,
"type": "string"
},
{
"name": "env_var.id",
"in": "query",
"description": "The environment variable id.",
"required": false,
"type": "string"
},
{
"name": "id",
"in": "query",
"description": "Alias for env_var.id.",
"required": false,
"type": "string"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "repository.id",
"in": "query",
"description": "Value uniquely identifying the repository.",
"required": false,
"type": "integer",
"format": "int64"
}
]
},
"patch": {
"tags": [
"envVar"
],
"summary": "Update an env var",
"description": "This updates a single environment variable. It is possible to use the repository id or slug in the request.",
"operationId": "updateEnvVar",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "env_var.id",
"in": "path",
"description": "The environment variable id.",
"required": true,
"type": "string"
},
{
"name": "env_var",
"in": "body",
"description": "env var object",
"schema": {
"type": "object",
"required": [
"env_var.name",
"env_var.value",
"env_var.public"
],
"properties": {
"env_var.name": {
"type": "string",
"description": "The environment variable name, e.g. FOO."
},
"env_var.value": {
"type": "string",
"description": "The environment variable's value, e.g. bar."
},
"env_var.public": {
"type": "boolean",
"description": "Whether this environment variable should be publicly visible or not."
}
}
}
}
]
},
"delete": {
"tags": [
"envVar"
],
"summary": "Delete an env var",
"description": "This deletes a single environment variable. It is possible to use the repository id or slug in the request.",
"operationId": "deleteEnvVar",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "env_var.id",
"in": "path",
"description": "The environment variable id.",
"required": true,
"type": "string"
}
]
}
},
"/repo/{repository.id}/env_vars": {
"get": {
"tags": [
"envVars"
],
"summary": "Get env vars of repository",
"description": "This returns a list of environment variables for an individual repository. It is possible to use the repository id or slug in the request.",
"operationId": "getEnvVars",
"responses": {
"200": {
"description": "EnvVars",
"schema": {
"$ref": "#/definitions/EnvVars"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
},
"post": {
"tags": [
"envVars"
],
"summary": "Create an env var",
"description": "This creates an environment variable for an individual repository. It is possible to use the repository id or slug in the request.",
"operationId": "createEnvVarViaId",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "env_var",
"in": "body",
"description": "env var object",
"schema": {
"type": "object",
"required": [
"env_var.name",
"env_var.value",
"env_var.public"
],
"properties": {
"env_var.name": {
"type": "string",
"description": "The environment variable name, e.g. FOO."
},
"env_var.value": {
"type": "string",
"description": "The environment variable's value, e.g. bar."
},
"env_var.public": {
"type": "boolean",
"description": "Whether this environment variable should be publicly visible or not."
}
}
}
}
]
}
},
"/installation/{installation.github_id}": {
"get": {
"tags": [
"installation"
],
"summary": "Get installation info",
"description": "Get installation info.",
"operationId": "getInstallationInfo",
"responses": {
"200": {
"description": "Installation",
"schema": {
"$ref": "#/definitions/Installation"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "installation.github_id",
"in": "path",
"description": "The installation's github_id.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/job/{job.id}": {
"get": {
"tags": [
"job"
],
"summary": "Get job",
"description": "This returns a single job.",
"operationId": "getJob",
"responses": {
"200": {
"description": "Job",
"schema": {
"$ref": "#/definitions/Job"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "job.id",
"in": "path",
"description": "Value uniquely identifying the job.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/job/{job.id}/cancel": {
"post": {
"tags": [
"job"
],
"summary": "Cancel job",
"description": "This cancels a currently running job.",
"operationId": "cancelJob",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "job.id",
"in": "path",
"description": "Value uniquely identifying the job.",
"required": true,
"type": "integer",
"format": "int64"
}
]
}
},
"/job/{job.id}/restart": {
"post": {
"tags": [
"job"
],
"summary": "Restart job",
"description": "This restarts a job that has completed or been canceled.",
"operationId": "restartJob",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "job.id",
"in": "path",
"description": "Value uniquely identifying the job.",
"required": true,
"type": "integer",
"format": "int64"
}
]
}
},
"/job/{job.id}/debug": {
"post": {
"tags": [
"job"
],
"summary": "Debug job",
"description": "This restarts a job in debug mode, enabling the logged-in user to ssh into the build VM. Please note this feature is only available on the travis-ci.com domain, and those repositories on the travis-ci.org domain for which the debug feature is enabled. See this document for more details.",
"operationId": "debugJob",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "job.id",
"in": "path",
"description": "Value uniquely identifying the job.",
"required": true,
"type": "integer",
"format": "int64"
}
]
}
},
"/build/{build.id}/jobs": {
"get": {
"tags": [
"jobs"
],
"summary": "Get jobs of build",
"description": "This returns a list of jobs belonging to an individual build.",
"operationId": "getBuildJobs",
"responses": {
"200": {
"description": "Jobs",
"schema": {
"$ref": "#/definitions/Jobs"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "build.id",
"in": "path",
"description": "Value uniquely identifying the build.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/jobs": {
"get": {
"tags": [
"jobs"
],
"summary": "Get jobs",
"description": "This returns a list of jobs a current user has access to.",
"operationId": "getJobs",
"responses": {
"200": {
"description": "Jobs",
"schema": {
"$ref": "#/definitions/Jobs"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "active",
"in": "query",
"description": "Alias for job.active.",
"required": false,
"type": "string"
},
{
"name": "created_by",
"in": "query",
"description": "Alias for job.created_by.",
"required": false,
"type": "string"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "job.active",
"in": "query",
"description": "<Documentation missing>",
"required": false,
"type": "string"
},
{
"name": "job.created_by",
"in": "query",
"description": "<Documentation missing>",
"required": false,
"type": "string"
},
{
"name": "job.state",
"in": "query",
"description": "Filters jobs by current state of the job.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "How many jobs to include in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "offset",
"in": "query",
"description": "How many jobs to skip before the first entry in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "sort_by",
"in": "query",
"description": "Attributes to sort jobs by. Used for pagination.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "state",
"in": "query",
"description": "Alias for job.state.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/repo/{repository.id}/key_pair": {
"get": {
"tags": [
"keyPair"
],
"summary": "Get RSA key pair",
"description": "Return the current key pair, if it exists.",
"operationId": "getRSAKeyPair",
"responses": {
"200": {
"description": "KeyPair",
"schema": {
"$ref": "#/definitions/KeyPair"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
},
"post": {
"tags": [
"keyPair"
],
"summary": "Create key pair",
"description": "Creates a new key pair.",
"operationId": "createRSAKeyPair",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "key_pair",
"in": "body",
"description": "key pair object",
"schema": {
"type": "object",
"required": [
"beta_feature.value",
"beta_feature.description"
],
"properties": {
"beta_feature.description": {
"type": "string",
"description": "A text description."
},
"beta_feature.value": {
"type": "string",
"description": "The private key."
}
}
}
}
]
},
"patch": {
"tags": [
"keyPair"
],
"summary": "Update key pair",
"description": "Update the key pair.",
"operationId": "updateRSAKeyPair",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "key_pair",
"in": "body",
"description": "key pair object",
"schema": {
"type": "object",
"required": [
"beta_feature.value",
"beta_feature.description"
],
"properties": {
"beta_feature.description": {
"type": "string",
"description": "A text description."
},
"beta_feature.value": {
"type": "string",
"description": "The private key."
}
}
}
}
]
},
"delete": {
"tags": [
"keyPair"
],
"summary": "Delete key pair",
"description": "Delete the key pair.",
"operationId": "deleteRSAKeyPair",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
}
]
}
},
"/repo/{repository.id}/key_pair/generated": {
"get": {
"tags": [
"keyPairGenerated"
],
"summary": "Get generated RSA key pair",
"description": "Return the current key pair.",
"operationId": "getGeneratedRSAKeyPair",
"responses": {
"200": {
"description": "KeyPair",
"schema": {
"$ref": "#/definitions/KeyPair"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
},
"post": {
"tags": [
"keyPairGenerated"
],
"summary": "Generate and replace key pair",
"description": "Generate a new key pair, replacing the previous one.",
"operationId": "generateNewRSAKeyPairViaId",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
}
]
}
},
"/lint": {
"post": {
"tags": [
"lint"
],
"summary": "Validates the .travis.yml file and returns any warnings",
"description": "The request body can contain the content of the .travis.yml file directly as a string, eg `foo: bar`.",
"operationId": "lintTravisYml",
"responses": {
"200": {
"description": "Lint",
"schema": {
"$ref": "#/definitions/Lint"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"in": "body",
"name": "fileContent",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/job/{job.id}/log": {
"get": {
"tags": [
"log"
],
"summary": "Get log of job",
"description": "This returns a single log.",
"operationId": "getJobLog",
"responses": {
"200": {
"description": "Log",
"schema": {
"$ref": "#/definitions/Log"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "job.id",
"in": "path",
"description": "Value uniquely identifying the job.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "log.token",
"in": "query",
"description": "<Documentation missing>",
"required": false,
"type": "string"
}
]
},
"delete": {
"tags": [
"log"
],
"summary": "Delete log of job",
"description": "This removes the contents of a log. It gets replace with the message: Log removed by XXX at 2017-02-13 16:00:00 UTC.",
"operationId": "deleteLog",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "job.id",
"in": "path",
"description": "Value uniquely identifying the job.",
"required": true,
"type": "integer",
"format": "int64"
}
]
}
},
"/job/{job.id}/log.txt": {
"get": {
"tags": [
"log"
],
"summary": "Get log of job",
"description": "This returns a single log.",
"operationId": "getPlainJobLog",
"responses": {
"200": {
"description": "Plain-text Log"
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "job.id",
"in": "path",
"description": "Value uniquely identifying the job.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "log.token",
"in": "query",
"description": "<Documentation missing>",
"required": false,
"type": "string"
}
]
}
},
"/repo/{repository.id}/request/{request.id}/messages": {
"get": {
"tags": [
"messages"
],
"summary": "List request messages",
"description": "This will return a list of messages created by travis-yml for a request, if any exist.",
"operationId": "listRequestMessages",
"responses": {
"200": {
"description": "Messages",
"schema": {
"$ref": "#/definitions/Messages"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "request.id",
"in": "path",
"description": "Value uniquely identifying the request.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "How many messages to include in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "offset",
"in": "query",
"description": "How many messages to skip before the first entry in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
}
]
}
},
"/org/{organization.id}": {
"get": {
"tags": [
"organization"
],
"summary": "Get organization",
"description": "This returns an individual organization.",
"operationId": "getOrganization",
"responses": {
"200": {
"description": "Organization",
"schema": {
"$ref": "#/definitions/Organization"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "organization.id",
"in": "path",
"description": "Value uniquely identifying the organization.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/orgs": {
"get": {
"tags": [
"organizations"
],
"summary": "Get organizations",
"description": "This returns a list of organizations the current user is a member of.",
"operationId": "getOrganizations",
"responses": {
"200": {
"description": "Organizations",
"schema": {
"$ref": "#/definitions/Organizations"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "How many organizations to include in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "offset",
"in": "query",
"description": "How many organizations to skip before the first entry in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "organization.role",
"in": "query",
"description": "<Documentation missing>",
"required": false,
"type": "string"
},
{
"name": "role",
"in": "query",
"description": "Alias for organization.role.",
"required": false,
"type": "string"
},
{
"name": "sort_by",
"in": "query",
"description": "Attributes to sort organizations by. Used for pagination.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/owner/{owner.login}": {
"get": {
"tags": [
"owner"
],
"summary": "Get owner",
"description": "This returns an individual owner. It is possible to use the GitHub login or github_id in the request.",
"operationId": "getOwner",
"responses": {
"200": {
"description": "Owner",
"schema": {
"$ref": "#/definitions/Owner"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "owner.login",
"in": "path",
"description": "User or organization login set on GitHub.",
"required": true,
"type": "string"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/owner/github_id/{owner.github_id}": {
"get": {
"tags": [
"owner"
],
"summary": "Get owner",
"description": "This returns an individual owner. It is possible to use the GitHub login or github_id in the request.",
"operationId": "getOwnerGitHubUser",
"responses": {
"200": {
"description": "Owner",
"schema": {
"$ref": "#/definitions/Owner"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "owner.github_id",
"in": "path",
"description": "User or organization id set on GitHub.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/owner/{owner.login}/repos": {
"get": {
"tags": [
"repositories"
],
"summary": "Get owner's repositories",
"description": "This returns a list of repositories an owner has access to.",
"operationId": "getOwnerRepositories",
"responses": {
"200": {
"description": "Repositories",
"schema": {
"$ref": "#/definitions/Repositories"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "owner.login",
"in": "path",
"description": "User or organization login set on GitHub.",
"required": true,
"type": "string"
},
{
"name": "active",
"in": "query",
"description": "Alias for repository.active.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "How many repositories to include in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "managed_by_installation",
"in": "query",
"description": "Alias for repository.managed_by_installation.",
"required": false,
"type": "boolean"
},
{
"name": "offset",
"in": "query",
"description": "How many repositories to skip before the first entry in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "private",
"in": "query",
"description": "Alias for repository.private.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "repository.active",
"in": "query",
"description": "Filters repositories by whether or not this repository is currently enabled on Travis CI.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "repository.managed_by_installation",
"in": "query",
"description": "Filters repositories by the repository's managed_by_installation.",
"required": false,
"type": "boolean"
},
{
"name": "repository.private",
"in": "query",
"description": "Filters repositories by whether or not this repository is private.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "repository.starred",
"in": "query",
"description": "Filters repositories by whether or not this repository is starred.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Attributes to sort repositories by. Used for pagination.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "starred",
"in": "query",
"description": "Alias for repository.starred.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
}
]
}
},
"/owner/github_id/{owner.github_id}/repos": {
"get": {
"tags": [
"repositories"
],
"summary": "Get owner's repositories",
"description": "This returns a list of repositories an owner has access to.",
"operationId": "getOwnerGitHubUserRepositories",
"responses": {
"200": {
"description": "Repositories",
"schema": {
"$ref": "#/definitions/Repositories"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "owner.github_id",
"in": "path",
"description": "User or organization id set on GitHub.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "active",
"in": "query",
"description": "Alias for repository.active.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "How many repositories to include in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "managed_by_installation",
"in": "query",
"description": "Alias for repository.managed_by_installation.",
"required": false,
"type": "boolean"
},
{
"name": "offset",
"in": "query",
"description": "How many repositories to skip before the first entry in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "private",
"in": "query",
"description": "Alias for repository.private.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "repository.active",
"in": "query",
"description": "Filters repositories by whether or not this repository is currently enabled on Travis CI.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "repository.managed_by_installation",
"in": "query",
"description": "Filters repositories by the repository's managed_by_installation.",
"required": false,
"type": "boolean"
},
{
"name": "repository.private",
"in": "query",
"description": "Filters repositories by whether or not this repository is private.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "repository.starred",
"in": "query",
"description": "Filters repositories by whether or not this repository is starred.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Attributes to sort repositories by. Used for pagination.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "starred",
"in": "query",
"description": "Alias for repository.starred.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
}
]
}
},
"/repos": {
"get": {
"tags": [
"repositories"
],
"summary": "Get repositories",
"description": "This returns a list of repositories the current user has access to.",
"operationId": "getRepositories",
"responses": {
"200": {
"description": "Repositories",
"schema": {
"$ref": "#/definitions/Repositories"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "active",
"in": "query",
"description": "Alias for repository.active.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "How many repositories to include in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "managed_by_installation",
"in": "query",
"description": "Alias for repository.managed_by_installation.",
"required": false,
"type": "boolean"
},
{
"name": "offset",
"in": "query",
"description": "How many repositories to skip before the first entry in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "private",
"in": "query",
"description": "Alias for repository.private.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "repository.active",
"in": "query",
"description": "Filters repositories by whether or not this repository is currently enabled on Travis CI.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "repository.managed_by_installation",
"in": "query",
"description": "Filters repositories by the repository's managed_by_installation.",
"required": false,
"type": "boolean"
},
{
"name": "repository.private",
"in": "query",
"description": "Filters repositories by whether or not this repository is private.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "repository.starred",
"in": "query",
"description": "Filters repositories by whether or not this repository is starred.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
},
{
"name": "sort_by",
"in": "query",
"description": "Attributes to sort repositories by. Used for pagination.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "starred",
"in": "query",
"description": "Alias for repository.starred.",
"required": false,
"type": "array",
"items": {
"type": "boolean"
}
}
]
}
},
"/repo/{repository.id}": {
"get": {
"tags": [
"repository"
],
"summary": "Get repository",
"description": "This returns an individual repository.",
"operationId": "getRepository",
"responses": {
"200": {
"description": "Repository",
"schema": {
"$ref": "#/definitions/Repository"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/repo/{repository.id}/activate": {
"post": {
"tags": [
"repository"
],
"summary": "Activate a repository",
"description": "This will activate a repository, allowing its tests to be run on Travis CI.",
"operationId": "activateRepository",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
}
]
}
},
"/repo/{repository.id}/deactivate": {
"post": {
"tags": [
"repository"
],
"summary": "Deactivate a repository",
"description": "This will deactivate a repository, preventing any tests from running on Travis CI.",
"operationId": "deactivateRepository",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
}
]
}
},
"/repo/{repository.id}/star": {
"post": {
"tags": [
"repository"
],
"summary": "Star a repository",
"description": "This will star a repository based on the currently logged in user.",
"operationId": "starRepository",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
}
]
}
},
"/repo/{repository.id}/unstar": {
"post": {
"tags": [
"repository"
],
"summary": "Unstar a repository",
"description": "This will unstar a repository based on the currently logged in user.",
"operationId": "unstarRepository",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
}
]
}
},
"/repo/{repository.id}/request/{request.id}": {
"get": {
"tags": [
"request"
],
"summary": "Get request info",
"description": "Get request info.",
"operationId": "getRequestInfo",
"responses": {
"200": {
"description": "Request",
"schema": {
"$ref": "#/definitions/Request"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "request.id",
"in": "path",
"description": "Value uniquely identifying the request.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/repo/{repository.id}/requests": {
"get": {
"tags": [
"requests"
],
"summary": "Get requests of a repository",
"description": "This will return a list of requests belonging to a repository.",
"operationId": "getRepositoryRequests",
"responses": {
"200": {
"description": "Requests",
"schema": {
"$ref": "#/definitions/Requests"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "How many requests to include in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "offset",
"in": "query",
"description": "How many requests to skip before the first entry in the response. Used for pagination.",
"required": false,
"type": "integer",
"format": "int32"
}
]
},
"post": {
"tags": [
"requests"
],
"summary": "Create a request for a repository",
"description": "This will create a request for an individual repository, triggering a build to run on Travis CI.",
"operationId": "createRequest",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "request",
"in": "body",
"description": "request object",
"schema": {
"type": "object",
"required": [
"request.config",
"request.message",
"request.branch",
"request.token"
],
"properties": {
"request.config": {
"type": "string",
"description": "Build configuration (as parsed from .travis.yml)."
},
"request.message": {
"type": "string",
"description": "Travis-ci status message attached to the request."
},
"request.branch": {
"type": "string",
"description": "Branch requested to be built."
},
"request.token": {
"type": "string",
"description": "Travis token associated with webhook on GitHub (DEPRECATED)."
}
}
}
}
]
}
},
"/repo/{repository.id}/setting/{setting.name}": {
"get": {
"tags": [
"setting"
],
"summary": "Get a setting of repository",
"description": "This returns a single setting. It is possible to use the repository id or slug in the request.",
"operationId": "getRepositorySetting",
"responses": {
"200": {
"description": "Setting",
"schema": {
"$ref": "#/definitions/Setting"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "setting.name",
"in": "path",
"description": "The setting's name.",
"required": true,
"type": "string"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
},
"patch": {
"tags": [
"setting"
],
"summary": "Update a setting of repository",
"description": "This updates a single setting. It is possible to use the repository id or slug in the request.",
"operationId": "updateRepositorySetting",
"responses": {
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "setting.name",
"in": "path",
"description": "The setting's name.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "request object",
"schema": {
"type": "object",
"required": [
"request.config",
"request.message",
"request.branch",
"request.token"
],
"properties": {
"request.config": {
"type": "string",
"description": "Build configuration (as parsed from .travis.yml)."
},
"request.message": {
"type": "string",
"description": "Travis-ci status message attached to the request."
},
"request.branch": {
"type": "string",
"description": "Branch requested to be built."
},
"request.token": {
"type": "string",
"description": "Travis token associated with webhook on GitHub (DEPRECATED)."
}
}
}
}
]
}
},
"/repo/{repository.id}/settings": {
"get": {
"tags": [
"settings"
],
"summary": "Get settings of repository",
"description": "This returns a list of the settings for that repository. It is possible to use the repository id or slug in the request.",
"operationId": "getRepositorySettings",
"responses": {
"200": {
"description": "Settings",
"schema": {
"$ref": "#/definitions/Settings"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "repository.id",
"in": "path",
"description": "Value uniquely identifying the repository.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/build/{build.id}/stages": {
"get": {
"tags": [
"stages"
],
"summary": "Get stages of build",
"description": "This returns a list of stages belonging to an individual build.",
"operationId": "getBuildStages",
"responses": {
"200": {
"description": "Stages",
"schema": {
"$ref": "#/definitions/Stages"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "build.id",
"in": "path",
"description": "Value uniquely identifying the build.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/user/{user.id}": {
"get": {
"tags": [
"user"
],
"summary": "Get user",
"description": "This will return information about an individual user.",
"operationId": "getUser",
"responses": {
"200": {
"description": "User",
"schema": {
"$ref": "#/definitions/User"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "user.id",
"in": "path",
"description": "Value uniquely identifying the user.",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/user/{user.id}/sync": {
"post": {
"tags": [
"user"
],
"summary": "Sync user account info",
"description": "This triggers a sync on a user's account with their GitHub account.",
"operationId": "syncUserAccountInfo",
"responses": {
"200": {
"description": "User",
"schema": {
"$ref": "#/definitions/User"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "user.id",
"in": "path",
"description": "Value uniquely identifying the user.",
"required": true,
"type": "integer",
"format": "int64"
}
]
}
},
"/user": {
"get": {
"tags": [
"user"
],
"summary": "Get user info",
"description": "This will return information about the current user.",
"operationId": "getUserInfo",
"responses": {
"200": {
"description": "User",
"schema": {
"$ref": "#/definitions/User"
}
},
"403": {
"description": "Login required"
},
"404": {
"description": "Method not allowed"
},
"405": {
"description": "Resource not found (or insufficient access)"
}
},
"parameters": [
{
"name": "include",
"in": "query",
"description": "List of attributes to eager load.",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
}
},
"securityDefinitions": {
"travisToken": {
"type": "basic"
}
},
"security": [
{
"travisToken": []
}
],
"definitions": {
"Active": {
"type": "object",
"properties": {
"builds": {
"$ref": "#/definitions/Builds",
"description": "The active builds."
}
}
},
"BetaFeature": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "Value uniquely identifying the beta feature."
},
"name": {
"type": "string",
"description": "The name of the feature."
},
"description": {
"type": "string",
"description": "Longer description of the feature."
},
"enabled": {
"type": "boolean",
"description": "Indicates if the user has this feature turned on."
},
"feedback_url": {
"type": "string",
"description": "Url for users to leave Travis CI feedback on this feature."
}
}
},
"BetaFeatures": {
"type": "object",
"properties": {
"beta_features": {
"$ref": "#/definitions/BetaFeature",
"description": "List of betaFeatures."
}
}
},
"Branch": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the git branch."
},
"repository": {
"$ref": "#/definitions/Repository",
"description": "GitHub user or organization the branch belongs to."
},
"default_branch": {
"type": "boolean",
"description": "Whether or not this is the resposiotry's default branch."
},
"exists_on_github": {
"type": "boolean",
"description": "Whether or not the branch still exists on GitHub."
},
"last_build": {
"$ref": "#/definitions/Build",
"description": "Last build on the branch."
},
"recent_builds": {
"type": "array",
"items": {
"$ref": "#/definitions/Build"
},
"description": "Last 10 builds on the branch (when `include=branch.recent_builds` is used)."
}
}
},
"Branches": {
"type": "object",
"properties": {
"branches": {
"type": "array",
"items": {
"$ref": "#/definitions/Branch"
},
"description": "List of branches."
}
}
},
"Broadcast": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "Value uniquely identifying the broadcast."
},
"message": {
"type": "string",
"description": "Message to display to the user."
},
"category": {
"type": "string",
"description": "Broadcast category (used for icon and color)."
},
"active": {
"type": "boolean",
"description": "Whether or not the brodacast should still be displayed."
},
"recipient": {
"$ref": "#/definitions/User",
"description": "Either a user, organization or repository, or null for global."
},
"created_at": {
"type": "string",
"description": "When the broadcast was created."
}
}
},
"Broadcasts": {
"type": "object",
"properties": {
"broadcasts": {
"type": "array",
"items": {
"$ref": "#/definitions/Broadcast"
},
"description": "List of broadcasts."
},
"id": {
"type": "integer",
"format": "int64",
"description": "Value uniquely identifying the broadcast."
},
"message": {
"type": "string",
"description": "Message to display to the user."
},
"category": {
"type": "string",
"description": "Broadcast category (used for icon and color)."
},
"active": {
"type": "boolean",
"description": "Whether or not the brodacast should still be displayed."
},
"recipient": {
"$ref": "#/definitions/User",
"description": "Either a user, organization or repository, or null for global."
},
"created_at": {
"type": "string",
"description": "When the broadcast was created."
}
}
},
"Build": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "Value uniquely identifying the build."
},
"number": {
"type": "string",
"description": "Incremental number for a repository's builds."
},
"state": {
"type": "string",
"description": "Current state of the build."
},
"duration": {
"type": "integer",
"format": "int32",
"description": "Wall clock time in seconds."
},
"repository": {
"$ref": "#/definitions/Repository",
"description": "GitHub user or organization the build belongs to."
},
"branch": {
"$ref": "#/definitions/Branch",
"description": "The branch the build is associated with."
},
"tag": {
"type": "string",
"description": "The build's tag."
},
"commit": {
"$ref": "#/definitions/Commit",
"description": "The commit the build is associated with."
},
"jobs": {
"$ref": "#/definitions/Jobs",
"description": "List of jobs that are part of the build's matrix."
},
"stages": {
"type": "array",
"items": {
"$ref": "#/definitions/Stage"
},
"description": "The stages of a build."
},
"event_type": {
"type": "string",
"description": "Event that triggered the build."
},
"previous_state": {
"type": "string",
"description": "State of the previous build (useful to see if state changed)."
},
"pull_request_title": {
"type": "string",
"description": "Title of the build's pull request."
},
"pull_request_number": {
"type": "integer",
"format": "int64",
"description": "Number of the build's pull request."
},
"started_at": {
"type": "string",
"description": "When the build started."
},
"finished_at": {
"type": "string",
"description": "When the build finished."
},
"created_by": {
"$ref": "#/definitions/Owner",
"description": "The User or Organization that created the build."
},
"updated_at": {
"type": "string",
"description": "The build's updated_at."
}
}
},
"Builds": {
"type": "object",
"properties": {
"builds": {
"type": "array",
"items": {
"$ref": "#/definitions/Build"
},
"description": "List of builds."
}
}
},
"Caches": {
"type": "object",
"properties": {
"branch": {
"type": "string",
"description": "The branch the cache belongs to."
},
"match": {
"type": "string",
"description": "The string to match against the cache name."
}
}
},
"Commit": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "Value uniquely identifying the commit."
},
"sha": {
"type": "string",
"description": "Checksum the commit has in git and is identified by."
},
"ref": {
"type": "string",
"description": "Named reference the commit has in git."
},
"message": {
"type": "string",
"description": "Commit mesage."
},
"committer": {
"$ref": "#/definitions/User",
"description": "Committer data."
},
"author": {
"$ref": "#/definitions/User",
"description": "Committer data."
},
"compare_url": {
"type": "string",
"description": "URL to the commit's diff on GitHub."
},
"committed_at": {
"type": "string",
"description": "Commit date from git."
}
}
},
"Cron": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "Value uniquely identifying the cron."
},
"repository": {
"$ref": "#/definitions/Repository",
"description": "Github repository to which this cron belongs."
},
"branch": {
"$ref": "#/definitions/Branch",
"description": "Git branch of repository to which this cron belongs."
},
"interval": {
"type": "string",
"description": "Interval at which the cron will run (can be \"daily\", \"weekly\" or \"monthly\")."
},
"dont_run_if_recent_build_exists": {
"type": "boolean",
"description": "Whether a cron build should run if there has been a build on this branch in the last 24 hours."
},
"last_run": {
"type": "string",
"description": "When the cron ran last."
},
"next_run": {
"type": "string",
"description": "When the cron is scheduled to run next."
},
"created_at": {
"type": "string",
"description": "When the cron was created."
}
}
},
"Crons": {
"type": "object",
"properties": {
"crons": {
"type": "array",
"items": {
"$ref": "#/definitions/Cron"
},
"description": "List of crons."
}
}
},
"EnvVar": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The environment variable id."
},
"name": {
"type": "string",
"description": "The environment variable name, e.g. FOO."
},
"value": {
"type": "string",
"description": "The environment variable's value, e.g. bar."
},
"public": {
"type": "boolean",
"description": "Whether this environment variable should be publicly visible or not."
}
}
},
"EnvVars": {
"type": "object",
"properties": {
"env_vars": {
"$ref": "#/definitions/EnvVar",
"description": "List of env_vars."
}
}
},
"Error": {
"type": "object",
"properties": {
"permission": {
"type": "string",
"description": "The error's permission."
},
"error_type": {
"type": "string",
"description": "The error's type."
},
"error_message": {
"type": "string",
"description": "The error's message."
},
"resource_type": {
"type": "string",
"description": "The error's resource type."
}
}
},
"Installation": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The installation's id."
},
"owner": {
"$ref": "#/definitions/Owner",
"description": "The installation's owner."
},
"github_id": {
"type": "integer",
"format": "int64",
"description": "The installation's github_id."
}
}
},
"Job": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "Value uniquely identifying the job."
},
"number": {
"type": "string",
"description": "Incremental number for a repository's builds."
},
"state": {
"type": "string",
"description": "Current state of the job."
},
"build": {
"$ref": "#/definitions/Build",
"description": "The build the job is associated with."
},
"queue": {
"type": "string",
"description": "Worker queue this job is/was scheduled on."
},
"repository": {
"$ref": "#/definitions/Repository",
"description": "GitHub user or organization the job belongs to."
},
"commit": {
"$ref": "#/definitions/Commit",
"description": "The commit the job is associated with."
},
"owner": {
"$ref": "#/definitions/Owner",
"description": "GitHub user or organization the job belongs to."
},
"stage": {
"type": "array",
"items": {
"$ref": "#/definitions/Stage"
},
"description": "The stages of a job."
},
"allow_failure": {
"type": "boolean",
"description": "The job's allow_failure."
},
"started_at": {
"type": "string",
"description": "When the job started."
},
"finished_at": {
"type": "string",
"description": "When the job finished."
},
"created_at": {
"type": "string",
"description": "When the job was created."
},
"updated_at": {
"type": "string",
"description": "When the job was updated."
}
}
},
"Jobs": {
"type": "object",
"properties": {
"jobs": {
"type": "array",
"items": {
"$ref": "#/definitions/Job"
},
"description": "List of jobs."
}
}
},
"KeyPair": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "A text description."
},
"fingerprint": {
"type": "string",
"description": "The fingerprint."
},
"public_key": {
"type": "string",
"description": "The public key."
}
}
},
"Lint": {
"type": "object",
"properties": {
"warnings": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of hashes with keys and warnings."
}
}
},
"Log": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The log's id."
},
"content": {
"type": "string",
"description": "The log's content."
},
"log_parts": {
"type": "array",
"items": {
"type": "string"
},
"description": "The log's log_parts."
}
}
},
"Message": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The message's id."
},
"level": {
"type": "string",
"description": "The message's level."
},
"key": {
"type": "string",
"description": "The message's key."
},
"code": {
"type": "string",
"description": "The message's code."
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "The message's args."
}
}
},
"Messages": {
"type": "object",
"properties": {
"messages": {
"type": "array",
"items": {
"$ref": "#/definitions/Message"
},
"description": "List of messages."
}
}
},
"Organization": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "Value uniquely identifying the organization."
},
"login": {
"type": "string",
"description": "Login set on GitHub."
},
"name": {
"type": "string",
"description": "Name set on GitHub."
},
"education": {
"type": "boolean",
"description": "The organization's education."
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/definitions/Repository"
},
"description": "Repositories belonging to this organization."
},
"installation": {
"$ref": "#/definitions/Installation",
"description": "The organization's installation."
},
"github_id": {
"type": "integer",
"format": "int64",
"description": "The organization's github_id."
},
"avatar_url": {
"type": "string",
"description": "Avatar_url set on GitHub."
}
}
},
"Organizations": {
"type": "object",
"properties": {
"organizations": {
"type": "array",
"items": {
"$ref": "#/definitions/Organization"
},
"description": "List of organizations."
}
}
},
"Owner": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "Value uniquely identifying the owner."
},
"login": {
"type": "string",
"description": "User or organization login set on GitHub."
},
"name": {
"type": "string",
"description": "User or organization name set on GitHub."
},
"education": {
"type": "boolean",
"description": "The owner's education."
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/definitions/Repository"
},
"description": "Repositories belonging to this account."
},
"installation": {
"$ref": "#/definitions/Installation",
"description": "The owner's installation."
},
"github_id": {
"type": "integer",
"format": "int64",
"description": "User or organization id set on GitHub."
},
"avatar_url": {
"type": "string",
"description": "Link to user or organization avatar (image) set on GitHub."
}
}
},
"Repositories": {
"type": "object",
"properties": {
"repositories": {
"type": "array",
"items": {
"$ref": "#/definitions/Repository"
},
"description": "List of repositories."
}
}
},
"Repository": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "Value uniquely identifying the repository."
},
"name": {
"type": "string",
"description": "The repository's name on GitHub."
},
"slug": {
"type": "string",
"description": "Same as {repository.owner.name}/{repository.name}."
},
"description": {
"type": "string",
"description": "The repository's description from GitHub."
},
"active": {
"type": "boolean",
"description": "Whether or not this repository is currently enabled on Travis CI."
},
"private": {
"type": "boolean",
"description": "Whether or not this repository is private."
},
"owner": {
"$ref": "#/definitions/Owner",
"description": "GitHub user or organization the repository belongs to."
},
"starred": {
"type": "boolean",
"description": "Whether or not this repository is starred."
},
"github_id": {
"type": "integer",
"format": "int64",
"description": "The repository's github_id."
},
"github_language": {
"type": "string",
"description": "The main programming language used according to GitHub."
},
"default_branch": {
"$ref": "#/definitions/Branch",
"description": "The default branch on GitHub."
},
"managed_by_installation": {
"type": "boolean",
"description": "The repository's managed_by_installation."
},
"active_on_org": {
"type": "string",
"description": "The repository's active_on_org."
}
}
},
"Request": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "Value uniquely identifying the request."
},
"state": {
"type": "string",
"description": "The state of a request (eg. whether it has been processed or not)."
},
"result": {
"type": "string",
"description": "The result of the request (eg. rejected or approved)."
},
"message": {
"type": "string",
"description": "Travis-ci status message attached to the request."
},
"repository": {
"$ref": "#/definitions/Repository",
"description": "GitHub user or organization the request belongs to."
},
"commit": {
"$ref": "#/definitions/Commit",
"description": "The commit the request is associated with."
},
"builds": {
"$ref": "#/definitions/Builds",
"description": "The request's builds."
},
"owner": {
"$ref": "#/definitions/Owner",
"description": "GitHub user or organization the request belongs to."
},
"branch_name": {
"type": "string",
"description": "Name of the branch requested to be built."
},
"created_at": {
"type": "string",
"description": "When Travis CI created the request."
},
"event_type": {
"type": "string",
"description": "Origin of request (push, pull request, api)."
}
}
},
"Requests": {
"type": "object",
"properties": {
"requests": {
"type": "array",
"items": {
"$ref": "#/definitions/Request"
},
"description": "List of requests."
}
}
},
"Setting": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The setting's name."
},
"value": {
"type": "integer",
"format": "int32",
"description": "The setting's value."
}
}
},
"Settings": {
"type": "object",
"properties": {
"settings": {
"type": "array",
"items": {
"$ref": "#/definitions/Setting"
},
"description": "List of settings."
}
}
},
"Stage": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "Value uniquely identifying the stage."
},
"number": {
"type": "integer",
"format": "int32",
"description": "Incremental number for a stage."
},
"name": {
"type": "string",
"description": "The name of the stage."
},
"state": {
"type": "string",
"description": "Current state of the stage."
},
"jobs": {
"type": "array",
"items": {
"$ref": "#/definitions/Job"
},
"description": "The jobs of a stage."
},
"started_at": {
"type": "string",
"description": "When the stage started."
},
"finished_at": {
"type": "string",
"description": "When the stage finished."
}
}
},
"Stages": {
"type": "object",
"properties": {
"stages": {
"type": "array",
"items": {
"$ref": "#/definitions/Stage"
},
"description": "List of stages."
}
}
},
"User": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "Value uniquely identifying the user."
},
"login": {
"type": "string",
"description": "Login set on Github."
},
"name": {
"type": "string",
"description": "Name set on GitHub."
},
"education": {
"type": "boolean",
"description": "The user's education."
},
"repositories": {
"type": "array",
"items": {
"$ref": "#/definitions/Repository"
},
"description": "Repositories belonging to this user."
},
"installation": {
"$ref": "#/definitions/Installation",
"description": "The user's installation."
},
"github_id": {
"type": "integer",
"format": "int64",
"description": "Id set on GitHub."
},
"avatar_url": {
"type": "string",
"description": "Avatar URL set on GitHub."
},
"is_syncing": {
"type": "boolean",
"description": "Whether or not the user is currently being synced with Github."
},
"synced_at": {
"type": "string",
"description": "The last time the user was synced with GitHub."
}
}
}
},
"externalDocs": {
"description": "Find out more about Travis CI",
"url": "https://docs.travis-ci.com/"
}
}
Raw
travis-swagger.yaml
swagger: '2.0'
info:
description: 'Travis CI is a hosted continuous integration and deployment system. You can find out more about Travis at [https://developer.travis-ci.com](https://developer.travis-ci.com).'
version: 3.0.0
title: TravisHub
termsOfService: 'https://billing.travis-ci.com/pages/terms'
contact:
email: [email protected]
license:
name: MIT
url: 'https://opensource.org/licenses/MIT'
host: api.travis-ci.org
basePath: /
consumes:
- application/json
produces:
- application/json
tags:
- name: active
description: 'A list of all the builds in an `active` state, either created or started.'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/active'
- name: betaFeature
description: A beta feature (a Travis-CI feature currently in beta).
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/beta_feature'
- name: betaFeatures
description: 'A list of beta features. Beta features are new Travis CI features in beta mode. They can be toggled on or off via the API or on our site: https://travis-ci.com/features'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/beta_features'
- name: branch
description: The branch of a GitHub repository. Useful for obtaining information about the last build on a given branch.
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/branch'
- name: branches
description: 'A list of branches. If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/branches'
- name: broadcast
description: 'There is currently no endpoint to request a single broadcast. Instead, load a list of all broadcasts for the current user.'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/broadcast'
- name: broadcasts
description: A list of broadcasts for the current user.
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/broadcasts'
- name: build
description: An individual build.
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/build'
- name: builds
description: 'A list of builds. If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/builds'
- name: caches
description: 'A list of caches. If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/caches'
- name: commit
description: 'There is currently no endpoint to request a single commit. Commit information is obtained by requesting a build, job, or list of requests.'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/commit'
- name: cron
description: 'An individual cron. There can be only one cron per branch on a repository. If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/cron'
- name: crons
description: 'A list of crons. If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/crons'
- name: envVar
description: 'An individual environment variable. If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/env_var'
- name: envVars
description: 'A list of environment variables. If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/env_vars'
- name: error
description: 'Responses indicating an error are represented by a proper response HTTP status code (403, 404, etc).'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/error'
- name: installation
description: 'Responses indicating an error are represented by a proper response HTTP status code (403, 404, etc).'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/installation'
- name: job
description: An individual job.
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/job'
- name: jobs
description: A list of jobs. Currently this is nested within a build.
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/jobs'
- name: keyPair
description: 'Users may add a public/private RSA key pair to a repository. This can be used within builds, for example to access third-party services or deploy code to production. Please note this feature is only available on the travis-ci.com domain.'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/key_pair'
- name: keyPairGenerated
description: 'Every repository has an auto-generated RSA key pair. This is used when cloning the repository from GitHub and when encrypting/decrypting secure data for use in builds, e.g. via the Travis CI command line client. Users may read the public key and fingerprint via GET request, or generate a new key pair via POST, but otherwise this key pair cannot be edited or removed.'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/key_pair_generated'
- name: lint
description: 'This validates the `.travis.yml` file and returns any warnings. The request body can contain the content of the .travis.yml file directly as a string, eg `foo: bar`.'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/lint'
- name: log
description: An individual log.
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/log'
- name: message
description: An individual Message.
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/message'
- name: messages
description: A list of messages. Messages belong to resource types.
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/messages'
- name: organization
description: An individual organization.
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/organization'
- name: organizations
description: A list of organizations for the current user.
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/organizations'
- name: owner
description: This will be either a user or organization.
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/owner'
- name: repositories
description: A list of repositories for the current user.
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/repositories'
- name: repository
description: An individual repository.
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/repository'
- name: request
description: An individual request.
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/request'
- name: requests
description: 'A list of requests. If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/requests'
- name: setting
description: 'An individual repository setting. These are settings on a repository that can be adjusted by the user. There are currently five different kinds of settings a user can modify: `builds_only_with_travis_yml` (boolean), `build_pushes` (boolean), `build_pull_requests` (boolean), `maximum_number_of_builds` (integer), `auto_cancel_pushes` (boolean), `auto_cancel_pull_requests` (boolean). If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/setting'
- name: settings
description: 'A list of user settings. These are settings on a repository that can be adjusted by the user. There are currently five different kinds of settings a user can modify: `builds_only_with_travis_yml` (boolean), `build_pushes` (boolean), `build_pull_requests` (boolean), `maximum_number_of_builds` (integer), `auto_cancel_pushes` (boolean), `auto_cancel_pull_requests` (boolean). If querying using the repository slug, it must be formatted using standard URL encoding, including any special characters.'
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/settings'
- name: stage
description: An individual stage.
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/stage'
- name: stages
description: A list of stages. Currently this is nested within a build.
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/stages'
- name: user
description: An individual user.
externalDocs:
description: Find out more
url: 'https://developer.travis-ci.com/resource/user'
schemes:
- https
paths:
'/owner/{owner.login}/active':
get:
tags:
- active
summary: Get active builds
description: Returns a list of "active" builds for the owner.
operationId: getOwnerActiveBuilds
responses:
'200':
description: Active
schema:
$ref: '#/definitions/Active'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: owner.login
in: path
description: User or organization login set on GitHub.
required: true
type: string
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
'/owner/github_id/{owner.github_id}/active':
get:
tags:
- active
summary: Get active builds
description: Returns a list of "active" builds for the owner.
operationId: getGithubUserActiveBuilds
responses:
'200':
description: Actives
schema:
$ref: '#/definitions/Active'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: owner.github_id
in: path
description: User or organization id set on GitHub.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
'/user/{user.id}/beta_feature/{beta_feature.id}':
patch:
tags:
- betaFeature
summary: Update a beta_feature
description: This will update a user's beta_feature.
operationId: updateBetaFeature
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: user.id
in: path
description: Value uniquely identifying the user.
required: true
type: integer
format: int64
- name: beta_feature.id
in: path
description: Value uniquely identifying the beta feature.
required: true
type: integer
format: int64
- name: beta_feature
in: body
description: beta_feature toggle
schema:
type: object
required:
- beta_feature.enabled
properties:
beta_feature.id:
type: integer
format: int64
description: Value uniquely identifying the beta feature.
beta_feature.enabled:
type: boolean
description: Indicates if the user has this feature turned on.
delete:
tags:
- betaFeature
summary: Delete a beta_feature
description: This will delete a user's beta feature.
operationId: deleteBetaFeature
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: user.id
in: path
description: Value uniquely identifying the user.
required: true
type: integer
format: int64
- name: beta_feature.id
in: path
description: Value uniquely identifying the beta feature.
required: true
type: integer
format: int64
'/user/{user.id}/beta_features':
get:
tags:
- betaFeatures
summary: Get beta_features
description: This will return a list of beta features available to a user.
operationId: getBetaFeatures
responses:
'200':
description: BetaFeatures
schema:
$ref: '#/definitions/BetaFeatures'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: user.id
in: path
description: Value uniquely identifying the user.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
'/repo/{repository.id}/branch/{branch.name}':
get:
tags:
- branch
summary: Get branch info
description: This will return information about an individual branch. The request can include either the repository id or slug.
operationId: getBranchInfo
responses:
'200':
description: Branch
schema:
$ref: '#/definitions/Branch'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: branch.name
in: path
description: Name of the git branch.
required: true
type: string
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
'/repo/{repository.id}/branches':
get:
tags:
- branches
summary: Get branches of repository
description: This will return a list of branches a repository has on GitHub.
operationId: getBranches
responses:
'200':
description: Branches
schema:
$ref: '#/definitions/Branches'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: branch.exists_on_github
in: query
description: Filters branches by whether or not the branch still exists on GitHub.
required: false
type: array
items:
type: boolean
- name: exists_on_github
in: query
description: Alias for branch.exists_on_github.
required: false
type: array
items:
type: boolean
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
- name: limit
in: query
description: How many branches to include in the response. Used for pagination.
required: false
type: integer
format: int32
- name: offset
in: query
description: How many branches to skip before the first entry in the response. Used for pagination.
required: false
type: integer
format: int32
- name: sort_by
in: query
description: Attributes to sort branches by. Used for pagination.
required: false
type: array
items:
type: string
/broadcasts:
get:
tags:
- broadcasts
summary: Get broadcasts
description: This will return a list of broadcasts for the current user.
operationId: getBroadcasts
responses:
'200':
description: Broadcasts
schema:
$ref: '#/definitions/Broadcasts'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: active
in: query
description: Alias for broadcast.active.
required: false
type: array
items:
type: boolean
- name: broadcast.active
in: query
description: Filters broadcasts by whether or not the brodacast should still be displayed.
required: false
type: array
items:
type: boolean
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
'/build/{build.id}':
get:
tags:
- build
summary: Get Build by ID
description: This returns a single build.
operationId: getBuild
responses:
'200':
description: Build
schema:
$ref: '#/definitions/Build'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: build.id
in: path
description: Value uniquely identifying the build.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
'/build/{build.id}/cancel':
post:
tags:
- build
summary: Cancel a build
description: 'This cancels a currently running build. It will set the build and associated jobs to "state": "canceled".'
operationId: cancelBuild
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: build.id
in: path
description: Value uniquely identifying the build.
required: true
type: integer
format: int64
'/build/{build.id}/restart':
post:
tags:
- build
summary: Restart a build
description: This restarts a build that has completed or been canceled.
operationId: restartBuild
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: build.id
in: path
description: Value uniquely identifying the build.
required: true
type: integer
format: int64
/builds:
get:
tags:
- builds
summary: Get builds
description: This returns a list of builds for the current user. The result is paginated. The default limit is 100.
operationId: getBuilds
responses:
'200':
description: Builds
schema:
$ref: '#/definitions/Builds'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
- name: limit
in: query
description: How many builds to include in the response. Used for pagination.
required: false
type: integer
format: int32
- name: offset
in: query
description: How many builds to skip before the first entry in the response. Used for pagination.
required: false
type: integer
format: int32
- name: sort_by
in: query
description: Attributes to sort builds by. Used for pagination.
required: false
type: array
items:
type: string
'/repo/{repository.id}/builds':
get:
tags:
- builds
summary: Get builds of repository
description: This returns a list of builds for an individual repository. It is possible to use the repository id or slug in the request. The result is paginated. Each request will return 25 results.
operationId: getRepositoryBuilds
responses:
'200':
description: Builds
schema:
$ref: '#/definitions/Builds'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: branch.name
in: query
description: Filters builds by name of the git branch.
required: false
type: array
items:
type: string
- name: build.created_by
in: query
description: Filters builds by the User or Organization that created the build.
required: false
type: string
- name: build.event_type
in: query
description: Filters builds by event that triggered the build.
required: false
type: array
items:
type: string
- name: build.previous_state
in: query
description: Filters builds by state of the previous build (useful to see if state changed).
required: false
type: array
items:
type: string
- name: build.state
in: query
description: Filters builds by current state of the build.
required: false
type: array
items:
type: string
- name: created_by
in: query
description: Alias for build.created_by.
required: false
type: string
- name: event_type
in: query
description: Alias for build.event_type.
required: false
type: array
items:
type: string
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
- name: limit
in: query
description: How many builds to include in the response. Used for pagination.
required: false
type: integer
format: int32
- name: offset
in: query
description: How many builds to skip before the first entry in the response. Used for pagination.
required: false
type: integer
format: int32
- name: previous_state
in: query
description: Alias for build.previous_state.
required: false
type: array
items:
type: string
- name: sort_by
in: query
description: Attributes to sort builds by. Used for pagination.
required: false
type: array
items:
type: string
- name: state
in: query
description: Alias for build.state.
required: false
type: array
items:
type: string
'/cron/{cron.id}':
get:
tags:
- cron
summary: Get cron
description: This returns a single cron.
operationId: getCron
responses:
'200':
description: Cron
schema:
$ref: '#/definitions/Cron'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: cron.id
in: path
description: Value uniquely identifying the cron.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
delete:
tags:
- cron
summary: Delete cron
description: This deletes a single cron.
operationId: deleteCron
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: cron.id
in: path
description: Value uniquely identifying the cron.
required: true
type: integer
format: int64
'/repo/{repository.id}/branch/{branch.name}/cron':
get:
tags:
- cron
summary: Get branch specific crons
description: This returns the cron set for the specified branch for the specified repository. It is possible to use the repository id or slug in the request.
operationId: getBranchCrons
responses:
'200':
description: Cron
schema:
$ref: '#/definitions/Cron'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: branch.name
in: path
description: Name of the git branch.
required: true
type: string
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
post:
tags:
- cron
summary: Create a cron
description: This creates a cron on the specified branch for the specified repository. It is possible to use the repository id or slug in the request. Content-Type MUST be set in the header and an interval for the cron MUST be specified as a parameter.
operationId: createCronViaId
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: branch.name
in: path
description: Name of the git branch.
required: true
type: string
- name: cron
in: body
description: Cron object
schema:
type: object
required:
- cron.interval
properties:
cron.interval:
type: string
description: 'Interval at which the cron will run (can be "daily", "weekly" or "monthly").'
beta_feature.enabled:
type: boolean
description: Whether a cron build should run if there has been a build on this branch in the last 24 hours.
'/repo/{repository.id}/crons':
get:
tags:
- crons
summary: Get crons of repository
description: This returns a list of crons for an individual repository. It is possible to use the repository id or slug in the request.
operationId: getCrons
responses:
'200':
description: Crons
schema:
$ref: '#/definitions/Crons'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
- name: limit
in: query
description: How many crons to include in the response. Used for pagination.
required: false
type: integer
format: int32
- name: offset
in: query
description: How many crons to skip before the first entry in the response. Used for pagination.
required: false
type: integer
format: int32
'/repo/{repository.id}/env_var/{env_var.id}':
get:
tags:
- envVar
summary: Get env var of repository
description: This returns a single environment variable. It is possible to use the repository id or slug in the request.
operationId: getEnvVar
responses:
'200':
description: EnvVar
schema:
$ref: '#/definitions/EnvVar'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: env_var.id
in: path
description: The environment variable id.
required: true
type: string
- name: env_var.id
in: query
description: The environment variable id.
required: false
type: string
- name: id
in: query
description: Alias for env_var.id.
required: false
type: string
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
- name: repository.id
in: query
description: Value uniquely identifying the repository.
required: false
type: integer
format: int64
patch:
tags:
- envVar
summary: Update an env var
description: This updates a single environment variable. It is possible to use the repository id or slug in the request.
operationId: updateEnvVar
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: env_var.id
in: path
description: The environment variable id.
required: true
type: string
- name: env_var
in: body
description: env var object
schema:
type: object
required:
- env_var.name
- env_var.value
- env_var.public
properties:
env_var.name:
type: string
description: 'The environment variable name, e.g. FOO.'
env_var.value:
type: string
description: 'The environment variable''s value, e.g. bar.'
env_var.public:
type: boolean
description: Whether this environment variable should be publicly visible or not.
delete:
tags:
- envVar
summary: Delete an env var
description: This deletes a single environment variable. It is possible to use the repository id or slug in the request.
operationId: deleteEnvVar
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: env_var.id
in: path
description: The environment variable id.
required: true
type: string
'/repo/{repository.id}/env_vars':
get:
tags:
- envVars
summary: Get env vars of repository
description: This returns a list of environment variables for an individual repository. It is possible to use the repository id or slug in the request.
operationId: getEnvVars
responses:
'200':
description: EnvVars
schema:
$ref: '#/definitions/EnvVars'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
post:
tags:
- envVars
summary: Create an env var
description: This creates an environment variable for an individual repository. It is possible to use the repository id or slug in the request.
operationId: createEnvVarViaId
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: env_var
in: body
description: env var object
schema:
type: object
required:
- env_var.name
- env_var.value
- env_var.public
properties:
env_var.name:
type: string
description: 'The environment variable name, e.g. FOO.'
env_var.value:
type: string
description: 'The environment variable''s value, e.g. bar.'
env_var.public:
type: boolean
description: Whether this environment variable should be publicly visible or not.
'/installation/{installation.github_id}':
get:
tags:
- installation
summary: Get installation info
description: Get installation info.
operationId: getInstallationInfo
responses:
'200':
description: Installation
schema:
$ref: '#/definitions/Installation'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: installation.github_id
in: path
description: The installation's github_id.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
'/job/{job.id}':
get:
tags:
- job
summary: Get job
description: This returns a single job.
operationId: getJob
responses:
'200':
description: Job
schema:
$ref: '#/definitions/Job'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: job.id
in: path
description: Value uniquely identifying the job.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
'/job/{job.id}/cancel':
post:
tags:
- job
summary: Cancel job
description: This cancels a currently running job.
operationId: cancelJob
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: job.id
in: path
description: Value uniquely identifying the job.
required: true
type: integer
format: int64
'/job/{job.id}/restart':
post:
tags:
- job
summary: Restart job
description: This restarts a job that has completed or been canceled.
operationId: restartJob
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: job.id
in: path
description: Value uniquely identifying the job.
required: true
type: integer
format: int64
'/job/{job.id}/debug':
post:
tags:
- job
summary: Debug job
description: 'This restarts a job in debug mode, enabling the logged-in user to ssh into the build VM. Please note this feature is only available on the travis-ci.com domain, and those repositories on the travis-ci.org domain for which the debug feature is enabled. See this document for more details.'
operationId: debugJob
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: job.id
in: path
description: Value uniquely identifying the job.
required: true
type: integer
format: int64
'/build/{build.id}/jobs':
get:
tags:
- jobs
summary: Get jobs of build
description: This returns a list of jobs belonging to an individual build.
operationId: getBuildJobs
responses:
'200':
description: Jobs
schema:
$ref: '#/definitions/Jobs'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: build.id
in: path
description: Value uniquely identifying the build.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
/jobs:
get:
tags:
- jobs
summary: Get jobs
description: This returns a list of jobs a current user has access to.
operationId: getJobs
responses:
'200':
description: Jobs
schema:
$ref: '#/definitions/Jobs'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: active
in: query
description: Alias for job.active.
required: false
type: string
- name: created_by
in: query
description: Alias for job.created_by.
required: false
type: string
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
- name: job.active
in: query
description: <Documentation missing>
required: false
type: string
- name: job.created_by
in: query
description: <Documentation missing>
required: false
type: string
- name: job.state
in: query
description: Filters jobs by current state of the job.
required: false
type: array
items:
type: string
- name: limit
in: query
description: How many jobs to include in the response. Used for pagination.
required: false
type: integer
format: int32
- name: offset
in: query
description: How many jobs to skip before the first entry in the response. Used for pagination.
required: false
type: integer
format: int32
- name: sort_by
in: query
description: Attributes to sort jobs by. Used for pagination.
required: false
type: array
items:
type: string
- name: state
in: query
description: Alias for job.state.
required: false
type: array
items:
type: string
'/repo/{repository.id}/key_pair':
get:
tags:
- keyPair
summary: Get RSA key pair
description: 'Return the current key pair, if it exists.'
operationId: getRSAKeyPair
responses:
'200':
description: KeyPair
schema:
$ref: '#/definitions/KeyPair'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
post:
tags:
- keyPair
summary: Create key pair
description: Creates a new key pair.
operationId: createRSAKeyPair
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: key_pair
in: body
description: key pair object
schema:
type: object
required:
- beta_feature.value
- beta_feature.description
properties:
beta_feature.description:
type: string
description: A text description.
beta_feature.value:
type: string
description: The private key.
patch:
tags:
- keyPair
summary: Update key pair
description: Update the key pair.
operationId: updateRSAKeyPair
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: key_pair
in: body
description: key pair object
schema:
type: object
required:
- beta_feature.value
- beta_feature.description
properties:
beta_feature.description:
type: string
description: A text description.
beta_feature.value:
type: string
description: The private key.
delete:
tags:
- keyPair
summary: Delete key pair
description: Delete the key pair.
operationId: deleteRSAKeyPair
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
'/repo/{repository.id}/key_pair/generated':
get:
tags:
- keyPairGenerated
summary: Get generated RSA key pair
description: Return the current key pair.
operationId: getGeneratedRSAKeyPair
responses:
'200':
description: KeyPair
schema:
$ref: '#/definitions/KeyPair'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
post:
tags:
- keyPairGenerated
summary: Generate and replace key pair
description: 'Generate a new key pair, replacing the previous one.'
operationId: generateNewRSAKeyPairViaId
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
/lint:
post:
tags:
- lint
summary: Validates the .travis.yml file and returns any warnings
description: 'The request body can contain the content of the .travis.yml file directly as a string, eg `foo: bar`.'
operationId: lintTravisYml
responses:
'200':
description: Lint
schema:
$ref: '#/definitions/Lint'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- in: body
name: fileContent
required: true
schema:
type: string
'/job/{job.id}/log':
get:
tags:
- log
summary: Get log of job
description: This returns a single log.
operationId: getJobLog
responses:
'200':
description: Log
schema:
$ref: '#/definitions/Log'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: job.id
in: path
description: Value uniquely identifying the job.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
- name: log.token
in: query
description: <Documentation missing>
required: false
type: string
delete:
tags:
- log
summary: Delete log of job
description: 'This removes the contents of a log. It gets replace with the message: Log removed by XXX at 2017-02-13 16:00:00 UTC.'
operationId: deleteLog
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: job.id
in: path
description: Value uniquely identifying the job.
required: true
type: integer
format: int64
'/job/{job.id}/log.txt':
get:
tags:
- log
summary: Get log of job
description: This returns a single log.
operationId: getPlainJobLog
responses:
'200':
description: Plain-text Log
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: job.id
in: path
description: Value uniquely identifying the job.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
- name: log.token
in: query
description: <Documentation missing>
required: false
type: string
'/repo/{repository.id}/request/{request.id}/messages':
get:
tags:
- messages
summary: List request messages
description: 'This will return a list of messages created by travis-yml for a request, if any exist.'
operationId: listRequestMessages
responses:
'200':
description: Messages
schema:
$ref: '#/definitions/Messages'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: request.id
in: path
description: Value uniquely identifying the request.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
- name: limit
in: query
description: How many messages to include in the response. Used for pagination.
required: false
type: integer
format: int32
- name: offset
in: query
description: How many messages to skip before the first entry in the response. Used for pagination.
required: false
type: integer
format: int32
'/org/{organization.id}':
get:
tags:
- organization
summary: Get organization
description: This returns an individual organization.
operationId: getOrganization
responses:
'200':
description: Organization
schema:
$ref: '#/definitions/Organization'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: organization.id
in: path
description: Value uniquely identifying the organization.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
/orgs:
get:
tags:
- organizations
summary: Get organizations
description: This returns a list of organizations the current user is a member of.
operationId: getOrganizations
responses:
'200':
description: Organizations
schema:
$ref: '#/definitions/Organizations'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
- name: limit
in: query
description: How many organizations to include in the response. Used for pagination.
required: false
type: integer
format: int32
- name: offset
in: query
description: How many organizations to skip before the first entry in the response. Used for pagination.
required: false
type: integer
format: int32
- name: organization.role
in: query
description: <Documentation missing>
required: false
type: string
- name: role
in: query
description: Alias for organization.role.
required: false
type: string
- name: sort_by
in: query
description: Attributes to sort organizations by. Used for pagination.
required: false
type: array
items:
type: string
'/owner/{owner.login}':
get:
tags:
- owner
summary: Get owner
description: This returns an individual owner. It is possible to use the GitHub login or github_id in the request.
operationId: getOwner
responses:
'200':
description: Owner
schema:
$ref: '#/definitions/Owner'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: owner.login
in: path
description: User or organization login set on GitHub.
required: true
type: string
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
'/owner/github_id/{owner.github_id}':
get:
tags:
- owner
summary: Get owner
description: This returns an individual owner. It is possible to use the GitHub login or github_id in the request.
operationId: getOwnerGitHubUser
responses:
'200':
description: Owner
schema:
$ref: '#/definitions/Owner'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: owner.github_id
in: path
description: User or organization id set on GitHub.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
'/owner/{owner.login}/repos':
get:
tags:
- repositories
summary: Get owner's repositories
description: This returns a list of repositories an owner has access to.
operationId: getOwnerRepositories
responses:
'200':
description: Repositories
schema:
$ref: '#/definitions/Repositories'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: owner.login
in: path
description: User or organization login set on GitHub.
required: true
type: string
- name: active
in: query
description: Alias for repository.active.
required: false
type: array
items:
type: boolean
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
- name: limit
in: query
description: How many repositories to include in the response. Used for pagination.
required: false
type: integer
format: int32
- name: managed_by_installation
in: query
description: Alias for repository.managed_by_installation.
required: false
type: boolean
- name: offset
in: query
description: How many repositories to skip before the first entry in the response. Used for pagination.
required: false
type: integer
format: int32
- name: private
in: query
description: Alias for repository.private.
required: false
type: array
items:
type: boolean
- name: repository.active
in: query
description: Filters repositories by whether or not this repository is currently enabled on Travis CI.
required: false
type: array
items:
type: boolean
- name: repository.managed_by_installation
in: query
description: Filters repositories by the repository's managed_by_installation.
required: false
type: boolean
- name: repository.private
in: query
description: Filters repositories by whether or not this repository is private.
required: false
type: array
items:
type: boolean
- name: repository.starred
in: query
description: Filters repositories by whether or not this repository is starred.
required: false
type: array
items:
type: boolean
- name: sort_by
in: query
description: Attributes to sort repositories by. Used for pagination.
required: false
type: array
items:
type: string
- name: starred
in: query
description: Alias for repository.starred.
required: false
type: array
items:
type: boolean
'/owner/github_id/{owner.github_id}/repos':
get:
tags:
- repositories
summary: Get owner's repositories
description: This returns a list of repositories an owner has access to.
operationId: getOwnerGitHubUserRepositories
responses:
'200':
description: Repositories
schema:
$ref: '#/definitions/Repositories'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: owner.github_id
in: path
description: User or organization id set on GitHub.
required: true
type: integer
format: int64
- name: active
in: query
description: Alias for repository.active.
required: false
type: array
items:
type: boolean
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
- name: limit
in: query
description: How many repositories to include in the response. Used for pagination.
required: false
type: integer
format: int32
- name: managed_by_installation
in: query
description: Alias for repository.managed_by_installation.
required: false
type: boolean
- name: offset
in: query
description: How many repositories to skip before the first entry in the response. Used for pagination.
required: false
type: integer
format: int32
- name: private
in: query
description: Alias for repository.private.
required: false
type: array
items:
type: boolean
- name: repository.active
in: query
description: Filters repositories by whether or not this repository is currently enabled on Travis CI.
required: false
type: array
items:
type: boolean
- name: repository.managed_by_installation
in: query
description: Filters repositories by the repository's managed_by_installation.
required: false
type: boolean
- name: repository.private
in: query
description: Filters repositories by whether or not this repository is private.
required: false
type: array
items:
type: boolean
- name: repository.starred
in: query
description: Filters repositories by whether or not this repository is starred.
required: false
type: array
items:
type: boolean
- name: sort_by
in: query
description: Attributes to sort repositories by. Used for pagination.
required: false
type: array
items:
type: string
- name: starred
in: query
description: Alias for repository.starred.
required: false
type: array
items:
type: boolean
/repos:
get:
tags:
- repositories
summary: Get repositories
description: This returns a list of repositories the current user has access to.
operationId: getRepositories
responses:
'200':
description: Repositories
schema:
$ref: '#/definitions/Repositories'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: active
in: query
description: Alias for repository.active.
required: false
type: array
items:
type: boolean
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
- name: limit
in: query
description: How many repositories to include in the response. Used for pagination.
required: false
type: integer
format: int32
- name: managed_by_installation
in: query
description: Alias for repository.managed_by_installation.
required: false
type: boolean
- name: offset
in: query
description: How many repositories to skip before the first entry in the response. Used for pagination.
required: false
type: integer
format: int32
- name: private
in: query
description: Alias for repository.private.
required: false
type: array
items:
type: boolean
- name: repository.active
in: query
description: Filters repositories by whether or not this repository is currently enabled on Travis CI.
required: false
type: array
items:
type: boolean
- name: repository.managed_by_installation
in: query
description: Filters repositories by the repository's managed_by_installation.
required: false
type: boolean
- name: repository.private
in: query
description: Filters repositories by whether or not this repository is private.
required: false
type: array
items:
type: boolean
- name: repository.starred
in: query
description: Filters repositories by whether or not this repository is starred.
required: false
type: array
items:
type: boolean
- name: sort_by
in: query
description: Attributes to sort repositories by. Used for pagination.
required: false
type: array
items:
type: string
- name: starred
in: query
description: Alias for repository.starred.
required: false
type: array
items:
type: boolean
'/repo/{repository.id}':
get:
tags:
- repository
summary: Get repository
description: This returns an individual repository.
operationId: getRepository
responses:
'200':
description: Repository
schema:
$ref: '#/definitions/Repository'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
'/repo/{repository.id}/activate':
post:
tags:
- repository
summary: Activate a repository
description: 'This will activate a repository, allowing its tests to be run on Travis CI.'
operationId: activateRepository
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
'/repo/{repository.id}/deactivate':
post:
tags:
- repository
summary: Deactivate a repository
description: 'This will deactivate a repository, preventing any tests from running on Travis CI.'
operationId: deactivateRepository
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
'/repo/{repository.id}/star':
post:
tags:
- repository
summary: Star a repository
description: This will star a repository based on the currently logged in user.
operationId: starRepository
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
'/repo/{repository.id}/unstar':
post:
tags:
- repository
summary: Unstar a repository
description: This will unstar a repository based on the currently logged in user.
operationId: unstarRepository
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
'/repo/{repository.id}/request/{request.id}':
get:
tags:
- request
summary: Get request info
description: Get request info.
operationId: getRequestInfo
responses:
'200':
description: Request
schema:
$ref: '#/definitions/Request'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: request.id
in: path
description: Value uniquely identifying the request.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
'/repo/{repository.id}/requests':
get:
tags:
- requests
summary: Get requests of a repository
description: This will return a list of requests belonging to a repository.
operationId: getRepositoryRequests
responses:
'200':
description: Requests
schema:
$ref: '#/definitions/Requests'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
- name: limit
in: query
description: How many requests to include in the response. Used for pagination.
required: false
type: integer
format: int32
- name: offset
in: query
description: How many requests to skip before the first entry in the response. Used for pagination.
required: false
type: integer
format: int32
post:
tags:
- requests
summary: Create a request for a repository
description: 'This will create a request for an individual repository, triggering a build to run on Travis CI.'
operationId: createRequest
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: request
in: body
description: request object
schema:
type: object
required:
- request.config
- request.message
- request.branch
- request.token
properties:
request.config:
type: string
description: Build configuration (as parsed from .travis.yml).
request.message:
type: string
description: Travis-ci status message attached to the request.
request.branch:
type: string
description: Branch requested to be built.
request.token:
type: string
description: Travis token associated with webhook on GitHub (DEPRECATED).
'/repo/{repository.id}/setting/{setting.name}':
get:
tags:
- setting
summary: Get a setting of repository
description: This returns a single setting. It is possible to use the repository id or slug in the request.
operationId: getRepositorySetting
responses:
'200':
description: Setting
schema:
$ref: '#/definitions/Setting'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: setting.name
in: path
description: The setting's name.
required: true
type: string
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
patch:
tags:
- setting
summary: Update a setting of repository
description: This updates a single setting. It is possible to use the repository id or slug in the request.
operationId: updateRepositorySetting
responses:
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: setting.name
in: path
description: The setting's name.
required: true
type: string
- name: request
in: body
description: request object
schema:
type: object
required:
- request.config
- request.message
- request.branch
- request.token
properties:
request.config:
type: string
description: Build configuration (as parsed from .travis.yml).
request.message:
type: string
description: Travis-ci status message attached to the request.
request.branch:
type: string
description: Branch requested to be built.
request.token:
type: string
description: Travis token associated with webhook on GitHub (DEPRECATED).
'/repo/{repository.id}/settings':
get:
tags:
- settings
summary: Get settings of repository
description: This returns a list of the settings for that repository. It is possible to use the repository id or slug in the request.
operationId: getRepositorySettings
responses:
'200':
description: Settings
schema:
$ref: '#/definitions/Settings'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: repository.id
in: path
description: Value uniquely identifying the repository.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
'/build/{build.id}/stages':
get:
tags:
- stages
summary: Get stages of build
description: This returns a list of stages belonging to an individual build.
operationId: getBuildStages
responses:
'200':
description: Stages
schema:
$ref: '#/definitions/Stages'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: build.id
in: path
description: Value uniquely identifying the build.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
'/user/{user.id}':
get:
tags:
- user
summary: Get user
description: This will return information about an individual user.
operationId: getUser
responses:
'200':
description: User
schema:
$ref: '#/definitions/User'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: user.id
in: path
description: Value uniquely identifying the user.
required: true
type: integer
format: int64
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
'/user/{user.id}/sync':
post:
tags:
- user
summary: Sync user account info
description: This triggers a sync on a user's account with their GitHub account.
operationId: syncUserAccountInfo
responses:
'200':
description: User
schema:
$ref: '#/definitions/User'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: user.id
in: path
description: Value uniquely identifying the user.
required: true
type: integer
format: int64
/user:
get:
tags:
- user
summary: Get user info
description: This will return information about the current user.
operationId: getUserInfo
responses:
'200':
description: User
schema:
$ref: '#/definitions/User'
'403':
description: Login required
'404':
description: Method not allowed
'405':
description: Resource not found (or insufficient access)
parameters:
- name: include
in: query
description: List of attributes to eager load.
required: false
type: array
items:
type: string
securityDefinitions:
travisToken:
type: basic
security:
- travisToken: []
definitions:
Active:
type: object
properties:
builds:
$ref: '#/definitions/Builds'
description: The active builds.
BetaFeature:
type: object
properties:
id:
type: integer
format: int64
description: Value uniquely identifying the beta feature.
name:
type: string
description: The name of the feature.
description:
type: string
description: Longer description of the feature.
enabled:
type: boolean
description: Indicates if the user has this feature turned on.
feedback_url:
type: string
description: Url for users to leave Travis CI feedback on this feature.
BetaFeatures:
type: object
properties:
beta_features:
$ref: '#/definitions/BetaFeature'
description: List of betaFeatures.
Branch:
type: object
properties:
name:
type: string
description: Name of the git branch.
repository:
$ref: '#/definitions/Repository'
description: GitHub user or organization the branch belongs to.
default_branch:
type: boolean
description: Whether or not this is the resposiotry's default branch.
exists_on_github:
type: boolean
description: Whether or not the branch still exists on GitHub.
last_build:
$ref: '#/definitions/Build'
description: Last build on the branch.
recent_builds:
type: array
items:
$ref: '#/definitions/Build'
description: Last 10 builds on the branch (when `include=branch.recent_builds` is used).
Branches:
type: object
properties:
branches:
type: array
items:
$ref: '#/definitions/Branch'
description: List of branches.
Broadcast:
type: object
properties:
id:
type: integer
format: int64
description: Value uniquely identifying the broadcast.
message:
type: string
description: Message to display to the user.
category:
type: string
description: Broadcast category (used for icon and color).
active:
type: boolean
description: Whether or not the brodacast should still be displayed.
recipient:
$ref: '#/definitions/User'
description: 'Either a user, organization or repository, or null for global.'
created_at:
type: string
description: When the broadcast was created.
Broadcasts:
type: object
properties:
broadcasts:
type: array
items:
$ref: '#/definitions/Broadcast'
description: List of broadcasts.
id:
type: integer
format: int64
description: Value uniquely identifying the broadcast.
message:
type: string
description: Message to display to the user.
category:
type: string
description: Broadcast category (used for icon and color).
active:
type: boolean
description: Whether or not the brodacast should still be displayed.
recipient:
$ref: '#/definitions/User'
description: 'Either a user, organization or repository, or null for global.'
created_at:
type: string
description: When the broadcast was created.
Build:
type: object
properties:
id:
type: integer
format: int64
description: Value uniquely identifying the build.
number:
type: string
description: Incremental number for a repository's builds.
state:
type: string
description: Current state of the build.
duration:
type: integer
format: int32
description: Wall clock time in seconds.
repository:
$ref: '#/definitions/Repository'
description: GitHub user or organization the build belongs to.
branch:
$ref: '#/definitions/Branch'
description: The branch the build is associated with.
tag:
type: string
description: The build's tag.
commit:
$ref: '#/definitions/Commit'
description: The commit the build is associated with.
jobs:
$ref: '#/definitions/Jobs'
description: List of jobs that are part of the build's matrix.
stages:
type: array
items:
$ref: '#/definitions/Stage'
description: The stages of a build.
event_type:
type: string
description: Event that triggered the build.
previous_state:
type: string
description: State of the previous build (useful to see if state changed).
pull_request_title:
type: string
description: Title of the build's pull request.
pull_request_number:
type: integer
format: int64
description: Number of the build's pull request.
started_at:
type: string
description: When the build started.
finished_at:
type: string
description: When the build finished.
created_by:
$ref: '#/definitions/Owner'
description: The User or Organization that created the build.
updated_at:
type: string
description: The build's updated_at.
Builds:
type: object
properties:
builds:
type: array
items:
$ref: '#/definitions/Build'
description: List of builds.
Caches:
type: object
properties:
branch:
type: string
description: The branch the cache belongs to.
match:
type: string
description: The string to match against the cache name.
Commit:
type: object
properties:
id:
type: integer
format: int64
description: Value uniquely identifying the commit.
sha:
type: string
description: Checksum the commit has in git and is identified by.
ref:
type: string
description: Named reference the commit has in git.
message:
type: string
description: Commit mesage.
committer:
$ref: '#/definitions/User'
description: Committer data.
author:
$ref: '#/definitions/User'
description: Committer data.
compare_url:
type: string
description: URL to the commit's diff on GitHub.
committed_at:
type: string
description: Commit date from git.
Cron:
type: object
properties:
id:
type: integer
format: int64
description: Value uniquely identifying the cron.
repository:
$ref: '#/definitions/Repository'
description: Github repository to which this cron belongs.
branch:
$ref: '#/definitions/Branch'
description: Git branch of repository to which this cron belongs.
interval:
type: string
description: 'Interval at which the cron will run (can be "daily", "weekly" or "monthly").'
dont_run_if_recent_build_exists:
type: boolean
description: Whether a cron build should run if there has been a build on this branch in the last 24 hours.
last_run:
type: string
description: When the cron ran last.
next_run:
type: string
description: When the cron is scheduled to run next.
created_at:
type: string
description: When the cron was created.
Crons:
type: object
properties:
crons:
type: array
items:
$ref: '#/definitions/Cron'
description: List of crons.
EnvVar:
type: object
properties:
id:
type: string
description: The environment variable id.
name:
type: string
description: 'The environment variable name, e.g. FOO.'
value:
type: string
description: 'The environment variable''s value, e.g. bar.'
public:
type: boolean
description: Whether this environment variable should be publicly visible or not.
EnvVars:
type: object
properties:
env_vars:
$ref: '#/definitions/EnvVar'
description: List of env_vars.
Error:
type: object
properties:
permission:
type: string
description: The error's permission.
error_type:
type: string
description: The error's type.
error_message:
type: string
description: The error's message.
resource_type:
type: string
description: The error's resource type.
Installation:
type: object
properties:
id:
type: integer
format: int64
description: The installation's id.
owner:
$ref: '#/definitions/Owner'
description: The installation's owner.
github_id:
type: integer
format: int64
description: The installation's github_id.
Job:
type: object
properties:
id:
type: integer
format: int64
description: Value uniquely identifying the job.
number:
type: string
description: Incremental number for a repository's builds.
state:
type: string
description: Current state of the job.
build:
$ref: '#/definitions/Build'
description: The build the job is associated with.
queue:
type: string
description: Worker queue this job is/was scheduled on.
repository:
$ref: '#/definitions/Repository'
description: GitHub user or organization the job belongs to.
commit:
$ref: '#/definitions/Commit'
description: The commit the job is associated with.
owner:
$ref: '#/definitions/Owner'
description: GitHub user or organization the job belongs to.
stage:
type: array
items:
$ref: '#/definitions/Stage'
description: The stages of a job.
allow_failure:
type: boolean
description: The job's allow_failure.
started_at:
type: string
description: When the job started.
finished_at:
type: string
description: When the job finished.
created_at:
type: string
description: When the job was created.
updated_at:
type: string
description: When the job was updated.
Jobs:
type: object
properties:
jobs:
type: array
items:
$ref: '#/definitions/Job'
description: List of jobs.
KeyPair:
type: object
properties:
description:
type: string
description: A text description.
fingerprint:
type: string
description: The fingerprint.
public_key:
type: string
description: The public key.
Lint:
type: object
properties:
warnings:
type: array
items:
type: string
description: An array of hashes with keys and warnings.
Log:
type: object
properties:
id:
type: integer
format: int64
description: The log's id.
content:
type: string
description: The log's content.
log_parts:
type: array
items:
type: string
description: The log's log_parts.
Message:
type: object
properties:
id:
type: integer
format: int64
description: The message's id.
level:
type: string
description: The message's level.
key:
type: string
description: The message's key.
code:
type: string
description: The message's code.
args:
type: array
items:
type: string
description: The message's args.
Messages:
type: object
properties:
messages:
type: array
items:
$ref: '#/definitions/Message'
description: List of messages.
Organization:
type: object
properties:
id:
type: integer
format: int64
description: Value uniquely identifying the organization.
login:
type: string
description: Login set on GitHub.
name:
type: string
description: Name set on GitHub.
education:
type: boolean
description: The organization's education.
repositories:
type: array
items:
$ref: '#/definitions/Repository'
description: Repositories belonging to this organization.
installation:
$ref: '#/definitions/Installation'
description: The organization's installation.
github_id:
type: integer
format: int64
description: The organization's github_id.
avatar_url:
type: string
description: Avatar_url set on GitHub.
Organizations:
type: object
properties:
organizations:
type: array
items:
$ref: '#/definitions/Organization'
description: List of organizations.
Owner:
type: object
properties:
id:
type: integer
format: int64
description: Value uniquely identifying the owner.
login:
type: string
description: User or organization login set on GitHub.
name:
type: string
description: User or organization name set on GitHub.
education:
type: boolean
description: The owner's education.
repositories:
type: array
items:
$ref: '#/definitions/Repository'
description: Repositories belonging to this account.
installation:
$ref: '#/definitions/Installation'
description: The owner's installation.
github_id:
type: integer
format: int64
description: User or organization id set on GitHub.
avatar_url:
type: string
description: Link to user or organization avatar (image) set on GitHub.
Repositories:
type: object
properties:
repositories:
type: array
items:
$ref: '#/definitions/Repository'
description: List of repositories.
Repository:
type: object
properties:
id:
type: integer
format: int64
description: Value uniquely identifying the repository.
name:
type: string
description: The repository's name on GitHub.
slug:
type: string
description: 'Same as {repository.owner.name}/{repository.name}.'
description:
type: string
description: The repository's description from GitHub.
active:
type: boolean
description: Whether or not this repository is currently enabled on Travis CI.
private:
type: boolean
description: Whether or not this repository is private.
owner:
$ref: '#/definitions/Owner'
description: GitHub user or organization the repository belongs to.
starred:
type: boolean
description: Whether or not this repository is starred.
github_id:
type: integer
format: int64
description: The repository's github_id.
github_language:
type: string
description: The main programming language used according to GitHub.
default_branch:
$ref: '#/definitions/Branch'
description: The default branch on GitHub.
managed_by_installation:
type: boolean
description: The repository's managed_by_installation.
active_on_org:
type: string
description: The repository's active_on_org.
Request:
type: object
properties:
id:
type: integer
format: int64
description: Value uniquely identifying the request.
state:
type: string
description: The state of a request (eg. whether it has been processed or not).
result:
type: string
description: The result of the request (eg. rejected or approved).
message:
type: string
description: Travis-ci status message attached to the request.
repository:
$ref: '#/definitions/Repository'
description: GitHub user or organization the request belongs to.
commit:
$ref: '#/definitions/Commit'
description: The commit the request is associated with.
builds:
$ref: '#/definitions/Builds'
description: The request's builds.
owner:
$ref: '#/definitions/Owner'
description: GitHub user or organization the request belongs to.
branch_name:
type: string
description: Name of the branch requested to be built.
created_at:
type: string
description: When Travis CI created the request.
event_type:
type: string
description: 'Origin of request (push, pull request, api).'
Requests:
type: object
properties:
requests:
type: array
items:
$ref: '#/definitions/Request'
description: List of requests.
Setting:
type: object
properties:
name:
type: string
description: The setting's name.
value:
type: integer
format: int32
description: The setting's value.
Settings:
type: object
properties:
settings:
type: array
items:
$ref: '#/definitions/Setting'
description: List of settings.
Stage:
type: object
properties:
id:
type: integer
format: int64
description: Value uniquely identifying the stage.
number:
type: integer
format: int32
description: Incremental number for a stage.
name:
type: string
description: The name of the stage.
state:
type: string
description: Current state of the stage.
jobs:
type: array
items:
$ref: '#/definitions/Job'
description: The jobs of a stage.
started_at:
type: string
description: When the stage started.
finished_at:
type: string
description: When the stage finished.
Stages:
type: object
properties:
stages:
type: array
items:
$ref: '#/definitions/Stage'
description: List of stages.
User:
type: object
properties:
id:
type: integer
format: int64
description: Value uniquely identifying the user.
login:
type: string
description: Login set on Github.
name:
type: string
description: Name set on GitHub.
education:
type: boolean
description: The user's education.
repositories:
type: array
items:
$ref: '#/definitions/Repository'
description: Repositories belonging to this user.
installation:
$ref: '#/definitions/Installation'
description: The user's installation.
github_id:
type: integer
format: int64
description: Id set on GitHub.
avatar_url:
type: string
description: Avatar URL set on GitHub.
is_syncing:
type: boolean
description: Whether or not the user is currently being synced with Github.
synced_at:
type: string
description: The last time the user was synced with GitHub.
externalDocs:
description: Find out more about Travis CI
url: 'https://docs.travis-ci.com/'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment