Eclipse Foundation Git Hub API

openapi: 3.2.0
info:
  title: Eclipse Project Management Infrastructure (PMI) RESTful…
  description: 'This describes the resources that make up the Eclipse Project Management Infrastructure (PMI) REST API.

    You can contribute to this document via our git repository.

    If you have any problems or requests please submit an issue.


    ### 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://projects.eclipse.org/api/projects?page=1&pagesize=20\"

    ```

    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:

    ```

    ; rel="next",

    ; rel="last",

    ; rel="first",

    ; 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.


    ### Error States

    The common HTTP Response Status Codes are used.'
  contact: {}
  version: '1.0'
servers:
- url: https://projects.eclipse.org
  description: The production API server
tags:
- name: Github
  description: GitHub repository index for Eclipse projects.
paths:
  /api/github:
    get:
      tags:
      - Github
      summary: Fetch GitHub Repositories for all Projects
      description: '### Overview


        Returns a map of Eclipse project IDs to their associated GitHub repositories. Optionally filter by a specific repository name substring.'
      operationId: FetchGithubRepos
      parameters:
      - name: repo
        in: query
        description: Filter by repository path (org/repo, e.g. `eclipse-ee4j/batch-api`). A `LIKE '%<value>'` pattern is applied, so a partial trailing match is sufficient.
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: A map of project IDs to their GitHub repository data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GithubIndexResponse'
              example:
                ee4j.batch:
                  repos:
                  - eclipse-ee4j/batch-api
                  - eclipse-ee4j/batch-tck
                  specification_project: true
  /api/github/{project_id}:
    get:
      tags:
      - Github
      summary: Fetch GitHub Repositories for a Project
      description: '### Overview


        Returns the GitHub repositories for a specific Eclipse project. Underscores in `project_id` are treated as dots.'
      operationId: FetchGithubReposByProject
      parameters:
      - name: project_id
        in: path
        description: ID of the project. Underscores are treated as dots.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: A map containing the GitHub repositories for the given project (empty map if not found).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GithubIndexResponse'
              example:
                ee4j.batch:
                  repos:
                  - eclipse-ee4j/batch-api
                  - eclipse-ee4j/batch-tck
                  specification_project: true
components:
  schemas:
    GithubProjectEntry:
      title: GithubProjectEntry
      type: object
      description: GitHub repository data for a single Eclipse project.
      properties:
        repos:
          type: array
          items:
            type: string
          description: GitHub repository paths in `org/repo` format (the `https://github.com/` prefix is stripped).
        specification_project:
          type: boolean
          description: Whether this project has a specification working group configured.
      example:
        repos:
        - eclipse-ee4j/batch-api
        - eclipse-ee4j/batch-tck
        specification_project: true
    GithubIndexResponse:
      title: GithubIndexResponse
      type: object
      description: A map of Eclipse project IDs to their GitHub repository data. Keys are project IDs (e.g. `ee4j.batch`).
      additionalProperties:
        $ref: '#/components/schemas/GithubProjectEntry'
      example:
        ee4j.batch:
          repos:
          - eclipse-ee4j/batch-api
          - eclipse-ee4j/batch-tck
          specification_project: true