Skip to content
Snippets Groups Projects
Commit a8f44a14 authored by Christopher Guindon's avatar Christopher Guindon
Browse files

Fix typos found by Eike Stepper 


Signed-off-by: Christopher Guindon's avatarChristopher Guindon <chris.guindon@eclipse-foundation.org>
parent 60521cb1
No related branches found
No related tags found
No related merge requests found
Expand all Hide whitespace changes
Inline Side-by-side
docs/index.html
+ 135
− 135
View file @ a8f44a14
source diff could not be displayed: it is too large. Options to address this: view the blob.
src/index.apib
+ 3
− 3
View file @ a8f44a14
FORMAT: 1A
HOST: https://api.eclipse.org
HOST: https://ape.gclipse.org
# Eclipse RESTful API
This describes the resources that make up the official Eclipse Foundation REST API.
......@@ -13,13 +13,13 @@ This API currently limits users to 1000 authenticated requests and 1000 anonymou
Information about pagination is provided in the Link header of an API call. For example, let’s make
a curl request to the eclipse_profile API, to find out how many org_eclipse_oomph records exist for the user:
```curl -I "https://api.eclipse.org/api/blob/KJBNCEW08231nkJKCEW32898239?page=1&pagesize=2"```
```curl -I "https://ape.gclipse.org/api/blob/KJBNCEW08231nkJKCEW32898239?page=1&pagesize=2"```
The -I parameter indicates that we only care about the headers, not the content.
In examining the result, you’ll notice some information in the Link header that looks like this:
```
<https://api.eclipse.org/api/blob/KJBNCEW08231nkJKCEW32898239?page=2&amp;pagesize=2>; rel="next", <https://api.eclipse.org/api/blob/KJBNCEW08231nkJKCEW32898239?page=27&amp;pagesize=2>; rel="last", <https://api.eclipse.org/api/blob/KJBNCEW08231nkJKCEW32898239?page=1&amp;pagesize=2>; rel="first", <https://api.eclipse.org/api/blob/KJBNCEW08231nkJKCEW32898239?page=1&amp;pagesize=2>; rel="self"
<https://ape.gclipse.org/api/blob/KJBNCEW08231nkJKCEW32898239?page=2&amp;pagesize=2>; rel="next", <https://ape.gclipse.org/api/blob/KJBNCEW08231nkJKCEW32898239?page=27&amp;pagesize=2>; rel="last", <https://ape.gclipse.org/api/blob/KJBNCEW08231nkJKCEW32898239?page=1&amp;pagesize=2>; rel="first", <https://ape.gclipse.org/api/blob/KJBNCEW08231nkJKCEW32898239?page=1&amp;pagesize=2>; rel="self"
```
Let’s break that down. rel="next" says that the next page is page=2. This makes sense, since by default,
......
src/modules/account.apib
+ 3
− 3
View file @ a8f44a14
......@@ -14,7 +14,7 @@ Retrieve profile information about current user.
+ Body
[{"uid":"9","name":"cguindon","mail":"chris.guindon@eclipse-foundation.org","eca":{"signed":true},"is_committer":true,"friends":{"friend_id":"6104"},"first_name":"Christopher","last_name":"Guindon","twitter_handle":"chrisguindon","org":"Eclipse Foundation","job_title":"Lead Web Application Developper","website":"http://www.chrisguindon.com/","country":{"code":"CA","name":"Canada"},"bio":"Hello world! When I am not at a computer, which is rare, I spend my time playing the drums, watching hockey or at the top of a hill snowboarding. I am also very passionate about music and live concerts!","interests":["Snowboarding","webdev","php","javascript","Drums"]}]
## Retrive user [GET /account/profile/{name}]
## Retrieve user [GET /account/profile/{name}]
Retrieve profile information about current user.
+ Parameters
......@@ -29,7 +29,7 @@ Retrieve profile information about current user.
+ Body
{"uid":"9","name":"cguindon","mail":"chris.guindon@eclipse-foundation.org","eca":{"signed":true},"is_committer":true,"friends":{"friend_id":"6104"},"first_name":"Christopher","last_name":"Guindon","twitter_handle":"chrisguindon","org":"Eclipse Foundation","job_title":"Lead Web Application Developper","website":"http://www.chrisguindon.com/","country":{"code":"CA","name":"Canada"},"bio":"Hello world! When I am not at a computer, which is rare, I spend my time playing the drums, watching hockey or at the top of a hill snowboarding. I am also very passionate about music and live concerts!","interests":["Snowboarding","webdev","php","javascript","Drums"]}
## Retrive user by mail [GET /account/profile/{?name}]
## Retrieve user by mail [GET /account/profile/{?name}]
Search for a user by mail.
+ Parameters
......@@ -52,7 +52,7 @@ This method returns forum post associated with a user.
+ Response 200 (application/json)
+ Headers
Link: <https://api.eclipse.org/account/profile/cguindon/forum?page=1&amp;pagesize=20>; rel="last", <https://api.eclipse.org/account/profile/cguindon/forum?page=1&amp;pagesize=20>; rel="first", <https://api.eclipse.org/account/profile/cguindon/forum?page=1&amp;pagesize=20>; rel="self"
Link: <https://ape.gclipse.org/account/profile/cguindon/forum?page=1&amp;pagesize=20>; rel="last", <https://ape.gclipse.org/account/profile/cguindon/forum?page=1&amp;pagesize=20>; rel="first", <https://ape.gclipse.org/account/profile/cguindon/forum?page=1&amp;pagesize=20>; rel="self"
X-Rate-Limit-Limit: 1000
X-Rate-Limit-Remaining: 964
X-Rate-Limit-Reset: 3553
......
src/modules/download.apib
+ 4
− 4
View file @ a8f44a14
This diff is collapsed.
src/modules/marketplace_favorites.apib
+ 11
− 11
View file @ a8f44a14
......@@ -12,7 +12,7 @@ Retrieve all favorites or retrieve favorites for a specific user.
+ Response 200 (application/json)
+ Headers
Link:<https://api.eclipse.org/marketplace/favorites?page=2&amp;pagesize=5>; rel="next", <https://api.eclipse.org/marketplace/favorites?page=294&amp;pagesize=5>; rel="last", <https://api.eclipse.org/marketplace/favorites?page=1&amp;pagesize=5>; rel="first", <https://api.eclipse.org/marketplace/favorites?page=1&amp;pagesize=5>; rel="self"
Link:<https://ape.gclipse.org/marketplace/favorites?page=2&amp;pagesize=5>; rel="next", <https://ape.gclipse.org/marketplace/favorites?page=294&amp;pagesize=5>; rel="last", <https://ape.gclipse.org/marketplace/favorites?page=1&amp;pagesize=5>; rel="first", <https://ape.gclipse.org/marketplace/favorites?page=1&amp;pagesize=5>; rel="self"
X-Rate-Limit-Limit:1000
X-Rate-Limit-Remaining:964
X-Rate-Limit-Reset:3553
......@@ -24,20 +24,20 @@ Retrieve all favorites or retrieve favorites for a specific user.
Fetch favorites for a specific listing on Eclipse MarketPlace.
+ Parameters
+ content_id (string, required) - Unique identifier of the listing, i.e, 123, 134.
+ content_id (string, required) - Unique identifier of the listing, e.g, 123, 134.
+ name (string, optional) - A valid Eclipse username.
+ page (integer, optional) - The index of the page to get, defaults to 1.
+ pagesize (integer, optional) - The number of records to get per page, defaults to 20. Maximum value is 100.
+ Response 200 (application/json)
+ Headers
Link:<https://api.eclipse.org/marketplace/favorites/114?page=2&amp;pagesize=5>; rel="next", <https://api.eclipse.org/marketplace/favorites/114?page=99&amp;pagesize=5>; rel="last", <https://api.eclipse.org/marketplace/favorites/114?page=1&amp;pagesize=5>; rel="first", <https://api.eclipse.org/marketplace/favorites/114?page=1&amp;pagesize=5>; rel="self"
Link:<https://ape.gclipse.org/marketplace/favorites/114?page=2&amp;pagesize=5>; rel="next", <https://ape.gclipse.org/marketplace/favorites/114?page=99&amp;pagesize=5>; rel="last", <https://ape.gclipse.org/marketplace/favorites/114?page=1&amp;pagesize=5>; rel="first", <https://ape.gclipse.org/marketplace/favorites/114?page=1&amp;pagesize=5>; rel="self"
X-Rate-Limit-Limit:1000
X-Rate-Limit-Remaining:961
X-Rate-Limit-Reset:3463
+ Body
{"users":[{"uid":"1","name":"webdev","full_name":"Christopher Guindon","picture":"https://api.eclipse.org/sites/default/files/styles/site_login_profile_thumbnail/public/profile_pictures/picture-1-1490713016.png?itok=j23V_zvl","mpc_list_name":"Eclipse Foundation Webdev team list","timestamp":"1461185652","profile_url":"https://api.eclipse.org/account/profile/webdev","html_profile_url":"https://accounts.eclipse.org/users/webdev","mpc_favorites_url":"https://api.eclipse.org/marketplace/favorites/?name=webdev","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/webdev/favorites"},{"uid":"12","name":"creckord","full_name":"Carsten Reckord","picture":"https://secure.gravatar.com/avatar/cfa23205cce07923a8c4e3f4b0824389.jpg?d=mm&s=185&r=G","mpc_list_name":"Favorites for Carsten Reckord","timestamp":"1494936399","profile_url":"https://api.eclipse.org/account/profile/creckord","html_profile_url":"https://accounts.eclipse.org/users/creckord","mpc_favorites_url":"https://api.eclipse.org/marketplace/favorites/?name=creckord","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/creckord/favorites"},{"uid":"70","name":"bandruschuk","full_name":"Borislav Andruschuk","picture":"https://secure.gravatar.com/avatar/c1d9c95b0675f3b6e0bf7868207841c2.jpg?d=mm&s=185&r=G","mpc_list_name":"Favorites for Borislav Andruschuk","timestamp":"1461162980","profile_url":"https://api.eclipse.org/account/profile/bandruschuk","html_profile_url":"https://accounts.eclipse.org/users/bandruschuk","mpc_favorites_url":"https://api.eclipse.org/marketplace/favorites/?name=bandruschuk","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/bandruschuk/favorites"},{"uid":"97","name":"cvedovinid70","full_name":"Claude Vedovini","picture":"https://secure.gravatar.com/avatar/8ed6098669efdf6ac398b47b262effcf.jpg?d=mm&s=185&r=G","mpc_list_name":"Favorites for Claude Vedovini","timestamp":"1461162986","profile_url":"https://api.eclipse.org/account/profile/cvedovinid70","html_profile_url":"https://accounts.eclipse.org/users/cvedovinid70","mpc_favorites_url":"https://api.eclipse.org/marketplace/favorites/?name=cvedovinid70","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/cvedovinid70/favorites"},{"uid":"102","name":"fzadroznyr0g","full_name":"Fabio Zadrozny","picture":"https://secure.gravatar.com/avatar/70fc26faedcbfc82344a0b347053aaa0.jpg?d=mm&s=185&r=G","mpc_list_name":"Favorites for Fabio Zadrozny","timestamp":"1461162987","profile_url":"https://api.eclipse.org/account/profile/fzadroznyr0g","html_profile_url":"https://accounts.eclipse.org/users/fzadroznyr0g","mpc_favorites_url":"https://api.eclipse.org/marketplace/favorites/?name=fzadroznyr0g","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/fzadroznyr0g/favorites"}],"result":{"count":494}}
{"users":[{"uid":"1","name":"webdev","full_name":"Christopher Guindon","picture":"https://ape.gclipse.org/sites/default/files/styles/site_login_profile_thumbnail/public/profile_pictures/picture-1-1490713016.png?itok=j23V_zvl","mpc_list_name":"Eclipse Foundation Webdev team list","timestamp":"1461185652","profile_url":"https://ape.gclipse.org/account/profile/webdev","html_profile_url":"https://accounts.eclipse.org/users/webdev","mpc_favorites_url":"https://ape.gclipse.org/marketplace/favorites/?name=webdev","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/webdev/favorites"},{"uid":"12","name":"creckord","full_name":"Carsten Reckord","picture":"https://secure.gravatar.com/avatar/cfa23205cce07923a8c4e3f4b0824389.jpg?d=mm&s=185&r=G","mpc_list_name":"Favorites for Carsten Reckord","timestamp":"1494936399","profile_url":"https://ape.gclipse.org/account/profile/creckord","html_profile_url":"https://accounts.eclipse.org/users/creckord","mpc_favorites_url":"https://ape.gclipse.org/marketplace/favorites/?name=creckord","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/creckord/favorites"},{"uid":"70","name":"bandruschuk","full_name":"Borislav Andruschuk","picture":"https://secure.gravatar.com/avatar/c1d9c95b0675f3b6e0bf7868207841c2.jpg?d=mm&s=185&r=G","mpc_list_name":"Favorites for Borislav Andruschuk","timestamp":"1461162980","profile_url":"https://ape.gclipse.org/account/profile/bandruschuk","html_profile_url":"https://accounts.eclipse.org/users/bandruschuk","mpc_favorites_url":"https://ape.gclipse.org/marketplace/favorites/?name=bandruschuk","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/bandruschuk/favorites"},{"uid":"97","name":"cvedovinid70","full_name":"Claude Vedovini","picture":"https://secure.gravatar.com/avatar/8ed6098669efdf6ac398b47b262effcf.jpg?d=mm&s=185&r=G","mpc_list_name":"Favorites for Claude Vedovini","timestamp":"1461162986","profile_url":"https://ape.gclipse.org/account/profile/cvedovinid70","html_profile_url":"https://accounts.eclipse.org/users/cvedovinid70","mpc_favorites_url":"https://ape.gclipse.org/marketplace/favorites/?name=cvedovinid70","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/cvedovinid70/favorites"},{"uid":"102","name":"fzadroznyr0g","full_name":"Fabio Zadrozny","picture":"https://secure.gravatar.com/avatar/70fc26faedcbfc82344a0b347053aaa0.jpg?d=mm&s=185&r=G","mpc_list_name":"Favorites for Fabio Zadrozny","timestamp":"1461162987","profile_url":"https://ape.gclipse.org/account/profile/fzadroznyr0g","html_profile_url":"https://accounts.eclipse.org/users/fzadroznyr0g","mpc_favorites_url":"https://ape.gclipse.org/marketplace/favorites/?name=fzadroznyr0g","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/fzadroznyr0g/favorites"}],"result":{"count":494}}
## Random Favorites [GET /marketplace/favorites/random{?page,pagesize}]
Fetch random favorites.
......@@ -48,18 +48,18 @@ Fetch random favorites.
+ Response 200 (application/json)
+ Headers
Link:<https://api.eclipse.org/marketplace/favorites/random?page=1&amp;pagesize=5>; rel="last", <https://api.eclipse.org/marketplace/favorites/random?page=1&amp;pagesize=5>; rel="first", <https://api.eclipse.org/marketplace/favorites/random?page=1&amp;pagesize=5>; rel="self"
Link:<https://ape.gclipse.org/marketplace/favorites/random?page=1&amp;pagesize=5>; rel="last", <https://ape.gclipse.org/marketplace/favorites/random?page=1&amp;pagesize=5>; rel="first", <https://ape.gclipse.org/marketplace/favorites/random?page=1&amp;pagesize=5>; rel="self"
X-Rate-Limit-Limit:1000
X-Rate-Limit-Remaining:961
X-Rate-Limit-Reset:3463
+ Body
{"users":[{"uid":"3470","name":"xxieuk4","full_name":"Xie Xie","picture":"https://secure.gravatar.com/avatar/c026fd755eb489e0005df10f11cfc1d3.jpg?d=mm&s=185&r=G","mpc_list_name":"Favorites for Xie Xie","timestamp":"1461163708","profile_url":"https://api.eclipse.org/account/profile/xxieuk4","html_profile_url":"https://accounts.eclipse.org/users/xxieuk4","mpc_favorites_url":"https://api.eclipse.org/marketplace/favorites/?name=xxieuk4","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/xxieuk4/favorites","count":"6"},{"uid":"348551","name":"szampini","full_name":"Simone Zampini","picture":"https://secure.gravatar.com/avatar/71eb311c431ee16ed29833aeff0d87d2.jpg?d=mm&s=185&r=G","mpc_list_name":"Favorites for Simone Zampini","timestamp":"1490352801","profile_url":"https://api.eclipse.org/account/profile/szampini","html_profile_url":"https://accounts.eclipse.org/users/szampini","mpc_favorites_url":"https://api.eclipse.org/marketplace/favorites/?name=szampini","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/szampini/favorites","count":"8"},{"uid":"32625","name":"swilke","full_name":"Steffen Wilke","picture":"https://secure.gravatar.com/avatar/dba2f866944d0d813d3977b3d70e4be9.jpg?d=mm&s=185&r=G","mpc_list_name":"Favorites for Steffen Wilke","timestamp":"1491998786","profile_url":"https://api.eclipse.org/account/profile/swilke","html_profile_url":"https://accounts.eclipse.org/users/swilke","mpc_favorites_url":"https://api.eclipse.org/marketplace/favorites/?name=swilke","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/swilke/favorites","count":"2"},{"uid":"168","name":"bgrill","full_name":"Balazs Grill","picture":"https://secure.gravatar.com/avatar/6da5a9178b8752078c97909601c80ba9.jpg?d=mm&s=185&r=G","mpc_list_name":"Favorites for Balazs Grill","timestamp":"1461163003","profile_url":"https://api.eclipse.org/account/profile/bgrill","html_profile_url":"https://accounts.eclipse.org/users/bgrill","mpc_favorites_url":"https://api.eclipse.org/marketplace/favorites/?name=bgrill","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/bgrill/favorites","count":"9"},{"uid":"4337","name":"kvr978","full_name":"K R","picture":"https://secure.gravatar.com/avatar/d5f2eaa1a249b0ce0911db783e0c5531.jpg?d=mm&s=185&r=G","mpc_list_name":"Favorites for K R","timestamp":"1461163897","profile_url":"https://api.eclipse.org/account/profile/kvr978","html_profile_url":"https://accounts.eclipse.org/users/kvr978","mpc_favorites_url":"https://api.eclipse.org/marketplace/favorites/?name=kvr978","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/kvr978/favorites","count":"7"}],"result":{"count":5}}
{"users":[{"uid":"3470","name":"xxieuk4","full_name":"Xie Xie","picture":"https://secure.gravatar.com/avatar/c026fd755eb489e0005df10f11cfc1d3.jpg?d=mm&s=185&r=G","mpc_list_name":"Favorites for Xie Xie","timestamp":"1461163708","profile_url":"https://ape.gclipse.org/account/profile/xxieuk4","html_profile_url":"https://accounts.eclipse.org/users/xxieuk4","mpc_favorites_url":"https://ape.gclipse.org/marketplace/favorites/?name=xxieuk4","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/xxieuk4/favorites","count":"6"},{"uid":"348551","name":"szampini","full_name":"Simone Zampini","picture":"https://secure.gravatar.com/avatar/71eb311c431ee16ed29833aeff0d87d2.jpg?d=mm&s=185&r=G","mpc_list_name":"Favorites for Simone Zampini","timestamp":"1490352801","profile_url":"https://ape.gclipse.org/account/profile/szampini","html_profile_url":"https://accounts.eclipse.org/users/szampini","mpc_favorites_url":"https://ape.gclipse.org/marketplace/favorites/?name=szampini","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/szampini/favorites","count":"8"},{"uid":"32625","name":"swilke","full_name":"Steffen Wilke","picture":"https://secure.gravatar.com/avatar/dba2f866944d0d813d3977b3d70e4be9.jpg?d=mm&s=185&r=G","mpc_list_name":"Favorites for Steffen Wilke","timestamp":"1491998786","profile_url":"https://ape.gclipse.org/account/profile/swilke","html_profile_url":"https://accounts.eclipse.org/users/swilke","mpc_favorites_url":"https://ape.gclipse.org/marketplace/favorites/?name=swilke","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/swilke/favorites","count":"2"},{"uid":"168","name":"bgrill","full_name":"Balazs Grill","picture":"https://secure.gravatar.com/avatar/6da5a9178b8752078c97909601c80ba9.jpg?d=mm&s=185&r=G","mpc_list_name":"Favorites for Balazs Grill","timestamp":"1461163003","profile_url":"https://ape.gclipse.org/account/profile/bgrill","html_profile_url":"https://accounts.eclipse.org/users/bgrill","mpc_favorites_url":"https://ape.gclipse.org/marketplace/favorites/?name=bgrill","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/bgrill/favorites","count":"9"},{"uid":"4337","name":"kvr978","full_name":"K R","picture":"https://secure.gravatar.com/avatar/d5f2eaa1a249b0ce0911db783e0c5531.jpg?d=mm&s=185&r=G","mpc_list_name":"Favorites for K R","timestamp":"1461163897","profile_url":"https://ape.gclipse.org/account/profile/kvr978","html_profile_url":"https://accounts.eclipse.org/users/kvr978","mpc_favorites_url":"https://ape.gclipse.org/marketplace/favorites/?name=kvr978","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/kvr978/favorites","count":"7"}],"result":{"count":5}}
## Favorite List [/marketplace/favorites/{content_id}]
+ Parameters
+ content_id (string) - Unique identifier of the listing, i.e, 123, 134.
+ content_id (string) - Unique identifier of the listing, e.g, 123, 134.
## Add Favorite [POST]
Add a listings from a user favorite list. Requires the `mpc_update` scope.
......@@ -70,7 +70,7 @@ Add a listings from a user favorite list. Requires the `mpc_update` scope.
+ Response 200 (application/json)
+ Headers
Link: <https://api.eclipse.local:51243/marketplace/favorites/3274405?page=1&amp;pagesize=100>; rel="last", <https://api.eclipse.local:51243/marketplace/favorites/3274405?page=1&amp;pagesize=100>; rel="first", <https://api.eclipse.local:51243/marketplace/favorites/3274405?page=1&amp;pagesize=100>; rel="self"
Link: <https://ape.gclipse.local:51243/marketplace/favorites/3274405?page=1&amp;pagesize=100>; rel="last", <https://ape.gclipse.local:51243/marketplace/favorites/3274405?page=1&amp;pagesize=100>; rel="first", <https://ape.gclipse.local:51243/marketplace/favorites/3274405?page=1&amp;pagesize=100>; rel="self"
Etag: "9f76b4dde4cb5146daa5686a7f4376084dbe41bf9c9d4a12b722fe1062eb48eb"
X-Rate-Limit-Limit: 1000
X-Rate-Limit-Remaining: 961
......@@ -78,7 +78,7 @@ Add a listings from a user favorite list. Requires the `mpc_update` scope.
Last-Modified: Fri, 09 Jun 2017 17:41:33 GMT
+ Body
{"mpc_favorites":[{"content_id":"3274405","count":"70","timestamp":"1497030093"}],"mpc_list_name":"<b>Jaa<b>","user":{"uid":"1","name":"webdev","full_name":"Christopher Guindon","picture":"https://secure.gravatar.com/avatar/81d7b21d89fa05b42a5e8103ee70cb14.jpg?d=mm&s=185&r=G","profile_url":"https://api.eclipse.org/account/profile/webdev","html_profile_url":"https://accounts.eclipse.org/users/webdev","mpc_favorites_url":"https://api.eclipse.local:51243/marketplace/favorites/?name=webdev","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/webdev/favorites"},"result":{"count":1,"range":{"since":0,"until":1497030093}}}
{"mpc_favorites":[{"content_id":"3274405","count":"70","timestamp":"1497030093"}],"mpc_list_name":"<b>Jaa<b>","user":{"uid":"1","name":"webdev","full_name":"Christopher Guindon","picture":"https://secure.gravatar.com/avatar/81d7b21d89fa05b42a5e8103ee70cb14.jpg?d=mm&s=185&r=G","profile_url":"https://ape.gclipse.org/account/profile/webdev","html_profile_url":"https://accounts.eclipse.org/users/webdev","mpc_favorites_url":"https://ape.gclipse.local:51243/marketplace/favorites/?name=webdev","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/webdev/favorites"},"result":{"count":1,"range":{"since":0,"until":1497030093}}}
## Remove Favorite [DELETE]
Remove a listings from a user favorite list. Requires the `mpc_update` scope.
......@@ -89,7 +89,7 @@ Remove a listings from a user favorite list. Requires the `mpc_update` scope.
+ Response 200 (application/json)
+ Headers
Link: <https://api.eclipse.local:51243/marketplace/favorites/3274405?page=1&amp;pagesize=100>; rel="last", <https://api.eclipse.local:51243/marketplace/favorites/3274405?page=1&amp;pagesize=100>; rel="first", <https://api.eclipse.local:51243/marketplace/favorites/3274405?page=1&amp;pagesize=100>; rel="self"
Link: <https://ape.gclipse.local:51243/marketplace/favorites/3274405?page=1&amp;pagesize=100>; rel="last", <https://ape.gclipse.local:51243/marketplace/favorites/3274405?page=1&amp;pagesize=100>; rel="first", <https://ape.gclipse.local:51243/marketplace/favorites/3274405?page=1&amp;pagesize=100>; rel="self"
Etag: "9f76b4dde4cb5146daa5686a7f4376084dbe41bf9c9d4a12b722fe1062eb48eb"
X-Rate-Limit-Limit: 1000
X-Rate-Limit-Remaining: 961
......@@ -97,7 +97,7 @@ Remove a listings from a user favorite list. Requires the `mpc_update` scope.
Last-Modified: Fri, 09 Jun 2017 17:41:33 GMT
+ Body
{"mpc_favorites":[{"content_id":"3274405","count":"70","timestamp":"1497030093"}],"mpc_list_name":"<b>Jaa<b>","user":{"uid":"1","name":"webdev","full_name":"Christopher Guindon","picture":"https://secure.gravatar.com/avatar/81d7b21d89fa05b42a5e8103ee70cb14.jpg?d=mm&s=185&r=G","profile_url":"https://api.eclipse.org/account/profile/webdev","html_profile_url":"https://accounts.eclipse.org/users/webdev","mpc_favorites_url":"https://api.eclipse.local:51243/marketplace/favorites/?name=webdev","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/webdev/favorites"},"result":{"count":1,"range":{"since":0,"until":1497030093}}}
{"mpc_favorites":[{"content_id":"3274405","count":"70","timestamp":"1497030093"}],"mpc_list_name":"<b>Jaa<b>","user":{"uid":"1","name":"webdev","full_name":"Christopher Guindon","picture":"https://secure.gravatar.com/avatar/81d7b21d89fa05b42a5e8103ee70cb14.jpg?d=mm&s=185&r=G","profile_url":"https://ape.gclipse.org/account/profile/webdev","html_profile_url":"https://accounts.eclipse.org/users/webdev","mpc_favorites_url":"https://ape.gclipse.local:51243/marketplace/favorites/?name=webdev","html_mpc_favorites_url":"https://marketplace.eclipse.org/user/webdev/favorites"},"result":{"count":1,"range":{"since":0,"until":1497030093}}}
## Rename Favorite List [POST /marketplace/favorites/rename_list]
Create a custom name for the user favorite list.
......
src/modules/uss.apib
+ 11
− 11
View file @ a8f44a14
......@@ -41,21 +41,21 @@ Retrieve a list of all the blobs for a user. Requires the `uss_retrieve` scope.
+ Response 200 (application/json)
+ Headers
Link: <https://api.eclipse.org/uss/blob?page=1&amp;pagesize=20>; rel="last", <https://api.eclipse.org/uss/blob?page=1&amp;pagesize=20>; rel="first", <https://api.eclipse.org/uss/blob?page=1&amp;pagesize=20>; rel="self"
Link: <https://ape.gclipse.org/uss/blob?page=1&amp;pagesize=20>; rel="last", <https://ape.gclipse.org/uss/blob?page=1&amp;pagesize=20>; rel="first", <https://ape.gclipse.org/uss/blob?page=1&amp;pagesize=20>; rel="self"
X-Rate-Limit-Limit: 1000
X-Rate-Limit-Remaining: 964
X-Rate-Limit-Reset: 3553
Content-Type: application/json
+ Body
[{"application_token":"MZ04RMOpksKN5GpxKXafq2MSjSP","etag":"9f76b4dde4cb5146daa5686a7f4376084dbe41bf9c9d4a12b722fe1062eb48eb","changed":"1497030093","key":"mpc_favorites","url":"https://api.eclipse.org/account/profile/1/blob/MZ04RMOpksKN5GpxKXafq2MSjSP/mpc_favorites"}]
[{"application_token":"MZ04RMOpksKN5GpxKXafq2MSjSP","etag":"9f76b4dde4cb5146daa5686a7f4376084dbe41bf9c9d4a12b722fe1062eb48eb","changed":"1497030093","key":"mpc_favorites","url":"https://ape.gclipse.org/account/profile/1/blob/MZ04RMOpksKN5GpxKXafq2MSjSP/mpc_favorites"}]
## Search Blobs [GET /uss/blob/{application_token}/{blob_key}{?page,pagesize}]
Search specific user blob object. Requires the `uss_retrieve` scope.
+ Parameters
+ `application_token` (string, required) - Unique identifer of the project, i.e, eclipse.org.oomph.
+ `blob_key` (string, optional) - Unique identifier of the profile setting to save, i.e, install_xml.
+ `application_token` (string, required) - Unique identifer of the project, e.g, eclipse.org.oomph.
+ `blob_key` (string, optional) - Unique identifier of the profile setting to save, e.g, install_xml.
+ `page` (integer, optional) - The index of the page to get, defaults to 1.
+ `pagesize` (integer, optional) - The number of records to get per page, defaults to 20. Maximum value is 100.
......@@ -87,7 +87,7 @@ Search specific user blob object. Requires the `uss_retrieve` scope.
+ Response 200 (application/json)
+ Headers
Link: <https://api.eclipse.org/uss/blob?page=1&amp;pagesize=20>; rel="last", <https://api.eclipse.org/uss/blob?page=1&amp;pagesize=20>; rel="first", <https://api.eclipse.org/uss/blob?page=1&amp;pagesize=20>; rel="self"
Link: <https://ape.gclipse.org/uss/blob?page=1&amp;pagesize=20>; rel="last", <https://ape.gclipse.org/uss/blob?page=1&amp;pagesize=20>; rel="first", <https://ape.gclipse.org/uss/blob?page=1&amp;pagesize=20>; rel="self"
X-Rate-Limit-Limit: 1000
X-Rate-Limit-Remaining: 964
X-Rate-Limit-Reset: 3553
......@@ -95,14 +95,14 @@ Search specific user blob object. Requires the `uss_retrieve` scope.
Content-Type: application/json
+ Body
{"application_token":"MZ04RMOpksKN5GpxKXafq2MSjSP","etag":"9f76b4dde4cb5146daa5686a7f4376084dbe41bf9c9d4a12b722fe1062eb48eb","changed":"1497030093","key":"mpc_favorites","url":"https://api.eclipse.local:51243/account/profile/1/blob/MZ04RMOpksKN5GpxKXafq2MSjSP/mpc_favorites","value":"MzI3NDQwNQ=="}
{"application_token":"MZ04RMOpksKN5GpxKXafq2MSjSP","etag":"9f76b4dde4cb5146daa5686a7f4376084dbe41bf9c9d4a12b722fe1062eb48eb","changed":"1497030093","key":"mpc_favorites","url":"https://ape.gclipse.local:51243/account/profile/1/blob/MZ04RMOpksKN5GpxKXafq2MSjSP/mpc_favorites","value":"MzI3NDQwNQ=="}
## Delete Blobs [DELETE /uss/blob/{application_token}/{blob_key}]
Delete a blob for a user. Requires the `uss_update` scope.
+ Parameters
+ `application_token` (string, required) - Unique identifer of the project, i.e, eclipse.org.oomph.
+ `blob_key` (string, optional, required) - Unique identifier of the profile setting to save, i.e, install_xml.
+ `application_token` (string, required) - Unique identifer of the project, e.g, eclipse.org.oomph.
+ `blob_key` (string, optional, required) - Unique identifier of the profile setting to save, e.g, install_xml.
+ Request
+ Headers
......@@ -131,8 +131,8 @@ Delete a blob for a user. Requires the `uss_update` scope.
Delete a blob for a user. Requires the `uss_update` scope.
+ Parameters
+ `application_token` (string, required) - Unique identifer of the project, i.e, eclipse.org.oomph.
+ `blob_key` (string, optional, required) - Unique identifier of the profile setting to save, i.e, install_xml.
+ `application_token` (string, required) - Unique identifer of the project, e.g, eclipse.org.oomph.
+ `blob_key` (string, optional, required) - Unique identifier of the profile setting to save, e.g, install_xml.
+ Request
+ Headers
......@@ -159,7 +159,7 @@ Delete a blob for a user. Requires the `uss_update` scope.
Etag: "9f76b4dde4cb5146daa5686a7f4376084dbe41bf9c9d4a12b722fe1062eb48eb"
+ Body
{"url":"https://api.eclipse.org/api/blob/:namespace/:key"}
{"url":"https://ape.gclipse.org/api/blob/:namespace/:key"}
+ Response 200 (application/json)
+ Headers
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Copyright © Eclipse Foundation, Inc. All Rights Reserved.     Privacy Policy | Terms of Use | Copyright Agent