REST API Suggestions

cyberunner23's Avatar


15 Jan, 2016 12:55 AM

Hello, I have some suggestions for the REST API:

  • Add documentation for /api/repositories/* (Unless it already exists and I can't find it somehow?), I am making a little program that needs to get the list of repos through the AppVeyor API (The user wont need to retrieve an API key for github, bitbucket and so on.)

  • Combine all the /api/repositories/* call together (As far as I am aware, this does not exist), essentially to have all the repos from the different scm/repository providers (github, bitbucket and so on) in one api call. I also suggest doing so by adding a "scmProvider"/"repositoryProvider" field right after the "scmType" field in the "repositories" array, or perhaps put the scm/repository provider with the "name", "avatarUrl", "groupTypes", "repositories" fields and so on.

  • Finally, add a field that tells us if the repo has been added to AppVeyor (Won't have to get /api/repositories/* and /api/projects and manually compare which ones are added.)

I also noted that in /api/repositories/github (Haven't checked the others) each repository has an id of 0 (Can perhaps use this id and use it to add the repository to AppVeyor instead of using "repositoryProvider" and "repositoryName" in POST /api/projects)

  1. 1 Posted by cyberunner23 on 15 Jan, 2016 01:02 AM

    cyberunner23's Avatar

    In addition I think that having example responses from the API calls in the documentation would be a nice addition.

  2. Ilya Finkelshteyn closed this discussion on 25 Aug, 2018 02:03 AM.

Comments are currently closed for this discussion. You can start a new one.

Keyboard shortcuts


? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac