Skip to content
Snippets Groups Projects

feat: Update spec to include missing endpoints

Merged feat: Update spec to include missing endpoints
zacharysabourin/git-eca-rest-api:zacharysabourin/master/77 into master
Merged Zachary Sabourin requested to merge zacharysabourin/git-eca-rest-api:zacharysabourin/master/77 into master
Compare
and
1 file
+ 252
− 220
Compare changes
  • Side-by-side
  • Inline
spec/openapi.yaml
+ 252
− 220
openapi: '3.1.0'
openapi: "3.1.0"
info:
version: 1.1.0
title: Eclipse Foundation Git ECA API
license:
name: Eclipse Public License - 2.0
url: https://www.eclipse.org/legal/epl-2.0/
version: 1.1.0
title: Eclipse Foundation Git ECA API
license:
name: Eclipse Public License - 2.0
url: https://www.eclipse.org/legal/epl-2.0/
servers:
- url: https://api.eclipse.org/git
description: Production endpoint for the Git ECA validation API
- url: https://api.eclipse.org/git
description: Production endpoint for the Git ECA validation API
tags:
- name: ECA Validation
description: Definitions in relation to the validation of Git commits through ECA signage
- name: ECA Validation
description: Definitions in relation to the validation of Git commits through ECA signage
paths:
/eca:
post:
tags:
- ECA Validation
summary: ECA validation
description: Validates a list of commits for a merge request.
requestBody:
/eca:
post:
tags:
- ECA Validation
summary: ECA validation
description: Validates a list of commits for a merge request.
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationRequest"
responses:
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationRequest'
responses:
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationResponse'
500:
description: Error while retrieving data
/eca/{fingerprint}:
get:
tags:
schema:
$ref: "#/components/schemas/ValidationResponse"
500:
description: Error while retrieving data
/eca/status/{fingerprint}:
get:
tags:
- ECA Validation Status
summary: Historic ECA validation status
description: Returns a set of validation messages for the given unique fingerprint
responses:
200:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CommitValidationStatuses'
404:
description: Could not find any commits for given fingerprint
summary: Historic ECA validation status
description: Returns a set of validation messages for the given unique fingerprint
responses:
200:
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CommitValidationStatuses"
/eca/status/{fingerprint}/ui:
get:
summary: Historic ECA validation status in a HTML format
description: Returns an HTMl page containing validation messages
responses:
200:
description: Success. An HTML page containing status info
404:
description: Not Found
/eca/lookup:
get:
summary: User status lookup
description: Returns wether or not the user has a signed ECA
responses:
200:
description: Success
403:
description: User exists with no ECA
404:
description: User not found
components:
schemas:
NullableString:
description: A nullable String type value
type:
- 'null'
- string
DateTime:
type: string
format: datetime
description: |
Date string in the RFC 3339 format. Example, `1990-12-31T15:59:60-08:00`.
schemas:
NullableString:
description: A nullable String type value
type:
- "null"
- string
DateTime:
type: string
format: datetime
description: |
Date string in the RFC 3339 format. Example, `1990-12-31T15:59:60-08:00`.
More on this standard can be read at https://tools.ietf.org/html/rfc3339.
More on this standard can be read at https://tools.ietf.org/html/rfc3339.
ValidationRequest:
type: object
properties:
provider:
type: string
description: The provider for which the commit is being validated for
enum:
- github
- gitlab
- gerrit
repoUrl:
type: string
description: the outward facing URL of the repo the commit belongs to.
strictMode:
type: boolean
description: Whether to strictly apply validation regardless of project matching
commits:
type: array
minimum: 1
items:
type: object
properties:
hash:
ValidationRequest:
type: object
properties:
provider:
type: string
description: The provider for which the commit is being validated for
enum:
- github
- gitlab
- gerrit
repoUrl:
type: string
description: the outward facing URL of the repo the commit belongs to.
strictMode:
type: boolean
description: Whether to strictly apply validation regardless of project matching
commits:
type: array
minimum: 1
items:
type: object
properties:
hash:
type: string
description: The hash of the commit. Used for messaging and logging.
body:
$ref: "#/components/schemas/NullableString"
description: The body message of the commit if available
subject:
$ref: "#/components/schemas/NullableString"
description: The subject of the commit
author:
$ref: "#/components/schemas/GitUser"
description: The author of the Git commit
committer:
$ref: "#/components/schemas/GitUser"
description: The committer of the Git commit
head:
type:
- boolean
- "null"
description: True if the current commit is the head commit, false otherwise
parents:
type: array
items:
type: string
description: The hash of the commit. Used for messaging and logging.
body:
$ref: '#/components/schemas/NullableString'
description: The body message of the commit if available
subject:
$ref: '#/components/schemas/NullableString'
description: The subject of the commit
author:
$ref: '#/components/schemas/GitUser'
description: The author of the Git commit
committer:
$ref: '#/components/schemas/GitUser'
description: The committer of the Git commit
head:
type:
- boolean
- 'null'
description: True if the current commit is the head commit, false otherwise
parents:
type: array
items:
type: string
description: Parent commit hashes, multiple will be present for merge commits
GitUser:
type: object
properties:
name:
type: string
description: The name of the git user
mail:
type: string
description: the email address of the user
ValidationResponse:
type: object
properties:
time:
$ref: '#/components/schemas/DateTime'
description: Time of the request validation for logging/tracking purposes.
trackedProject:
type: boolean
description: Whether the project is tracked in PMI and is an Eclipse project.
strictMode:
type: boolean
description: Whether strict mode was enforced for the validation.
fingerprint:
type: string
description: The unique fingerprint to use when looking up commit data
errorCount:
type: integer
description: The number of errors encountered while validating the request
passed:
type: boolean
description: Whether the current request is valid in relation to ECA signage.
commits:
type: object
propertyNames:
description: The commit hash of the commit that was validated
additionalProperties:
$ref: '#/components/schemas/Commit'
Commit:
type: object
properties:
messages:
type: array
description: List of informational messages about the validation of the current commit.
items:
$ref: '#/components/schemas/CommitMessage'
warnings:
type: array
description: List of non-fatal issues encountered in the validation of the current commit
items:
$ref: '#/components/schemas/CommitMessage'
errors:
type: array
description: List of errors encountered in the validation of the current commit
items:
$ref: '#/components/schemas/CommitMessage'
CommitMessage:
type: object
properties:
code:
type: integer
description: the internal status code for the message
message:
type: string
description: Information about the commit message. This can either be information about the validation process to report or the source of an error to be corrected.
CommitValidationStatuses:
type: array
items:
$ref: '#/components/schemas/CommitValidationStatus'
CommitValidationStatus:
type: object
properties:
id:
type: integer
description: internal ID of the commit for tracking
sha:
type: string
description: the SHA of the commit that was validated
project:
type: string
description: The short project ID of the project that was detected for the commit, if it exists.
repo_url:
type: string
description: the outward facing URL of the repo the commit belongs to.
provider:
type: string
description: The provider for which the commit is being validated for
enum:
- github
- gitlab
- gerrit
creation_date:
$ref: '#/components/schemas/DateTime'
description: Time that the commit was first attempted to be validated
last_modified:
$ref: '#/components/schemas/DateTime'
description: The latest tracked time of validation.
errors:
type: array
items:
$ref: '#/components/schemas/CommitValidationMessage'
CommitValidationMessage:
type: object
properties:
id:
type: integer
description: internal ID of the commit message for tracking
commit_id:
type: integer
description: internal ID of the commit for tracking
status_code:
type: integer
description: error code associated with the commit
eclipse_id:
type: string
description: the Eclipse Foundation ID of the user
author_email:
type: string
description: Email address of the author of the commit for additional information
provider_id:
type: string
description: the outward facing URL of the repo the commit belongs to.
description: Parent commit hashes, multiple will be present for merge commits
GitUser:
type: object
properties:
name:
type: string
description: The name of the git user
mail:
type: string
description: the email address of the user
ValidationResponse:
type: object
properties:
time:
$ref: "#/components/schemas/DateTime"
description: Time of the request validation for logging/tracking purposes.
trackedProject:
type: boolean
description: Whether the project is tracked in PMI and is an Eclipse project.
strictMode:
type: boolean
description: Whether strict mode was enforced for the validation.
fingerprint:
type: string
description: The unique fingerprint to use when looking up commit data
errorCount:
type: integer
description: The number of errors encountered while validating the request
passed:
type: boolean
description: Whether the current request is valid in relation to ECA signage.
commits:
type: object
propertyNames:
description: The commit hash of the commit that was validated
additionalProperties:
$ref: "#/components/schemas/Commit"
Commit:
type: object
properties:
messages:
type: array
description: List of informational messages about the validation of the current commit.
items:
$ref: "#/components/schemas/CommitMessage"
warnings:
type: array
description: List of non-fatal issues encountered in the validation of the current commit
items:
$ref: "#/components/schemas/CommitMessage"
errors:
type: array
description: List of errors encountered in the validation of the current commit
items:
$ref: "#/components/schemas/CommitMessage"
CommitMessage:
type: object
properties:
code:
type: integer
description: the internal status code for the message
message:
type: string
description: Information about the commit message. This can either be information about the validation process to report or the source of an error to be corrected.
CommitValidationStatuses:
type: array
items:
$ref: "#/components/schemas/CommitValidationStatus"
CommitValidationStatus:
type: object
properties:
id:
type: integer
description: internal ID of the commit for tracking
sha:
type: string
description: the SHA of the commit that was validated
project:
type: string
description: The short project ID of the project that was detected for the commit, if it exists.
repo_url:
type: string
description: the outward facing URL of the repo the commit belongs to.
provider:
type: string
description: The provider for which the commit is being validated for
enum:
- github
- gitlab
- gerrit
creation_date:
$ref: "#/components/schemas/DateTime"
description: Time that the commit was first attempted to be validated
last_modified:
$ref: "#/components/schemas/DateTime"
description: The latest tracked time of validation.
errors:
type: array
items:
$ref: "#/components/schemas/CommitValidationMessage"
CommitValidationMessage:
type: object
properties:
id:
type: integer
description: internal ID of the commit message for tracking
commit_id:
type: integer
description: internal ID of the commit for tracking
status_code:
type: integer
description: error code associated with the commit
eclipse_id:
type: string
description: the Eclipse Foundation ID of the user
author_email:
type: string
description: Email address of the author of the commit for additional information
provider_id:
type: string
description: the outward facing URL of the repo the commit belongs to.

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