It reads:

Update pipeline config for specified pipeline name.

The backup api returns a user summary object, not a user object.

Need to update the entire backup api section.

Document pipeline config API v7 along with pipeline export newer endpoint.

\cc: @marques-work @ibnc @kierarad

As the title states, the example for authenticating against the API doesn't work as written. Changing it to v2 (or v3) makes it work.

vagrant@vagrant-ubuntu-trusty-64:~$ curl -k 'https://localhost:8154/go/api/agents' -u 'user:user' -H 'Accept: application/vnd.go.cd.v1+json'
{
  "message": "The resource you requested was not found!"
}

vagrant@vagrant-ubuntu-trusty-64:~$ curl -k 'https://localhost:8154/go/api/agents' -u 'user:user' -H 'Accept: application/vnd.go.cd.v2+json'
{
  "_links": {
    "self": {
      "href": "https://localhost:8154/go/api/agents"
    },
    "doc": {
      "href": "https://api.go.cd/#agents"
    }
  },
<snip>

Hi,

the documentation for (Get server health messages)[https://api.gocd.org/19.5.0/#get-server-health-messages] omits the fact, that you have to be authenticated to access the messages.

curl 'http://127.0.0.1:8153/go/api/server_health_messages' -u 'admin:admin' -H 'Accept: application/vnd.go.cd.v1+json'returns a json list of messages.

Whereas curl 'http://127.0.0.1:8153/go/api/server_health_messages' -H 'Accept: application/vnd.go.cd.v1+json' just says:

{
  "message": "You are not authenticated!"
}

Greets
Joachim

Hi,

It is not quite clear that when a plugin is loaded into the GoCD server that a base plugin settings object is not created.

Running a get plugin settings api call will result in a 404, until a user creates plugin settings in the UI, or runs create plugin settings.

This led to some confusion and if clarified will make it easier for developers to evaluate the service when considering automated plugin settings creation.

Thanks!

Objects represented via describe_object may have fields that are nullable.

Depending on the programming language (Python has None, TypeScript has null, Go has nil, etc) there are cases where this nullability is important, so it would be nice if nullable fields are well documented.

e.g.

http://api.go.cd/#get-pipeline-history

It's currently

GET /go/pipelines/:pipeline_name/instance/:pipeline_counter

should be

GET /go/api/pipelines/:pipeline_name/instance/:pipeline_counter

Applicable to other places, too.

Hi,

In the documentation for Get Maintenance Mode Info the API URL is /go/api/maintenance_mode/info. Correctly it should be /go/api/admin/maintenance_mode/info. At least, I get results there:

curl 'http://127.0.0.1:8153/go/api/admin/maintenance_mode/info' -u 'admin:admin' -H 'Accept: application/vnd.go.cd.v1+json' 

Returns

{
  "_links" : {
    "self" : {
      "href" : "http://127.0.0.1:8153/go/api/admin/maintenance_mode/info"
    },
    "doc" : {
      "href" : "https://api.gocd.org/19.5.0/#maintenance-mode-info"
    }
  },
  "is_maintenance_mode" : false,
  "metadata" : {
    "updated_by" : "admin",
    "updated_on" : "2019-07-16T10:55:14Z"
  }
}

This URL is also consistent with the ones for enabling and disabling the maintenance mode.

Greets
Joachim

It's linked in a couple of places for the plugin info objects:

https://api.gocd.org/current/#the-elastic-agent-extension-info-object

The documentation states that you can use /go/api/admin/config/config.xml to get the configuration XML, and that /go/api/admin/config/current.xml is an alternative. I could not get the former to work, receiving a null pointer exception. In the logs I could see that it was interpreting config as an md5 version. Using the current.xml version worked perfectly. Are the docs on this line wrong?

gocd/gocd#4256

Update Dashboard API doc as part of #1644.

We have only documented arguments which is an array. But there is also an args property that needs to be documented

\cc: @akshaydewan vrushali @ketan

I was not able to get the example GoCD authentication code to work using a recent version of GoCD. It specifies the following CURL command which will return a 404:

https://api.gocd.org/current/#basic-authentication

After digging around for awhile I found this under the agents saying the minimum JSON API version should be 4 for /go/api/agents:

After changing the accept header to application/vnd.go.cd.v4+json, the requests works fine. I'm not sure if there is something I'm missing here or if this is just an omission.

Can you please fix description of getting specific SCM object in documentation?
Right now it reads

Lists all available pluggable scm materials, these are materials that are present in the in cruise-config.xml.

which is description of listing all SCM objects.

\cc: @ketan vrushali @akshaydewan

Currently only the regular SCM material webhook APIs are documented; but not the /config_repos/:id variants introduced in 21.1.10 and gocd/gocd#8023

api.go.cd is the canonical URL for latest api documentation. However it is confusing for users who land there from a google search but are using an older version of go.

I'd like to propose something like to help point users in the right direction.

Open questions:

• Clearly some of these APIs have been available for a while, in a different format. What should "available since" say in such cases?
• Some APIs for e.g. "update agent" were multiple calls in the older API (delete, disable, enable) how do we deal with such cases?

WDYT?

I have been trying to access the agents from gocd in my project. But the url specified in the api docs keeps giving back a 404 error

curl -u username:password http://gocdurl:port/go/api/agents

Response:

The documentation for Get Plugin Settings should describe the behavior as discussed in gocd/gocd#6631.

The documentation for Create Plugin Settings should contain information on how to learn about which fields are in the settings for a plugin. This can be done via Get plugin info and the fields extensions/plugin_settings/configurations from the result.

Currently, the APIs only seem to support retrieving when a pipeline stage job starts, but not when a job ends, or a duration for how long it took. Feel free to let me know if there's somewhere to get this information if I've just missed it. Thanks!

\cc: @marques-work @kierarad @ibnc

\cc: @akshaydewan @ketan vrushali

Hi,

when trying to install middleman by executing bundle install --path .bundle --binstubs i need bundler in Version 1.17.2 (at least 2.0.2) does not work. Could you add this piece of information for ruby noobs?

Regards
Joachim

Dependabot was set up to create pull requests against the branch main, but couldn't find it.

If the branch has been permanently deleted you can update Dependabot's target branch from your dashboard.

View the update logs.

Hello,

I recently updated the version of my GoCD server from 19.5.0 to 20.1.0 version.
Everything goes well except that I cannot access to pipeline groups listing (https://api.gocd.org/current/#config-listing).

REQUEST:

curl --location --request GET 'http://localhost:8153/go/api/config/pipeline_groups' \
--header 'Authorization: bearer <MY_TOKEN>'

RESPONSE:

404 Not Found
{
    "message": "Either the resource you requested was not found, or you are not authorized to perform this action."
}

What I am missing?

Thank you for your help,
Best regards,
Granyy

The environment config update call does not have the section that explains why the If-Match header is needed, we've got this explanation in a few other places in the API docs, might be useful to extract it into a partial and include it everywhere it's needed.