Eclipse Foundation Git ECA API (1.1.0)

Download OpenAPI specification:Download

URL: https://gitlab.eclipse.org/eclipsefdn/it/api/git-eca-rest-api/-/issues License: Eclipse Public License - 2.0

Collection of API endpoints used in the validation and management of external Git services, such as Gitlab and Github.

ECA Validation

Definitions in relation to the validation of Git commits through ECA signage

ECA validation

Validates a list of commits for a merge request.

Request Body schema: application/json

provider required	string Enum: "github" "gitlab" "gerrit" The provider for which the commit is being validated for
repoUrl required	string the outward facing URL of the repo the commit belongs to.
strictMode required	boolean Whether to strictly apply validation regardless of project matching
estimatedLoc	integer or null The estimated LOC changed by the set of commits sent for validation.
required	Array of objects >= 1

Responses

Request samples

Payload

Content type

application/json

{"provider": "github",
"repoUrl": "string",
"strictMode": true,
"estimatedLoc": 0,
"commits": [{"hash": "string",
"body": null,
"subject": null,
"author": {"name": "string",
"mail": "string",
"external_id": null
},
"committer": {"name": "string",
"mail": "string",
"external_id": null
},
"last_modification_date": "2019-08-24T14:15:22Z",
"head": true,
"parents": ["string"
]
}
]
}

Response samples

200

Content type

application/json

{"time": "2019-08-24T14:15:22Z",
"trackedProject": true,
"strictMode": true,
"fingerprint": "string",
"errorCount": 0,
"passed": true,
"commits": {"property1": {"messages": [{"code": 0,
"message": "string"
}
],
"warnings": [{"code": 0,
"message": "string"
}
],
"errors": [{"code": 0,
"message": "string"
}
]
},
"property2": {"messages": [{"code": 0,
"message": "string"
}
],
"warnings": [{"code": 0,
"message": "string"
}
],
"errors": [{"code": 0,
"message": "string"
}
]
}
}
}

Historic ECA validation status

Returns a set of validation messages for the given unique fingerprint

path Parameters

fingerprint

required

string

Unique ID for the request group

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"commit_hash": "string",
"user_mail": "string",
"estimated_loc": 0,
"project": "string",
"repo_url": "string",
"provider": "github",
"creation_date": "2019-08-24T14:15:22Z",
"last_modified": "2019-08-24T14:15:22Z",
"errors": [{"id": 0,
"status_code": 0,
"eclipse_id": null,
"author_email": "string",
"committer_email": "string",
"provider_id": null
}
]
}
]

Historic ECA validation status in a HTML format

Returns an HTMl page containing validation messages

path Parameters

fingerprint

required

string

Unique ID for the request group

Responses

User status lookup

Returns wether or not the user has a signed ECA

query Parameters

q	string Query string containing either email or username. Email is only valid for logged in committers/project leads
email	string Deprecated Email is only valid for logged in committers/project leads. For removal at the end of 2024.

Responses

Reports

Reports on metadata associated with Git systems managed by the Eclipse Foundation

Gitlab private project event report

Returns list of private project events using desired filters

query Parameters

key required	string The endpoint access key
status	string the project's current status - active/deleted
since	string Starting date range for project creation date - yyyy-MM-dd
until	string Ending date range for project creation date - yyyy-MM-dd

Responses

Response samples

200
400

Content type

application/json

[{"user_id": 0,
"project_id": 0,
"project_path": "string",
"ef_username": "string",
"parent_project": 0,
"creation_date": "string",
"deletion_date": "string"
}
]

Integration Webhooks

Endpoints related to binding to external Git services through a webhook

Github incoming hook event processing

Process incoming pull request hook events from Github

header Parameters

X-GitHub-Delivery required	string
X-GitHub-Event required	string
X-GitHub-Hook-ID required	string

Request Body schema: application/json

	object Information about the Github App installation making this request
	object Information about the repository that triggered this request
	object Information on the pull request that triggered this workflow.

Responses

Request samples

Payload

Content type

application/json

{"installation": {"id": "string"
},
"repository": {"full_name": "string",
"html_url": "string"
},
"pull_request": {"number": null,
"head": {"sha": "string"
}
}
}

Gitlab webhook revalidation request

Process incoming system hooks from GitLab

path Parameters

fingerprint

required

string

Unique ID for the request group

Request Body schema: application/x-www-form-urlencoded

h-form-captcha-response

required

string

the hCaptcha challenge response.

Responses

Response samples

400

Content type

application/json

{"status_code": 0,
"message": "string",
"url": "string"
}

Gitlab event processing

Process incoming system hooks from GitLab

header Parameters

X-Gitlab-Event

required

string

Request Body schema: application/json

created_at required	string <date-time> (DateTime) Time of the project creation event
updated_at required	string <date-time> (DateTime) Time indicating the last event occured
event_name required	string The event type
name required	string The project name
owner_email required	string The namespace's email. If not user, will be empty
owner_name required	string The namespace name (group, user)
required	Array of objects The project owners
path required	string The project path
path_with_namespace required	string The project path with namespace
project_id required	integer The project's gitlab id
project_visibility required	string The project's visibility (public, private)
old_path_with_namespace	null or string The old path with namespace, only used in 'project_rename' hooks

Responses

Request samples

Payload

Content type

application/json

{"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"event_name": "string",
"name": "string",
"owner_email": "string",
"owner_name": "string",
"owners": [{"name": "string",
"email": "string"
}
],
"path": "string",
"path_with_namespace": "string",
"project_id": 0,
"project_visibility": "string",
"old_path_with_namespace": null
}