Skip to content
Snippets Groups Projects
Commit dc3e5b1c authored by Eric Poirier's avatar Eric Poirier Committed by Christopher Guindon
Browse files

Create a projects documentation page 


Change-Id: I0d1f6a331e4622e06c625a51e53c1a4d533ee4d2
Signed-off-by: default avatarEric Poirier <eric.poirier@eclipse-foundation.org>
parent 2d6d1086
No related branches found
No related tags found
No related merge requests found
Expand all Hide whitespace changes
Inline Side-by-side
Showing
with 14784 additions and 4751 deletions
.travis.yml 0 → 100644
+ 20
− 0
View file @ dc3e5b1c
language: node_js
node_js:
- node
deploy:
- skip_cleanup: true
provider: script
script: npm run build && npm run gh-pages
on:
branch: master
- skip_cleanup: true
provider: script
script: npm run build && npm run gh-pages -- -p "$TRAVIS_BRANCH"
on:
all_branches: true
condition: '"$TRAVIS_BRANCH" != "master" && "$TRAVIS_BRANCH" != "gh-pages"'
email: chris.guindon@eclipse-foundation.org
name: Christopher Guindon
env:
global:
secure: E/Q4/XQu7hFWt+hAQ6B3kS5Rt0yWVZzz0uPNFrVaXyIPET0C49NzWreAn2Hv+asHWOxzyEIa+JiIyI/m7/crp+Hd03ghnVSTrAwSvQ9+1g8Hg+34PbyXBPeQe+wncQWlyFy3aqtB+i357X+qJyQ39+3NBhR4eZacV8MIkRRGljm8gW1PGhwt95ykmP8eqdPQrM9ec+w3fFxMp2jC8M9KWBETVYrOu8TkZYlVgS+lZJQMNAlaYo1iq0QOBYABYGPKqUqoP0E4NLSCtiTlX/6rMMW3Iu0ew0ySbDi9rlB3vaWtS0F7ne11anHunjMeHoPBxOc5rfEifQcFR2H8hWWvrL1T5ggYdwpi35BSYaWeoyMDeQqJRwPAgKtxFu3URUZz1CM7gbUT+43DJv9OwCTCO3SRWyrkfoIUnHQNTlnvw/RGr71nNLz6YNC+GoY0FgGIpXFLhVMJ9VTMc2EV5ymH0zkYbQIzxat2hFEafRmMfGrn0qdgTAlNMX5AIPTNGGfgP3E0Y0whrMUclpLA5tJBMlYQ7VGxY5eNOvRDdjM3yPLYHXJILetaoUujPvFbvP//8L+IwcXubSafPv1mBTNjLyPoM26sCy0VG84dZ7puxPv3V4IXeH5PD+exm3dqRQI9sbVpGLTf1xVYUK8aIy0NdyUQboqIKXqcg6eh6qC6jzY=
CODE_OF_CONDUCT.md 0 → 100644
+ 46
− 0
View file @ dc3e5b1c
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at webdev@eclipse-foundation.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
CONTRIBUTING.md 0 → 100644
+ 35
− 0
View file @ dc3e5b1c
# Contributing to marketplace-rest-api-specs
Thanks for your interest in this project.
## Project description
marketplace-rest-api-specs is a project to regroup assets for the Eclipse Foundation look and feel.
* https://github.com/eclipsefdn/api.eclipse.org-docs
## Developer resources
The project maintains the following source code repositories
* https://github.com/eclipsefdn/api.eclipse.org-docs
## Eclipse Contributor Agreement
Before your contribution can be accepted by the project team contributors must
electronically sign the Eclipse Contributor Agreement (ECA).
* http://www.eclipse.org/legal/ECA.php
Commits that are provided by non-committers must have a Signed-off-by field in
the footer indicating that the author is aware of the terms by which the
contribution has been provided to the project. The non-committer must
additionally have an Eclipse Foundation account and must have a signed Eclipse
Contributor Agreement (ECA) on file.
For more information, please see the Eclipse Committer Handbook:
https://www.eclipse.org/projects/handbook/#resources-commit
## Contact
Contact the Eclipse Foundation Webdev team via webdev@eclipse-foundation.org.
Gruntfile.js deleted 100644 → 0
+ 0
− 54
View file @ 2d6d1086
module.exports = function (grunt) {
'use strict';
grunt.initConfig({
aglio: {
'all': {
'files': { 'docs/index.html': ['src/index.apib'], 'docs/auth.html': ['src/auth.apib'], 'docs/proposals.html': ['src/proposals.apib']},
'options': {
'theme': 'default',
'separator': '\\n',
'includePath': 'src',
'themeTemplate': 'templates/index.jade',
'themeFullWidth': true,
'themeStyle': 'styles/styles.less'
}
}
},
watch: {
'aglio': {
'files': [
'src/**/*.apib',
'src/**/*.md',
'src/**/*.json',
'templates/*',
'styles/*'
],
'tasks': ['aglio'],
'options': { 'livereload': '<%= connect.options.livereload %>' }
}
},
connect: {
options: {
port: 8080,
hostname: 'localhost',
livereload: 35729
},
livereload: {
options: {
open: false,
base: 'docs'
}
}
}
});
grunt.loadNpmTasks('grunt-aglio');
grunt.loadNpmTasks('grunt-contrib-connect');
grunt.loadNpmTasks('grunt-contrib-watch');
grunt.registerTask('build', ['aglio']);
grunt.registerTask('serve', [
'build',
'connect:livereload',
'watch'
]);
};
\ No newline at end of file
LICENSE 0 → 100644
+ 277
− 0
View file @ dc3e5b1c
Eclipse Public License - v 2.0
THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial content
Distributed under this Agreement, and
b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from
and are Distributed by that particular Contributor. A Contribution
"originates" from a Contributor if it was added to the Program by
such Contributor itself or anyone acting on such Contributor's behalf.
Contributions do not include changes or additions to the Program that
are not Modified Works.
"Contributor" means any person or entity that Distributes the Program.
"Licensed Patents" mean patent claims licensable by a Contributor which
are necessarily infringed by the use or sale of its Contribution alone
or when combined with the Program.
"Program" means the Contributions Distributed in accordance with this
Agreement.
"Recipient" means anyone who receives the Program under this Agreement
or any Secondary License (as applicable), including Contributors.
"Derivative Works" shall mean any work, whether in Source Code or other
form, that is based on (or derived from) the Program and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship.
"Modified Works" shall mean any work in Source Code or other form that
results from an addition to, deletion from, or modification of the
contents of the Program, including, for purposes of clarity any new file
in Source Code form that contains any contents of the Program. Modified
Works shall not include works that contain only declarations,
interfaces, types, classes, structures, or files of the Program solely
in each case in order to link to, bind by name, or subclass the Program
or Modified Works thereof.
"Distribute" means the acts of a) distributing or b) making available
in any manner that enables the transfer of a copy.
"Source Code" means the form of a Program preferred for making
modifications, including but not limited to software source code,
documentation source, and configuration files.
"Secondary License" means either the GNU General Public License,
Version 2.0, or any later versions of that license, including any
exceptions or additional permissions as identified by the initial
Contributor.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby
grants Recipient a non-exclusive, worldwide, royalty-free copyright
license to reproduce, prepare Derivative Works of, publicly display,
publicly perform, Distribute and sublicense the Contribution of such
Contributor, if any, and such Derivative Works.
b) Subject to the terms of this Agreement, each Contributor hereby
grants Recipient a non-exclusive, worldwide, royalty-free patent
license under Licensed Patents to make, use, sell, offer to sell,
import and otherwise transfer the Contribution of such Contributor,
if any, in Source Code or other form. This patent license shall
apply to the combination of the Contribution and the Program if, at
the time the Contribution is added by the Contributor, such addition
of the Contribution causes such combination to be covered by the
Licensed Patents. The patent license shall not apply to any other
combinations which include the Contribution. No hardware per se is
licensed hereunder.
c) Recipient understands that although each Contributor grants the
licenses to its Contributions set forth herein, no assurances are
provided by any Contributor that the Program does not infringe the
patent or other intellectual property rights of any other entity.
Each Contributor disclaims any liability to Recipient for claims
brought by any other entity based on infringement of intellectual
property rights or otherwise. As a condition to exercising the
rights and licenses granted hereunder, each Recipient hereby
assumes sole responsibility to secure any other intellectual
property rights needed, if any. For example, if a third party
patent license is required to allow Recipient to Distribute the
Program, it is Recipient's responsibility to acquire that license
before distributing the Program.
d) Each Contributor represents that to its knowledge it has
sufficient copyright rights in its Contribution, if any, to grant
the copyright license set forth in this Agreement.
e) Notwithstanding the terms of any Secondary License, no
Contributor makes additional grants to any Recipient (other than
those set forth in this Agreement) as a result of such Recipient's
receipt of the Program under the terms of a Secondary License
(if permitted under the terms of Section 3).
3. REQUIREMENTS
3.1 If a Contributor Distributes the Program in any form, then:
a) the Program must also be made available as Source Code, in
accordance with section 3.2, and the Contributor must accompany
the Program with a statement that the Source Code for the Program
is available under this Agreement, and informs Recipients how to
obtain it in a reasonable manner on or through a medium customarily
used for software exchange; and
b) the Contributor may Distribute the Program under a license
different than this Agreement, provided that such license:
i) effectively disclaims on behalf of all other Contributors all
warranties and conditions, express and implied, including
warranties or conditions of title and non-infringement, and
implied warranties or conditions of merchantability and fitness
for a particular purpose;
ii) effectively excludes on behalf of all other Contributors all
liability for damages, including direct, indirect, special,
incidental and consequential damages, such as lost profits;
iii) does not attempt to limit or alter the recipients' rights
in the Source Code under section 3.2; and
iv) requires any subsequent distribution of the Program by any
party to be under a license that satisfies the requirements
of this section 3.
3.2 When the Program is Distributed as Source Code:
a) it must be made available under this Agreement, or if the
Program (i) is combined with other material in a separate file or
files made available under a Secondary License, and (ii) the initial
Contributor attached to the Source Code the notice described in
Exhibit A of this Agreement, then the Program may be made available
under the terms of such Secondary Licenses, and
b) a copy of this Agreement must be included with each copy of
the Program.
3.3 Contributors may not remove or alter any copyright, patent,
trademark, attribution notices, disclaimers of warranty, or limitations
of liability ("notices") contained within the Program from any copy of
the Program which they Distribute, provided that Contributors may add
their own appropriate notices.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities
with respect to end users, business partners and the like. While this
license is intended to facilitate the commercial use of the Program,
the Contributor who includes the Program in a commercial product
offering should do so in a manner which does not create potential
liability for other Contributors. Therefore, if a Contributor includes
the Program in a commercial product offering, such Contributor
("Commercial Contributor") hereby agrees to defend and indemnify every
other Contributor ("Indemnified Contributor") against any losses,
damages and costs (collectively "Losses") arising from claims, lawsuits
and other legal actions brought by a third party against the Indemnified
Contributor to the extent caused by the acts or omissions of such
Commercial Contributor in connection with its distribution of the Program
in a commercial product offering. The obligations in this section do not
apply to any claims or Losses relating to any actual or alleged
intellectual property infringement. In order to qualify, an Indemnified
Contributor must: a) promptly notify the Commercial Contributor in
writing of such claim, and b) allow the Commercial Contributor to control,
and cooperate with the Commercial Contributor in, the defense and any
related settlement negotiations. The Indemnified Contributor may
participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial
product offering, Product X. That Contributor is then a Commercial
Contributor. If that Commercial Contributor then makes performance
claims, or offers warranties related to Product X, those performance
claims and warranties are such Commercial Contributor's responsibility
alone. Under this section, the Commercial Contributor would have to
defend claims against the other Contributors related to those performance
claims and warranties, and if a court requires any other Contributor to
pay any damages as a result, the Commercial Contributor must pay
those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS"
BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
PURPOSE. Each Recipient is solely responsible for determining the
appropriateness of using and distributing the Program and assumes all
risks associated with its exercise of rights under this Agreement,
including but not limited to the risks and costs of program errors,
compliance with applicable laws, damage to or loss of data, programs
or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under
applicable law, it shall not affect the validity or enforceability of
the remainder of the terms of this Agreement, and without further
action by the parties hereto, such provision shall be reformed to the
minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against any entity
(including a cross-claim or counterclaim in a lawsuit) alleging that the
Program itself (excluding combinations of the Program with other software
or hardware) infringes such Recipient's patent(s), then such Recipient's
rights granted under Section 2(b) shall terminate as of the date such
litigation is filed.
All Recipient's rights under this Agreement shall terminate if it
fails to comply with any of the material terms or conditions of this
Agreement and does not cure such failure in a reasonable period of
time after becoming aware of such noncompliance. If all Recipient's
rights under this Agreement terminate, Recipient agrees to cease use
and distribution of the Program as soon as reasonably practicable.
However, Recipient's obligations under this Agreement and any licenses
granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement,
but in order to avoid inconsistency the Agreement is copyrighted and
may only be modified in the following manner. The Agreement Steward
reserves the right to publish new versions (including revisions) of
this Agreement from time to time. No one other than the Agreement
Steward has the right to modify this Agreement. The Eclipse Foundation
is the initial Agreement Steward. The Eclipse Foundation may assign the
responsibility to serve as the Agreement Steward to a suitable separate
entity. Each new version of the Agreement will be given a distinguishing
version number. The Program (including Contributions) may always be
Distributed subject to the version of the Agreement under which it was
received. In addition, after a new version of the Agreement is published,
Contributor may elect to Distribute the Program (including its
Contributions) under the new version.
Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
receives no rights or licenses to the intellectual property of any
Contributor under this Agreement, whether expressly, by implication,
estoppel or otherwise. All rights in the Program not expressly granted
under this Agreement are reserved. Nothing in this Agreement is intended
to be enforceable by any entity that is not a Contributor or Recipient.
No third-party beneficiary rights are created under this Agreement.
Exhibit A - Form of Secondary Licenses Notice
"This Source Code may also be made available under the following
Secondary Licenses when the conditions for such availability set forth
in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
version(s), and exceptions or additional permissions here}."
Simply including a copy of this Agreement, including this Exhibit A
is not sufficient to license the Source Code under Secondary Licenses.
If it is not possible or desirable to put the notice in a particular
file, then You may include the notice in a location (such as a LICENSE
file in a relevant directory) where a recipient would be likely to
look for such a notice.
You may add additional accurate notices of copyright ownership.
\ No newline at end of file
README.md
+ 65
− 6
View file @ dc3e5b1c
# Eclipse Api RESTful API
Source files for the API should be placed in __src__ folder.
## Installation
To install dependencies, run ___npm install___.
## Links
## Usage
To generate some pretty HTML into the docs folder, run ___npm run grunt build___ at the command line.
- [SwaggerUI](https://eclipsefdn.github.io/api.eclipse.org-docs/swagger-ui/)
- OpenAPI Raw Files: [JSON](https://eclipsefdn.github.io/api.eclipse.org-docs/openapi.json) [YAML](https://eclipsefdn.github.io/api.eclipse.org-docs/openapi.yaml)
To help development, if you run ___npm run grunt serve___, the HTML will be accessible from http://localhost:8080/index.html
**Warning:** All above links are updated only after Travis CI finishes deployment
When you save one of the source files, this page will automatically refresh.
\ No newline at end of file
## Getting started
### Install
1. Install [Node JS](https://nodejs.org/)
2. Clone repo and run `npm install` in the repo root
### Usage
#### `npm start`
Starts the development server.
#### `npm run build`
Bundles the spec and prepares web_deploy folder with static assets.
#### `npm test`
Validates the spec.
#### `npm run gh-pages`
Deploys docs to GitHub Pages. You don't need to run it manually if you have Travis CI configured.
## Contributing
1. [Fork](https://help.github.com/articles/fork-a-repo/) the [eclipsefdn/api.eclipse.org-docs](https://github.com/eclipsefdn/api.eclipse.org-docs) repository
2. Clone repository: `git clone https://github.com/[your_github_username]/api.eclipse.org-docs.git`
3. Create your feature branch: `git checkout -b my-new-feature`
4. Commit your changes: `git commit -m 'Add some feature' -s`
5. Push feature branch: `git push origin my-new-feature`
6. Submit a pull request
### Declared Project Licenses
This program and the accompanying materials are made available under the terms
of the Eclipse Public License v. 2.0 which is available at
http://www.eclipse.org/legal/epl-2.0.
SPDX-License-Identifier: EPL-2.0
## Bugs and feature requests
Have a bug or a feature request? Please search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/eclipsefdn/api.eclipse.org-docs/issues/new).
## Author
**Christopher Guindon (Eclipse Foundation)**
- <https://twitter.com/chrisguindon>
- <https://github.com/chrisguindon>
**Eric Poirier (Eclipse Foundation)**
- <https://twitter.com/ericpoir>
- <https://github.com/ericpoirier>
## Trademarks
* Eclipse® is a Trademark of the Eclipse Foundation, Inc.
* Eclipse Foundation is a Trademark of the Eclipse Foundation, Inc.
## Copyright and license
Copyright 2018 the [Eclipse Foundation, Inc.](https://www.eclipse.org) and the [api.eclipse.org-docs authors](https://github.com/eclipsefdn/api.eclipse.org-docs/graphs/contributors). Code released under the [Eclipse Public License Version 2.0 (EPL-2.0)](https://github.com/eclipsefdn/api.eclipse.org-docs/LICENSE).
\ No newline at end of file
docs/auth.html deleted 100644 → 0
+ 0
− 432
View file @ 2d6d1086
This diff is collapsed.
docs/index.html deleted 100644 → 0
+ 0
− 3052
View file @ 2d6d1086
source diff could not be displayed: it is too large. Options to address this: view the blob.
docs/proposals.html deleted 100644 → 0
+ 0
− 347
View file @ 2d6d1086
This diff is collapsed.
package-lock.json 0 → 100644
+ 3505
− 0
View file @ dc3e5b1c
This diff is collapsed.
package.json
+ 8
− 16
View file @ dc3e5b1c
{
"name": "eclipse_api_documentation",
"version": "0.0.0",
"description": "api-blueprint based API documentation for eclipse_api_documentation",
"license": "MIT",
"author": {
"name": "Christopher Guindon"
"version": "1.0.0",
"dependencies": {
"swagger-repo": "^2.0.0-rc.15"
},
"files": [
"dist/index.html"
],
"private": true,
"scripts": {
"grunt": "node_modules/.bin/grunt",
"postinstall": "find node_modules/ -name '*.info' -type f -delete"
},
"devDependencies": {
"grunt": "^1.0.2",
"grunt-aglio": "^0.4.1",
"grunt-contrib-connect": "^1.0.2",
"grunt-contrib-watch": "^1.0.0"
"start": "swagger-repo serve",
"build": "swagger-repo build -o web_deploy",
"test": "swagger-repo validate",
"gh-pages": "swagger-repo gh-pages"
}
}
spec/openapi.yaml 0 → 100644
+ 10828
− 0
View file @ dc3e5b1c
This diff is collapsed.
src/auth.apib deleted 100644 → 0
+ 0
− 19
View file @ 2d6d1086
FORMAT: 1A
HOST: https://accounts.eclipse.org
# Eclipse Authorization Server
This describes the resources that make up the official Eclipse Authorization server.
If you have any problems or requests please contact [Christopher Guindon](mailto:chris.guindon@eclipse-foundation.org) .
### Rate Limit
This API currently limits users to 1000 authenticated requests and 1000 anonymous requests an hour.
### 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.
<!-- include(modules/oauth2.apib) -->
src/index.apib deleted 100644 → 0
+ 0
− 74
View file @ 2d6d1086
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).
### 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))**
+ [Eclipse Jenkins](https://ci.eclipse.org/) **([Documentation](https://wiki.jenkins.io/display/JENKINS/Remote+access+API))**
+ [Eclipse Marketplace](http://marketplace.eclipse.org/) **([Documentation](https://wiki.eclipse.org/Marketplace/REST))**
+ [Eclipse Project Management Infrastructure (PMI)](https://wiki.eclipse.org/Project_Management_Infrastructure) **([Documentation](https://wiki.eclipse.org/Project_Management_Infrastructure#Web_APIs))**
### 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:
```curl -I "https://api.eclipse.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"
```
Let’s break that down. rel="next" says that the next page is page=2. This makes sense, since by default,
all paginated queries start at page 1. rel="last" provides some more information, stating that the last page of results is on page 27.
Keep in mind that you should always rely on these link relations provided to you. Don’t try to guess or construct your own URL.
### Caching
Most responses return an ETag header. You can use the values of these headers to make subsequent
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 we are currently generating them:
```
function _generate_etag($value, $application_token, $key) {
$string = $value . $application_token . $key;
return hash('sha256', $string, FALSE);
}
```
### 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.
<!-- include(modules/account.apib) -->
<!-- include(modules/uss.apib) -->
<!-- include(modules/download.apib) -->
<!-- include(modules/marketplace_favorites.apib) -->
<!-- include(modules/forums.apib) -->
<!-- include(modules/mailing_lists.apib) -->
src/modules/account.apib deleted 100644 → 0
+ 0
− 108
View file @ 2d6d1086
This diff is collapsed.
src/modules/download.apib deleted 100644 → 0
+ 0
− 34
View file @ 2d6d1086
This diff is collapsed.
src/modules/forums.apib deleted 100644 → 0
+ 0
− 381
View file @ 2d6d1086
This diff is collapsed.
src/modules/mailing_lists.apib deleted 100644 → 0
+ 0
− 74
View file @ 2d6d1086
This diff is collapsed.
src/modules/marketplace_favorites.apib deleted 100644 → 0
+ 0
− 111
View file @ 2d6d1086
This diff is collapsed.
src/modules/oauth2.apib deleted 100644 → 0
+ 0
− 43
View file @ 2d6d1086
FORMAT: 1A
# Group Authorization
*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 exchanged for an `access_token`.
+ Parameters
+ response_type (string, required) - Indicates that your server expects to receive an authorization code.
+ client_id (string, required) - The client ID you received when you first created the application.
+ redirect_uri (string, required) - Indicates the URI to return the user to after authorization is complete.
+ scope (string, required) - One or more scope values.
+ state (string, required) - A random string generated by your application for client validation.
+ Response 302
+ Attributes (OAuth valid code redirect)
## OAuth2 Token [POST /oauth2/token]
Exchange `authorization_code` for `access_token`.
+ Request
+ Attributes (OAuth grant request)
+ Response 200 (application/json)
+ Attributes (OAuth valid response)
# Data Structures
## OAuth grant request (object)
+ `grant_type`: `authorization_code` (string, required)
+ `code`: `1da42105f3e19a3046ccc1de38d00c49e280e1aa` (string, required)
+ `redirect_uri`: `https%3A//localhost/`
## OAuth valid response (object)
+ `access_token`: `fabd8667bc46717fb19f1e35855639c332f34d38` (string, required)
+ scope: all (string, required) - scopes of current token
+ `expires_in`: 900 (number, required)
+ `token_type`: Bearer (string, required)
+ `refresh_token`: `5d50a0d1392a327a254b749dce3ccf72426b402a`
## OAuth valid code redirect (object)
+ `code`: `authorization_code`
+ `state`: `123456abcdef`
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