Update API reference
This commit is contained in:
Michael McCaskill
parent
5df68a661e
commit
2524980735
144
README.asc
144
README.asc
|
|
@ -14,6 +14,8 @@ Plugin information sources include:
|
|||
** Main source of plugin data
|
||||
* Jenkins Stats
|
||||
** Installation statistics
|
||||
* Jenkins Wiki
|
||||
** Scrape wiki content
|
||||
|
||||
Elasticsearch mappings and data are initialized at runtime using a temporary
|
||||
directory that is cleaned up at shutdown. The data is generated via separate
|
||||
|
|
@ -87,7 +89,7 @@ Sample Response
|
|||
|
||||
=== GET /developers
|
||||
|
||||
Retrieve unique developers in the plugin data.
|
||||
Retrieve unique developer names in the plugin data.
|
||||
|
||||
Sample Response
|
||||
----
|
||||
|
|
@ -218,12 +220,16 @@ Sample Response
|
|||
"percentage": 0
|
||||
},
|
||||
...
|
||||
]
|
||||
],
|
||||
"lifetime": 89232,
|
||||
"trend": 2990
|
||||
},
|
||||
"title": "Jenkins Git plugin",
|
||||
"url": "http://updates.jenkins-ci.org/download/plugins/git/2.5.2/git.hpi",
|
||||
"version": "2.5.2",
|
||||
"wiki": "https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin"
|
||||
"wiki": {
|
||||
"content": <HTML content>,
|
||||
"url": "https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin"
|
||||
}
|
||||
----
|
||||
|
||||
|
|
@ -318,12 +324,16 @@ Sample Response
|
|||
"percentage": 0
|
||||
},
|
||||
...
|
||||
]
|
||||
],
|
||||
"lifetime": 89232,
|
||||
"trend": 2990
|
||||
},
|
||||
"title": "Jenkins Git plugin",
|
||||
"url": "http://updates.jenkins-ci.org/download/plugins/git/2.5.2/git.hpi",
|
||||
"version": "2.5.2",
|
||||
"wiki": "https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin"
|
||||
"wiki": {
|
||||
"url": "https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin"
|
||||
}
|
||||
},
|
||||
...
|
||||
],
|
||||
|
|
@ -332,9 +342,9 @@ Sample Response
|
|||
}
|
||||
----
|
||||
|
||||
=== GET /plugins/downloaded
|
||||
=== GET /plugins/installed
|
||||
|
||||
Get top "limit" downloaded plugins
|
||||
Get top "limit" install plugins
|
||||
|
||||
.Parameters
|
||||
[options="header,footer"]
|
||||
|
|
@ -345,7 +355,7 @@ Get top "limit" downloaded plugins
|
|||
|
||||
Sample Request
|
||||
----
|
||||
GET /plugins/downloaded
|
||||
GET /plugins/installed
|
||||
----
|
||||
|
||||
Sample Response
|
||||
|
|
@ -416,12 +426,118 @@ Sample Response
|
|||
"percentage": 0
|
||||
},
|
||||
...
|
||||
]
|
||||
],
|
||||
"lifetime": 89232,
|
||||
"trend": 2990
|
||||
},
|
||||
"title": "Jenkins Git plugin",
|
||||
"url": "http://updates.jenkins-ci.org/download/plugins/git/2.5.2/git.hpi",
|
||||
"version": "2.5.2",
|
||||
"wiki": "https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin"
|
||||
"wiki": {
|
||||
"url": "https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin"
|
||||
}
|
||||
},
|
||||
...
|
||||
],
|
||||
"limit": 3,
|
||||
"total": 7
|
||||
}
|
||||
----
|
||||
|
||||
=== GET /plugins/trend
|
||||
|
||||
Get top "limit" trending plugins
|
||||
|
||||
.Parameters
|
||||
[options="header,footer"]
|
||||
|=======================
|
||||
|Name|Required|Description|Default Value|Possible Values|Example
|
||||
|limit|false|Specify limit for results|10||5
|
||||
|=======================
|
||||
|
||||
Sample Request
|
||||
----
|
||||
GET /plugins/trend
|
||||
----
|
||||
|
||||
Sample Response
|
||||
----
|
||||
{
|
||||
"page": 1,
|
||||
"pages": 3,
|
||||
"plugins":
|
||||
[
|
||||
{
|
||||
"buildDate": "Jul 04, 2016",
|
||||
"categories": [
|
||||
"scm"
|
||||
],
|
||||
"dependencies": [
|
||||
{
|
||||
"name": "matrix-project",
|
||||
"optional": false,
|
||||
"version": "1.6"
|
||||
},
|
||||
...
|
||||
],
|
||||
"developers": [
|
||||
{
|
||||
"developerId": "kohsuke",
|
||||
"name": "Kohsuke Kawaguchi",
|
||||
"email": null
|
||||
},
|
||||
...
|
||||
],
|
||||
"excerpt": "This plugin allows use of <a href='http://git-scm.com/'>Git</a> as a build SCM, including repository browsers for several providers. A recent Git runtime is required (1.7.9 minimum, 1.8.x recommended). Interaction with the Git runtime is performed by the use of the [JENKINS:Git Client Plugin], which is only tested on official <a href='http://git-scm.com/'>git client</a>. Use exotic installations at your own risk.",
|
||||
"gav": "org.jenkins-ci.plugins:git:2.5.2",
|
||||
"labels": [
|
||||
"scm"
|
||||
],
|
||||
"name": "git",
|
||||
"previousTimestamp": "2016-07-02T20:46:28.00Z",
|
||||
"previousVersion": "2.5.1",
|
||||
"releaseTimetamp": null,
|
||||
"requiredCore": "1.609.3",
|
||||
"scm": "github.com",
|
||||
"sha1": "0LNQKJ+Tcn9vTwqMbtxSi1SM+s0=",
|
||||
"stats": {
|
||||
"installations": [
|
||||
{
|
||||
"timestamp": 1322697600000,
|
||||
"total": 8906
|
||||
},
|
||||
...
|
||||
],
|
||||
"installationsPercentage": [
|
||||
{
|
||||
"timestamp": 1459468800000,
|
||||
"percentage": 61.16896694248365
|
||||
},
|
||||
...
|
||||
],
|
||||
"installationsPerVersion": [
|
||||
{
|
||||
"version": "2.0.3",
|
||||
"total": 141
|
||||
},
|
||||
...
|
||||
],
|
||||
"installationsPercentagePerVersion": [
|
||||
{
|
||||
"version": "2.2.7",
|
||||
"percentage": 0
|
||||
},
|
||||
...
|
||||
],
|
||||
"lifetime": 89232,
|
||||
"trend": 2990
|
||||
},
|
||||
"title": "Jenkins Git plugin",
|
||||
"url": "http://updates.jenkins-ci.org/download/plugins/git/2.5.2/git.hpi",
|
||||
"version": "2.5.2",
|
||||
"wiki": {
|
||||
"url": "https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin"
|
||||
}
|
||||
},
|
||||
...
|
||||
],
|
||||
|
|
@ -514,12 +630,16 @@ Sample Response
|
|||
"percentage": 0
|
||||
},
|
||||
...
|
||||
]
|
||||
],
|
||||
"lifetime": 89232,
|
||||
"trend": 2990
|
||||
},
|
||||
"title": "Jenkins Git plugin",
|
||||
"url": "http://updates.jenkins-ci.org/download/plugins/git/2.5.2/git.hpi",
|
||||
"version": "2.5.2",
|
||||
"wiki": "https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin"
|
||||
"wiki": {
|
||||
"url": "https://wiki.jenkins-ci.org/display/JENKINS/Git+Plugin"
|
||||
}
|
||||
},
|
||||
...
|
||||
],
|
||||
|
|
|
|||
Loading…
Reference in New Issue