{"note":"OpenAPI conversion -- returning structured metadata","name":"circleci-com","description":"CircleCI REST API","version":"v1","base_url":"https://circleci.com/api/v1","endpoints":22,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api CircleCI REST API\n@base https://circleci.com/api/v1\n@version v1\n@auth ApiKey circle-token in query\n@endpoints 22\n@hint download_for_search\n@toc me(1), projects(1), project(18), recent-builds(1), user(1)\n\n@group me\n@endpoint GET /me\n@desc Provides information about the signed in user.\n@returns(200) signed in user\n\n@endgroup\n\n@group projects\n@endpoint GET /projects\n@desc List of all the projects you're following on CircleCI, with build information organized by branch.\n@returns(200) List of all the projects you're following on CircleCI\n\n@endgroup\n\n@group project\n@endpoint GET /project/{username}/{project}\n@desc Build summary for each of the last 30 builds for a single git repo.\n@optional {limit: any # The number of builds to return. Maximum 100, defaults to 30., offset: any # The API returns builds starting from this offset, defaults to 0., filter: any # Restricts which builds are returned. Set to \"completed\", \"successful\", \"failed\", \"running\", or defaults to no filter.}\n@returns(200) Build summary for each of the last 30 builds\n\n@endpoint POST /project/{username}/{project}\n@desc Triggers a new build, returns a summary of the build.\n@optional {body: map}\n@returns(201) returns a summary of the build\n\n@endgroup\n\n@group recent-builds\n@endpoint GET /recent-builds\n@desc Build summary for each of the last 30 recent builds, ordered by build_num.\n@optional {limit: any # The number of builds to return. Maximum 100, defaults to 30., offset: any # The API returns builds starting from this offset, defaults to 0.}\n@returns(200) Build summary for each of the last 30 recent builds\n\n@endgroup\n\n@group project\n@endpoint GET /project/{username}/{project}/{build_num}\n@desc Full details for a single build. The response includes all of the fields from the build summary.\n@returns(200) Full details for a single build\n\n@endpoint GET /project/{username}/{project}/{build_num}/artifacts\n@desc List the artifacts produced by a given build.\n@returns(200) List the artifacts produced by a given build\n\n@endpoint POST /project/{username}/{project}/{build_num}/retry\n@desc Retries the build, returns a summary of the new build.\n@returns(200) returns a summary of the new build\n\n@endpoint POST /project/{username}/{project}/{build_num}/cancel\n@desc Cancels the build, returns a summary of the build.\n@returns(200) returns a summary of the build\n\n@endpoint GET /project/{username}/{project}/{build_num}/tests\n@desc Provides test metadata for a build\n@returns(200) test metadata for a build\n\n@endpoint POST /project/{username}/{project}/tree/{branch}\n@desc Triggers a new build, returns a summary of the build.\n@optional {body: map}\n@returns(201) returns a summary of the build\n\n@endpoint POST /project/{username}/{project}/ssh-key\n@desc Create an ssh key used to access external systems that require SSH key-based authentication\n@required {Content-Type: any, body: map}\n\n@endpoint GET /project/{username}/{project}/checkout-key\n@desc Lists checkout keys.\n@returns(200) checkout keys\n\n@endpoint POST /project/{username}/{project}/checkout-key\n@desc Creates a new checkout key.\n@optional {type: str(deploy-key/github-user-key) # The type of key to create. Can be 'deploy-key' or 'github-user-key'.}\n@returns(200) checkout key\n\n@endpoint GET /project/{username}/{project}/checkout-key/{fingerprint}\n@desc Get a checkout key.\n@returns(200) checkout key\n\n@endpoint DELETE /project/{username}/{project}/checkout-key/{fingerprint}\n@desc Delete a checkout key.\n@returns(200) status message\n\n@endpoint DELETE /project/{username}/{project}/build-cache\n@desc Clears the cache for a project.\n@returns(200) status message\n\n@endpoint GET /project/{username}/{project}/envvar\n@desc Lists the environment variables for :project\n@returns(200) XXX\n\n@endpoint POST /project/{username}/{project}/envvar\n@desc Creates a new environment variable\n@returns(200) XXX\n\n@endpoint GET /project/{username}/{project}/envvar/{name}\n@desc Gets the hidden value of environment variable :name\n@returns(200) XXX\n\n@endpoint DELETE /project/{username}/{project}/envvar/{name}\n@desc Deletes the environment variable named ':name'\n@returns(200) Deletes the environment variable named ':name'\n\n@endgroup\n\n@group user\n@endpoint POST /user/heroku-key\n@desc Adds your Heroku API key to CircleCI, takes apikey as form param name.\n@errors {403: Your Heroku API key is invalid.}\n\n@endgroup\n\n@end\n"}