diff --git a/src/index.apib b/src/index.apib index 77f18cd2e4278893b94c0fb1eaa62fa44d5a6d2d..20e308615c9b5b132c31e5af0509128350ac7d2c 100644 --- a/src/index.apib +++ b/src/index.apib @@ -2,13 +2,16 @@ FORMAT: 1A HOST: https://api.eclipse.org # Eclipse RESTful API + This describes the resources that make up the official Eclipse Foundation REST API. You can contribute to this document via our [git repository](https://github.com/chrisguindon/api.eclipse.org-docs). If you have any problems or requests please contact [Christopher Guindon](mailto:chris.guindon@eclipse-foundation.org). -### Supported REST APIs +### Other related REST APIs + +Althought they are not directly related to this API, the Eclipse forge proposes several other access points and APIs for specific tools and purposes. Please see the following resources for more details: + [Eclipse Bugzilla](https://bugs.eclipse.org/bugs) **([Documentation](https://wiki.mozilla.org/Bugzilla:REST_API))** + [Eclipse Gerrit](https://git.eclipse.org/r/) **([Documentation](https://gerrit-review.googlesource.com/Documentation/rest-api.html))** @@ -16,9 +19,11 @@ If you have any problems or requests please contact [Christopher Guindon](mailto + [Eclipse Marketplace](http://marketplace.eclipse.org/) **([Documentation](https://wiki.eclipse.org/Marketplace/REST))** ### Rate Limit + This API currently limits users to 1000 authenticated requests and 1000 anonymous requests an hour. ### Pagination + 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: @@ -42,7 +47,7 @@ Most responses return an ETag header. You can use the values of these headers to requests to those resources using the If-None-Match or if-Match header. For example, if the resource has not changed on a GET, the server will return a 304 Not Modified. -The Etag for a blob resource is predictable. This is how were are currently generating them: +The Etag for a blob resource is predictable. This is how we are currently generating them: ``` function _generate_etag($value, $application_token, $key) { @@ -52,9 +57,11 @@ function _generate_etag($value, $application_token, $key) { ``` ### Authentication + *Eclipse Api RESTful API* uses OAuth2 Authorization for protected resources. ### Error States + The common [HTTP Response Status Codes](https://github.com/for-GET/know-your-http-well/blob/master/status-codes.md) are used. diff --git a/src/modules/account.apib b/src/modules/account.apib index 492638beb428ea76030d5a2db73508f43fbe5702..7eed2d0937e26f4226eb5ca744474066cf6f3733 100644 --- a/src/modules/account.apib +++ b/src/modules/account.apib @@ -15,7 +15,7 @@ Retrieve profile information about current user. [{"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"]}] ## Retrieve user [GET /account/profile/{name}] -Retrieve profile information about current user. +Retrieve profile information about a specified user. + Parameters + name (string, optional) - A valid Eclipse username. diff --git a/src/modules/oauth2.apib b/src/modules/oauth2.apib index 464beda7f618a248c300d74dfe3f70f0d8f43a86..bc73e524c3d4df7d51afb4d24306c49ef0659ce0 100644 --- a/src/modules/oauth2.apib +++ b/src/modules/oauth2.apib @@ -4,8 +4,7 @@ FORMAT: 1A *Eclipse Api RESTful API* uses OAuth2 Authorization for protected resources. ## OAuth2 Authorization [GET /oauth2/authorize{?response_type,client_id,redirect_uri,scope}] -The client must redirect to authorization server to gain an `authorization_code` which can be exchange -for an `access_token`. +The client must redirect to authorization server to gain an `authorization_code` which can be exchanged for an `access_token`. + Parameters + response_type (string, required) - Indicates that your server expects to receive an authorization code.