SQAaaS API (3.1.1)

Download OpenAPI specification:Download

License: GPLv3

OpenAPI specification for the Software and Service Quality Assurance as a Service (SQAaaS) component.

Returns data about criteria

query Parameters

criterion_id	string Get data from a specific criterion
assessment	boolean Default: false Flag to indicate whether the criteria shall consider only assessment-related tools

Responses

Response samples

200

Content type

application/json


[
{"id": "QC.Sty",
"type": "software",
"description": 
{"msg": "string",
"improves": "string",
"docs": "http://example.com"
},
"tools": 
[
{"name": "fair-eva",
"lang": "fair",
"version": "2.0.0",
"jepl_support": true,
"docs": "http://example.com",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"executable": "string",
"args": 
[
{"type": "subcommand",
"id": "string",
"description": "Detect the license of the given project",
"value": "detect",
"option": "string",
"summary": "string",
"format": "string",
"selectable": true,
"repeatable": false,
"args": 
[{ }
]
}
]
}
]
}
]

Creates a pipeline.

Provides a ready-to-use Jenkins pipeline based on the v2 series of jenkins-pipeline-library.

query Parameters

report_to_stdout

boolean

Default: false

Flag to indicate whether the pipeline shall print via via stdout the reports produced by the tools (required by QAA module)

Request Body schema: application/json

name	string <[A-Za-z0-9_.-]> Name that identifies the pipeline
	Array of objects (JePL_config) Details about the pipeline configuration
	object (JePL_composer) Details about the composition of the services required for the pipeline execution
	object (JePL_jenkinsfile) Details about the Jenkins Pipeline as Code

Responses

Request samples

Payload

Content type

application/json


{"name": "sqaaas-api-spec",
"config_data": 
[
{"config": 
{"project_repos": 
[
{"repo": "https://github.com/eosc-synergy/sqaaas-api-spec",
"branch": "master",
"credentials_id": 
{"secret_id": "my_gitlab_secret",
"user_id": "my_gitlab_user",
"token": "my_gitlab_token"
}
}
],
"credentials": 
[
{"id": "my-dockerhub-token",
"type": "username_password",
"username_var": "GIT_USER",
"password_var": "GIT_PASS"
}
]
},
"sqa_criteria": 
{"property1": 
{"repos": 
[
{"repo_url": "https://github.com/eosc-synergy/sqaaas-api-spec",
"container": "testing",
"commands": 
["mvn checkstyle:check"
],
"tox": 
{"testenv": 
["cover"
],
"tox_file": "tox.ini"
},
"tool": 
{"name": "fair-eva",
"lang": "fair",
"version": "2.0.0",
"jepl_support": true,
"docs": "http://example.com",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"executable": "string",
"args": 
[
{"type": "subcommand",
"id": "string",
"description": "Detect the license of the given project",
"value": "detect",
"option": "string",
"summary": "string",
"format": "string",
"selectable": true,
"repeatable": false,
"args": 
[{ }
]
}
]
}
}
],
"when": 
{"branch": 
{"pattern": "release-\\\\d+",
"comparator": "GLOB"
},
"building_tag": true
}
},
"property2": 
{"repos": 
[
{"repo_url": "https://github.com/eosc-synergy/sqaaas-api-spec",
"container": "testing",
"commands": 
["mvn checkstyle:check"
],
"tox": 
{"testenv": 
["cover"
],
"tox_file": "tox.ini"
},
"tool": 
{"name": "fair-eva",
"lang": "fair",
"version": "2.0.0",
"jepl_support": true,
"docs": "http://example.com",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"executable": "string",
"args": 
[
{"type": "subcommand",
"id": "string",
"description": "Detect the license of the given project",
"value": "detect",
"option": "string",
"summary": "string",
"format": "string",
"selectable": true,
"repeatable": false,
"args": 
[{ }
]
}
]
}
}
],
"when": 
{"branch": 
{"pattern": "release-\\\\d+",
"comparator": "GLOB"
},
"building_tag": true
}
}
},
"environment": 
{"JPL_IGNOREFAILURES": "defined",
"JPL_DOCKERPUSH": "docs service1 service4"
},
"timeout": 1
}
],
"composer_data": 
{"version": "3.7",
"services": 
{"property1": 
{"build": 
{"context": "./dir",
"dockerfile": "Dockerfile-alternate",
"args": 
{"property1": "string",
"property2": "string"
}
},
"image": 
{"name": "eoscsynergy/sqaaas-api-spec:1.0.0",
"registry": 
{"push": true,
"credential_id": "my-dockerhub-cred"
}
},
"hostname": "sqaaas-host",
"volumes": 
[
{"type": "bind",
"source": "./",
"target": "./sqaaas-build"
}
],
"command": "sleep 600000",
"environment": 
{"JPL_IGNOREFAILURES": "defined",
"JPL_DOCKERPUSH": "docs service1 service4"
},
"oneshot": true
},
"property2": 
{"build": 
{"context": "./dir",
"dockerfile": "Dockerfile-alternate",
"args": 
{"property1": "string",
"property2": "string"
}
},
"image": 
{"name": "eoscsynergy/sqaaas-api-spec:1.0.0",
"registry": 
{"push": true,
"credential_id": "my-dockerhub-cred"
}
},
"hostname": "sqaaas-host",
"volumes": 
[
{"type": "bind",
"source": "./",
"target": "./sqaaas-build"
}
],
"command": "sleep 600000",
"environment": 
{"JPL_IGNOREFAILURES": "defined",
"JPL_DOCKERPUSH": "docs service1 service4"
},
"oneshot": true
}
}
},
"jenkinsfile_data": 
{"stages": 
[
{"when": 
{"branches": 
["master"
]
},
"pipeline_config": 
{"config_file": "./.sqa/config.yml",
"base_repository": "master",
"base_branch": "https://github.com/eosc-synergy/sqaaas-api-spec",
"credentials_id": "userpass_dockerhub",
"jepl_validator_docker_image": "eoscsynergy/jpl-validator:1.1.0"
}
}
]
}
}

Response samples

201

Content type

application/json


{"id": "dd7d8481-81a3-407f-95f0-a2f1cb382a4b"
}

Gets pipeline IDs.

Returns the list of IDs for the defined pipelines.

Responses

Response samples

200

Content type

application/json


[
{"id": "dd7d8481-81a3-407f-95f0-a2f1cb382a4b",
"name": "sqaaas-api-spec",
"config_data": 
[
{"config": 
{"project_repos": 
[
{"repo": "https://github.com/eosc-synergy/sqaaas-api-spec",
"branch": "master",
"credentials_id": 
{"secret_id": "my_gitlab_secret",
"user_id": "my_gitlab_user",
"token": "my_gitlab_token"
}
}
],
"credentials": 
[
{"id": "my-dockerhub-token",
"type": "username_password",
"username_var": "GIT_USER",
"password_var": "GIT_PASS"
}
]
},
"sqa_criteria": 
{"property1": 
{"repos": 
[
{"repo_url": "https://github.com/eosc-synergy/sqaaas-api-spec",
"container": "testing",
"commands": 
["mvn checkstyle:check"
],
"tox": 
{"testenv": 
["cover"
],
"tox_file": "tox.ini"
},
"tool": 
{"name": "fair-eva",
"lang": "fair",
"version": "2.0.0",
"jepl_support": true,
"docs": "http://example.com",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"executable": "string",
"args": 
[
{"type": "subcommand",
"id": "string",
"description": "Detect the license of the given project",
"value": "detect",
"option": "string",
"summary": "string",
"format": "string",
"selectable": true,
"repeatable": false,
"args": 
[{ }
]
}
]
}
}
],
"when": 
{"branch": 
{"pattern": "release-\\\\d+",
"comparator": "GLOB"
},
"building_tag": true
}
},
"property2": 
{"repos": 
[
{"repo_url": "https://github.com/eosc-synergy/sqaaas-api-spec",
"container": "testing",
"commands": 
["mvn checkstyle:check"
],
"tox": 
{"testenv": 
["cover"
],
"tox_file": "tox.ini"
},
"tool": 
{"name": "fair-eva",
"lang": "fair",
"version": "2.0.0",
"jepl_support": true,
"docs": "http://example.com",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"executable": "string",
"args": 
[
{"type": "subcommand",
"id": "string",
"description": "Detect the license of the given project",
"value": "detect",
"option": "string",
"summary": "string",
"format": "string",
"selectable": true,
"repeatable": false,
"args": 
[{ }
]
}
]
}
}
],
"when": 
{"branch": 
{"pattern": "release-\\\\d+",
"comparator": "GLOB"
},
"building_tag": true
}
}
},
"environment": 
{"JPL_IGNOREFAILURES": "defined",
"JPL_DOCKERPUSH": "docs service1 service4"
},
"timeout": 1
}
],
"composer_data": 
{"version": "3.7",
"services": 
{"property1": 
{"build": 
{"context": "./dir",
"dockerfile": "Dockerfile-alternate",
"args": 
{"property1": "string",
"property2": "string"
}
},
"image": 
{"name": "eoscsynergy/sqaaas-api-spec:1.0.0",
"registry": 
{"push": true,
"credential_id": "my-dockerhub-cred"
}
},
"hostname": "sqaaas-host",
"volumes": 
[
{"type": "bind",
"source": "./",
"target": "./sqaaas-build"
}
],
"command": "sleep 600000",
"environment": 
{"JPL_IGNOREFAILURES": "defined",
"JPL_DOCKERPUSH": "docs service1 service4"
},
"oneshot": true
},
"property2": 
{"build": 
{"context": "./dir",
"dockerfile": "Dockerfile-alternate",
"args": 
{"property1": "string",
"property2": "string"
}
},
"image": 
{"name": "eoscsynergy/sqaaas-api-spec:1.0.0",
"registry": 
{"push": true,
"credential_id": "my-dockerhub-cred"
}
},
"hostname": "sqaaas-host",
"volumes": 
[
{"type": "bind",
"source": "./",
"target": "./sqaaas-build"
}
],
"command": "sleep 600000",
"environment": 
{"JPL_IGNOREFAILURES": "defined",
"JPL_DOCKERPUSH": "docs service1 service4"
},
"oneshot": true
}
}
},
"jenkinsfile_data": 
{"stages": 
[
{"when": 
{"branches": 
["master"
]
},
"pipeline_config": 
{"config_file": "./.sqa/config.yml",
"base_repository": "master",
"base_branch": "https://github.com/eosc-synergy/sqaaas-api-spec",
"credentials_id": "userpass_dockerhub",
"jepl_validator_docker_image": "eoscsynergy/jpl-validator:1.1.0"
}
}
]
}
}
]

Creates a pipeline for assessment (QAA module).

query Parameters

optional_tools

Array of strings

Optional tools that shall be accounted

Request Body schema: application/json

	object (Repository)
	object (Repository)
	object (AssessmentDeployment)
	object (AssessmentFAIR)
	Array of objects (CriterionWorkflow)

Responses

Request samples

Payload

Content type

application/json


{"repo_code": 
{"repo": "https://github.com/eosc-synergy/sqaaas-api-spec",
"branch": "master",
"credentials_id": 
{"secret_id": "my_gitlab_secret",
"user_id": "my_gitlab_user",
"token": "my_gitlab_token"
}
},
"repo_docs": 
{"repo": "https://github.com/eosc-synergy/sqaaas-api-spec",
"branch": "master",
"credentials_id": 
{"secret_id": "my_gitlab_secret",
"user_id": "my_gitlab_user",
"token": "my_gitlab_token"
}
},
"deployment": 
{"repo_deploy": 
{"repo": "https://github.com/eosc-synergy/sqaaas-api-spec",
"branch": "master",
"credentials_id": 
{"secret_id": "my_gitlab_secret",
"user_id": "my_gitlab_user",
"token": "my_gitlab_token"
}
},
"deploy_tool": 
{"name": "fair-eva",
"lang": "fair",
"version": "2.0.0",
"jepl_support": true,
"docs": "http://example.com",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"executable": "string",
"args": 
[
{"type": "subcommand",
"id": "string",
"description": "Detect the license of the given project",
"value": "detect",
"option": "string",
"summary": "string",
"format": "string",
"selectable": true,
"repeatable": false,
"args": 
[{ }
]
}
]
}
},
"fair": 
{"fair_tool": 
{"name": "fair-eva",
"lang": "fair",
"version": "2.0.0",
"jepl_support": true,
"docs": "http://example.com",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"executable": "string",
"args": 
[
{"type": "subcommand",
"id": "string",
"description": "Detect the license of the given project",
"value": "detect",
"option": "string",
"summary": "string",
"format": "string",
"selectable": true,
"repeatable": false,
"args": 
[{ }
]
}
]
}
},
"criteria_workflow": 
[
{"id": "QC.Sty",
"tools": 
[
{"name": "fair-eva",
"lang": "fair",
"version": "2.0.0",
"jepl_support": true,
"docs": "http://example.com",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"executable": "string",
"args": 
[
{"type": "subcommand",
"id": "string",
"description": "Detect the license of the given project",
"value": "detect",
"option": "string",
"summary": "string",
"format": "string",
"selectable": true,
"repeatable": false,
"args": 
[{ }
]
}
]
}
]
}
]
}

Response samples

201

Content type

application/json


{"id": "dd7d8481-81a3-407f-95f0-a2f1cb382a4b"
}

Get the assessment output (QAA module)

Returns the reporting and badging data from the execution of the assessment pipeline.

path Parameters

pipeline_id

required

string

ID of the pipeline to get

Responses

Response samples

200

Content type

application/json


{"meta": 
{"version": "string",
"report_json_url": "http://example.com"
},
"repository": 
[
{"name": "sqaaas-api-spec",
"url": "https://github.com/eosc-synergy/sqaaas-api-spec",
"avatar_url": "https://avatars.githubusercontent.com/u/57723286?v=4",
"description": "OpenAPI specification for the SQA as a Service",
"languages": 
["Shell"
],
"tag": "2.5.0",
"topics": 
["openapi",
"sqaaas"
],
"stargazers_count": 2,
"watchers_count": 2,
"contributors_count": 2,
"forks_count": 2
}
],
"report": 
{"property1": 
{"valid": false,
"filtered_reason": [ ],
"subcriteria": 
{"property1": 
{"description": "All code repositories MUST have a README file",
"valid": true,
"evidence": 
[
{"valid": true,
"message": "README file does not exist",
"plugin": 
{"name": "report2sqaaas-plugin-licensee",
"version": "1.0.0"
},
"tool": 
{"name": "flake8",
"lang": "Python",
"version": "4.0.1",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"ci": 
{"name": "string",
"status": "SUCCESS",
"stdout_command": 
["string"
],
"stdout_text": "string",
"url": "http://example.com"
},
"level": "REQUIRED"
},
"standard": 
{"title": "A set of Common Software Quality Assurance Baseline Criteria for Research Projects",
"version": "v4.0",
"url": "https://indigo-dc.github.io/sqa-baseline/"
},
"data_unstructured": { }
}
],
"hint": "The Open Source Initiative (OSI) sets out the requirements for software to be legally declared as open source. Use one of the <a href=\"https://opensource.org/licenses\" target=\"_blank\">OSI popular licenses</a> for this check to be successful.\n",
"required_for_next_level_badge": true
},
"property2": 
{"description": "All code repositories MUST have a README file",
"valid": true,
"evidence": 
[
{"valid": true,
"message": "README file does not exist",
"plugin": 
{"name": "report2sqaaas-plugin-licensee",
"version": "1.0.0"
},
"tool": 
{"name": "flake8",
"lang": "Python",
"version": "4.0.1",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"ci": 
{"name": "string",
"status": "SUCCESS",
"stdout_command": 
["string"
],
"stdout_text": "string",
"url": "http://example.com"
},
"level": "REQUIRED"
},
"standard": 
{"title": "A set of Common Software Quality Assurance Baseline Criteria for Research Projects",
"version": "v4.0",
"url": "https://indigo-dc.github.io/sqa-baseline/"
},
"data_unstructured": { }
}
],
"hint": "The Open Source Initiative (OSI) sets out the requirements for software to be legally declared as open source. Use one of the <a href=\"https://opensource.org/licenses\" target=\"_blank\">OSI popular licenses</a> for this check to be successful.\n",
"required_for_next_level_badge": true
}
},
"coverage": 
{"percentage": 60,
"total_subcriteria": 5,
"success_subcriteria": 0
}
},
"property2": 
{"valid": false,
"filtered_reason": [ ],
"subcriteria": 
{"property1": 
{"description": "All code repositories MUST have a README file",
"valid": true,
"evidence": 
[
{"valid": true,
"message": "README file does not exist",
"plugin": 
{"name": "report2sqaaas-plugin-licensee",
"version": "1.0.0"
},
"tool": 
{"name": "flake8",
"lang": "Python",
"version": "4.0.1",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"ci": 
{"name": "string",
"status": "SUCCESS",
"stdout_command": 
["string"
],
"stdout_text": "string",
"url": "http://example.com"
},
"level": "REQUIRED"
},
"standard": 
{"title": "A set of Common Software Quality Assurance Baseline Criteria for Research Projects",
"version": "v4.0",
"url": "https://indigo-dc.github.io/sqa-baseline/"
},
"data_unstructured": { }
}
],
"hint": "The Open Source Initiative (OSI) sets out the requirements for software to be legally declared as open source. Use one of the <a href=\"https://opensource.org/licenses\" target=\"_blank\">OSI popular licenses</a> for this check to be successful.\n",
"required_for_next_level_badge": true
},
"property2": 
{"description": "All code repositories MUST have a README file",
"valid": true,
"evidence": 
[
{"valid": true,
"message": "README file does not exist",
"plugin": 
{"name": "report2sqaaas-plugin-licensee",
"version": "1.0.0"
},
"tool": 
{"name": "flake8",
"lang": "Python",
"version": "4.0.1",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"ci": 
{"name": "string",
"status": "SUCCESS",
"stdout_command": 
["string"
],
"stdout_text": "string",
"url": "http://example.com"
},
"level": "REQUIRED"
},
"standard": 
{"title": "A set of Common Software Quality Assurance Baseline Criteria for Research Projects",
"version": "v4.0",
"url": "https://indigo-dc.github.io/sqa-baseline/"
},
"data_unstructured": { }
}
],
"hint": "The Open Source Initiative (OSI) sets out the requirements for software to be legally declared as open source. Use one of the <a href=\"https://opensource.org/licenses\" target=\"_blank\">OSI popular licenses</a> for this check to be successful.\n",
"required_for_next_level_badge": true
}
},
"coverage": 
{"percentage": 60,
"total_subcriteria": 5,
"success_subcriteria": 0
}
}
},
"badge": 
{"software": 
{"criteria": 
{"property1": 
{"to_fulfill": [ ],
"missing": [ ],
"fulfilled": [ ]
},
"property2": 
{"to_fulfill": [ ],
"missing": [ ],
"fulfilled": [ ]
}
},
"data": 
{"openBadgeID": "https://api.eu.badgr.io/public/assertions/KSwijifTQ_-I1lb9FtX1bw",
"createdAt": "2021-04-07T10:34:02.960Z",
"createdBy": "e3h49VVbQRKQphuAAmxpgQ",
"badgeClass": "sBS3EsJQRAC0ENTmvETtQw",
"issuer": "aS1lWKgIR4u8bGjPZUzAyg",
"image": "https://api.eu.badgr.io/public/assertions/KSwijifTQ_-I1lb9FtX1bw/image",
"recipient": 
{"identity": "sha256$5cb2939f3ae83961b31407fbfd2978e5c642177e50227eb0c7f550c0653803dc",
"hashed": true,
"type": "email",
"plaintextIdentity": "https://github.com/EOSC-synergy/test-sqaaas-web.sqaaas/commit/41a4a73505f407d57e7ed600dd5de7cf963feda3"
},
"issuedOn": "2021-04-07T10:07:00.000Z"
},
"share": "<html>..</html>",
"verification_url": "http://example.com"
},
"services": 
{"criteria": 
{"property1": 
{"to_fulfill": [ ],
"missing": [ ],
"fulfilled": [ ]
},
"property2": 
{"to_fulfill": [ ],
"missing": [ ],
"fulfilled": [ ]
}
},
"data": 
{"openBadgeID": "https://api.eu.badgr.io/public/assertions/KSwijifTQ_-I1lb9FtX1bw",
"createdAt": "2021-04-07T10:34:02.960Z",
"createdBy": "e3h49VVbQRKQphuAAmxpgQ",
"badgeClass": "sBS3EsJQRAC0ENTmvETtQw",
"issuer": "aS1lWKgIR4u8bGjPZUzAyg",
"image": "https://api.eu.badgr.io/public/assertions/KSwijifTQ_-I1lb9FtX1bw/image",
"recipient": 
{"identity": "sha256$5cb2939f3ae83961b31407fbfd2978e5c642177e50227eb0c7f550c0653803dc",
"hashed": true,
"type": "email",
"plaintextIdentity": "https://github.com/EOSC-synergy/test-sqaaas-web.sqaaas/commit/41a4a73505f407d57e7ed600dd5de7cf963feda3"
},
"issuedOn": "2021-04-07T10:07:00.000Z"
},
"share": "<html>..</html>",
"verification_url": "http://example.com"
},
"fair": 
{"criteria": 
{"property1": 
{"to_fulfill": [ ],
"missing": [ ],
"fulfilled": [ ]
},
"property2": 
{"to_fulfill": [ ],
"missing": [ ],
"fulfilled": [ ]
}
},
"data": 
{"openBadgeID": "https://api.eu.badgr.io/public/assertions/KSwijifTQ_-I1lb9FtX1bw",
"createdAt": "2021-04-07T10:34:02.960Z",
"createdBy": "e3h49VVbQRKQphuAAmxpgQ",
"badgeClass": "sBS3EsJQRAC0ENTmvETtQw",
"issuer": "aS1lWKgIR4u8bGjPZUzAyg",
"image": "https://api.eu.badgr.io/public/assertions/KSwijifTQ_-I1lb9FtX1bw/image",
"recipient": 
{"identity": "sha256$5cb2939f3ae83961b31407fbfd2978e5c642177e50227eb0c7f550c0653803dc",
"hashed": true,
"type": "email",
"plaintextIdentity": "https://github.com/EOSC-synergy/test-sqaaas-web.sqaaas/commit/41a4a73505f407d57e7ed600dd5de7cf963feda3"
},
"issuedOn": "2021-04-07T10:07:00.000Z"
},
"share": "<html>..</html>",
"verification_url": "http://example.com"
}
}
}

Find pipeline by ID

path Parameters

pipeline_id

required

string

ID of the pipeline to get

Responses

Response samples

200

Content type

application/json


{"id": "dd7d8481-81a3-407f-95f0-a2f1cb382a4b",
"name": "sqaaas-api-spec",
"config_data": 
[
{"config": 
{"project_repos": 
[
{"repo": "https://github.com/eosc-synergy/sqaaas-api-spec",
"branch": "master",
"credentials_id": 
{"secret_id": "my_gitlab_secret",
"user_id": "my_gitlab_user",
"token": "my_gitlab_token"
}
}
],
"credentials": 
[
{"id": "my-dockerhub-token",
"type": "username_password",
"username_var": "GIT_USER",
"password_var": "GIT_PASS"
}
]
},
"sqa_criteria": 
{"property1": 
{"repos": 
[
{"repo_url": "https://github.com/eosc-synergy/sqaaas-api-spec",
"container": "testing",
"commands": 
["mvn checkstyle:check"
],
"tox": 
{"testenv": 
["cover"
],
"tox_file": "tox.ini"
},
"tool": 
{"name": "fair-eva",
"lang": "fair",
"version": "2.0.0",
"jepl_support": true,
"docs": "http://example.com",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"executable": "string",
"args": 
[
{"type": "subcommand",
"id": "string",
"description": "Detect the license of the given project",
"value": "detect",
"option": "string",
"summary": "string",
"format": "string",
"selectable": true,
"repeatable": false,
"args": 
[{ }
]
}
]
}
}
],
"when": 
{"branch": 
{"pattern": "release-\\\\d+",
"comparator": "GLOB"
},
"building_tag": true
}
},
"property2": 
{"repos": 
[
{"repo_url": "https://github.com/eosc-synergy/sqaaas-api-spec",
"container": "testing",
"commands": 
["mvn checkstyle:check"
],
"tox": 
{"testenv": 
["cover"
],
"tox_file": "tox.ini"
},
"tool": 
{"name": "fair-eva",
"lang": "fair",
"version": "2.0.0",
"jepl_support": true,
"docs": "http://example.com",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"executable": "string",
"args": 
[
{"type": "subcommand",
"id": "string",
"description": "Detect the license of the given project",
"value": "detect",
"option": "string",
"summary": "string",
"format": "string",
"selectable": true,
"repeatable": false,
"args": 
[{ }
]
}
]
}
}
],
"when": 
{"branch": 
{"pattern": "release-\\\\d+",
"comparator": "GLOB"
},
"building_tag": true
}
}
},
"environment": 
{"JPL_IGNOREFAILURES": "defined",
"JPL_DOCKERPUSH": "docs service1 service4"
},
"timeout": 1
}
],
"composer_data": 
{"version": "3.7",
"services": 
{"property1": 
{"build": 
{"context": "./dir",
"dockerfile": "Dockerfile-alternate",
"args": 
{"property1": "string",
"property2": "string"
}
},
"image": 
{"name": "eoscsynergy/sqaaas-api-spec:1.0.0",
"registry": 
{"push": true,
"credential_id": "my-dockerhub-cred"
}
},
"hostname": "sqaaas-host",
"volumes": 
[
{"type": "bind",
"source": "./",
"target": "./sqaaas-build"
}
],
"command": "sleep 600000",
"environment": 
{"JPL_IGNOREFAILURES": "defined",
"JPL_DOCKERPUSH": "docs service1 service4"
},
"oneshot": true
},
"property2": 
{"build": 
{"context": "./dir",
"dockerfile": "Dockerfile-alternate",
"args": 
{"property1": "string",
"property2": "string"
}
},
"image": 
{"name": "eoscsynergy/sqaaas-api-spec:1.0.0",
"registry": 
{"push": true,
"credential_id": "my-dockerhub-cred"
}
},
"hostname": "sqaaas-host",
"volumes": 
[
{"type": "bind",
"source": "./",
"target": "./sqaaas-build"
}
],
"command": "sleep 600000",
"environment": 
{"JPL_IGNOREFAILURES": "defined",
"JPL_DOCKERPUSH": "docs service1 service4"
},
"oneshot": true
}
}
},
"jenkinsfile_data": 
{"stages": 
[
{"when": 
{"branches": 
["master"
]
},
"pipeline_config": 
{"config_file": "./.sqa/config.yml",
"base_repository": "master",
"base_branch": "https://github.com/eosc-synergy/sqaaas-api-spec",
"credentials_id": "userpass_dockerhub",
"jepl_validator_docker_image": "eoscsynergy/jpl-validator:1.1.0"
}
}
]
}
}

Update pipeline by ID

path Parameters

pipeline_id

required

string

ID of the pipeline to get

query Parameters

report_to_stdout

boolean

Default: false

Flag to indicate whether the pipeline shall print via via stdout the reports produced by the tools (required by QAA module)

Request Body schema: application/json

name	string <[A-Za-z0-9_.-]> Name that identifies the pipeline
	Array of objects (JePL_config) Details about the pipeline configuration
	object (JePL_composer) Details about the composition of the services required for the pipeline execution
	object (JePL_jenkinsfile) Details about the Jenkins Pipeline as Code

Responses

Request samples

Payload

Content type

application/json


{"name": "sqaaas-api-spec",
"config_data": 
[
{"config": 
{"project_repos": 
[
{"repo": "https://github.com/eosc-synergy/sqaaas-api-spec",
"branch": "master",
"credentials_id": 
{"secret_id": "my_gitlab_secret",
"user_id": "my_gitlab_user",
"token": "my_gitlab_token"
}
}
],
"credentials": 
[
{"id": "my-dockerhub-token",
"type": "username_password",
"username_var": "GIT_USER",
"password_var": "GIT_PASS"
}
]
},
"sqa_criteria": 
{"property1": 
{"repos": 
[
{"repo_url": "https://github.com/eosc-synergy/sqaaas-api-spec",
"container": "testing",
"commands": 
["mvn checkstyle:check"
],
"tox": 
{"testenv": 
["cover"
],
"tox_file": "tox.ini"
},
"tool": 
{"name": "fair-eva",
"lang": "fair",
"version": "2.0.0",
"jepl_support": true,
"docs": "http://example.com",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"executable": "string",
"args": 
[
{"type": "subcommand",
"id": "string",
"description": "Detect the license of the given project",
"value": "detect",
"option": "string",
"summary": "string",
"format": "string",
"selectable": true,
"repeatable": false,
"args": 
[{ }
]
}
]
}
}
],
"when": 
{"branch": 
{"pattern": "release-\\\\d+",
"comparator": "GLOB"
},
"building_tag": true
}
},
"property2": 
{"repos": 
[
{"repo_url": "https://github.com/eosc-synergy/sqaaas-api-spec",
"container": "testing",
"commands": 
["mvn checkstyle:check"
],
"tox": 
{"testenv": 
["cover"
],
"tox_file": "tox.ini"
},
"tool": 
{"name": "fair-eva",
"lang": "fair",
"version": "2.0.0",
"jepl_support": true,
"docs": "http://example.com",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"executable": "string",
"args": 
[
{"type": "subcommand",
"id": "string",
"description": "Detect the license of the given project",
"value": "detect",
"option": "string",
"summary": "string",
"format": "string",
"selectable": true,
"repeatable": false,
"args": 
[{ }
]
}
]
}
}
],
"when": 
{"branch": 
{"pattern": "release-\\\\d+",
"comparator": "GLOB"
},
"building_tag": true
}
}
},
"environment": 
{"JPL_IGNOREFAILURES": "defined",
"JPL_DOCKERPUSH": "docs service1 service4"
},
"timeout": 1
}
],
"composer_data": 
{"version": "3.7",
"services": 
{"property1": 
{"build": 
{"context": "./dir",
"dockerfile": "Dockerfile-alternate",
"args": 
{"property1": "string",
"property2": "string"
}
},
"image": 
{"name": "eoscsynergy/sqaaas-api-spec:1.0.0",
"registry": 
{"push": true,
"credential_id": "my-dockerhub-cred"
}
},
"hostname": "sqaaas-host",
"volumes": 
[
{"type": "bind",
"source": "./",
"target": "./sqaaas-build"
}
],
"command": "sleep 600000",
"environment": 
{"JPL_IGNOREFAILURES": "defined",
"JPL_DOCKERPUSH": "docs service1 service4"
},
"oneshot": true
},
"property2": 
{"build": 
{"context": "./dir",
"dockerfile": "Dockerfile-alternate",
"args": 
{"property1": "string",
"property2": "string"
}
},
"image": 
{"name": "eoscsynergy/sqaaas-api-spec:1.0.0",
"registry": 
{"push": true,
"credential_id": "my-dockerhub-cred"
}
},
"hostname": "sqaaas-host",
"volumes": 
[
{"type": "bind",
"source": "./",
"target": "./sqaaas-build"
}
],
"command": "sleep 600000",
"environment": 
{"JPL_IGNOREFAILURES": "defined",
"JPL_DOCKERPUSH": "docs service1 service4"
},
"oneshot": true
}
}
},
"jenkinsfile_data": 
{"stages": 
[
{"when": 
{"branches": 
["master"
]
},
"pipeline_config": 
{"config_file": "./.sqa/config.yml",
"base_repository": "master",
"base_branch": "https://github.com/eosc-synergy/sqaaas-api-spec",
"credentials_id": "userpass_dockerhub",
"jepl_validator_docker_image": "eoscsynergy/jpl-validator:1.1.0"
}
}
]
}
}

Response samples

502

Content type

application/json


{"upstream_status": 0,
"upstream_reason": "string"
}

Delete pipeline by ID

path Parameters

pipeline_id

required

string

ID of the pipeline to get

Responses

Response samples

502

Content type

application/json


{"upstream_status": 0,
"upstream_reason": "string"
}

Gets pipeline's main configuration.

Returns the content of JePL's config.yml file.

path Parameters

pipeline_id

required

string

ID of the pipeline to get

Responses

Response samples

200

Content type

application/json


[
{"config": 
{"project_repos": 
[
{"repo": "https://github.com/eosc-synergy/sqaaas-api-spec",
"branch": "master",
"credentials_id": 
{"secret_id": "my_gitlab_secret",
"user_id": "my_gitlab_user",
"token": "my_gitlab_token"
}
}
],
"credentials": 
[
{"id": "my-dockerhub-token",
"type": "username_password",
"username_var": "GIT_USER",
"password_var": "GIT_PASS"
}
]
},
"sqa_criteria": 
{"property1": 
{"repos": 
[
{"repo_url": "https://github.com/eosc-synergy/sqaaas-api-spec",
"container": "testing",
"commands": 
["mvn checkstyle:check"
],
"tox": 
{"testenv": 
["cover"
],
"tox_file": "tox.ini"
},
"tool": 
{"name": "fair-eva",
"lang": "fair",
"version": "2.0.0",
"jepl_support": true,
"docs": "http://example.com",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"executable": "string",
"args": 
[
{"type": "subcommand",
"id": "string",
"description": "Detect the license of the given project",
"value": "detect",
"option": "string",
"summary": "string",
"format": "string",
"selectable": true,
"repeatable": false,
"args": 
[{ }
]
}
]
}
}
],
"when": 
{"branch": 
{"pattern": "release-\\\\d+",
"comparator": "GLOB"
},
"building_tag": true
}
},
"property2": 
{"repos": 
[
{"repo_url": "https://github.com/eosc-synergy/sqaaas-api-spec",
"container": "testing",
"commands": 
["mvn checkstyle:check"
],
"tox": 
{"testenv": 
["cover"
],
"tox_file": "tox.ini"
},
"tool": 
{"name": "fair-eva",
"lang": "fair",
"version": "2.0.0",
"jepl_support": true,
"docs": "http://example.com",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"executable": "string",
"args": 
[
{"type": "subcommand",
"id": "string",
"description": "Detect the license of the given project",
"value": "detect",
"option": "string",
"summary": "string",
"format": "string",
"selectable": true,
"repeatable": false,
"args": 
[{ }
]
}
]
}
}
],
"when": 
{"branch": 
{"pattern": "release-\\\\d+",
"comparator": "GLOB"
},
"building_tag": true
}
}
},
"environment": 
{"JPL_IGNOREFAILURES": "defined",
"JPL_DOCKERPUSH": "docs service1 service4"
},
"timeout": 1
}
]

Gets JePL config configuration for the given pipeline.

Returns the content of JePL's config file.

path Parameters

pipeline_id

required

string

ID of the pipeline to get

Responses

Response samples

200

Content type

application/json


[
{"file_name": 
{"file_name": "config.yml"
},
"content": 
{"property1": 
{"repos": 
[
{"repo_url": "https://github.com/eosc-synergy/sqaaas-api-spec",
"container": "testing",
"commands": 
["mvn checkstyle:check"
],
"tox": 
{"testenv": 
["cover"
],
"tox_file": "tox.ini"
},
"tool": 
{"name": "fair-eva",
"lang": "fair",
"version": "2.0.0",
"jepl_support": true,
"docs": "http://example.com",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"executable": "string",
"args": 
[
{"type": "subcommand",
"id": "string",
"description": "Detect the license of the given project",
"value": "detect",
"option": "string",
"summary": "string",
"format": "string",
"selectable": true,
"repeatable": false,
"args": 
[{ }
]
}
]
}
}
],
"when": 
{"branch": 
{"pattern": "release-\\\\d+",
"comparator": "GLOB"
},
"building_tag": true
}
},
"property2": 
{"repos": 
[
{"repo_url": "https://github.com/eosc-synergy/sqaaas-api-spec",
"container": "testing",
"commands": 
["mvn checkstyle:check"
],
"tox": 
{"testenv": 
["cover"
],
"tox_file": "tox.ini"
},
"tool": 
{"name": "fair-eva",
"lang": "fair",
"version": "2.0.0",
"jepl_support": true,
"docs": "http://example.com",
"docker": 
{"image": "string",
"dockerfile": "string",
"reviewed": "2019-08-24",
"oneshot": true
},
"executable": "string",
"args": 
[
{"type": "subcommand",
"id": "string",
"description": "Detect the license of the given project",
"value": "detect",
"option": "string",
"summary": "string",
"format": "string",
"selectable": true,
"repeatable": false,
"args": 
[{ }
]
}
]
}
}
],
"when": 
{"branch": 
{"pattern": "release-\\\\d+",
"comparator": "GLOB"
},
"building_tag": true
}
}
}
}
]

Gets the commands builder scripts

Returns the content of the list of scripts generated for the commands builder.

path Parameters

pipeline_id

required

string

ID of the pipeline to get

Responses

Response samples

200

Content type

application/json


[
{"file_name": "script.sh",
"content": "(\ncd workdir ; npm install\n)"
}
]

Gets composer configuration used by the pipeline.

Returns the content of JePL's docker-compose.yml file.

path Parameters

pipeline_id

required

string

ID of the pipeline to get

Responses

Response samples

200

Content type

application/json


[
{"version": "3.7",
"services": 
{"property1": 
{"build": 
{"context": "./dir",
"dockerfile": "Dockerfile-alternate",
"args": 
{"property1": "string",
"property2": "string"
}
},
"image": 
{"name": "eoscsynergy/sqaaas-api-spec:1.0.0",
"registry": 
{"push": true,
"credential_id": "my-dockerhub-cred"
}
},
"hostname": "sqaaas-host",
"volumes": 
[
{"type": "bind",
"source": "./",
"target": "./sqaaas-build"
}
],
"command": "sleep 600000",
"environment": 
{"JPL_IGNOREFAILURES": "defined",
"JPL_DOCKERPUSH": "docs service1 service4"
},
"oneshot": true
},
"property2": 
{"build": 
{"context": "./dir",
"dockerfile": "Dockerfile-alternate",
"args": 
{"property1": "string",
"property2": "string"
}
},
"image": 
{"name": "eoscsynergy/sqaaas-api-spec:1.0.0",
"registry": 
{"push": true,
"credential_id": "my-dockerhub-cred"
}
},
"hostname": "sqaaas-host",
"volumes": 
[
{"type": "bind",
"source": "./",
"target": "./sqaaas-build"
}
],
"command": "sleep 600000",
"environment": 
{"JPL_IGNOREFAILURES": "defined",
"JPL_DOCKERPUSH": "docs service1 service4"
},
"oneshot": true
}
}
}
]

Gets JePL composer configuration for the given pipeline.

Returns the content of JePL's composer file.

path Parameters

pipeline_id

required

string

ID of the pipeline to get

Responses

Response samples

200

Content type

application/json


{"file_name": 
{"file_name": "docker-compose.yml"
},
"content": 
{"version": "3.7",
"services": 
{"property1": 
{"build": 
{"context": "./dir",
"dockerfile": "Dockerfile-alternate",
"args": 
{"property1": "string",
"property2": "string"
}
},
"image": 
{"name": "eoscsynergy/sqaaas-api-spec:1.0.0",
"registry": 
{"push": true,
"credential_id": "my-dockerhub-cred"
}
},
"hostname": "sqaaas-host",
"volumes": 
[
{"type": "bind",
"source": "./",
"target": "./sqaaas-build"
}
],
"command": "sleep 600000",
"environment": 
{"JPL_IGNOREFAILURES": "defined",
"JPL_DOCKERPUSH": "docs service1 service4"
},
"oneshot": true
},
"property2": 
{"build": 
{"context": "./dir",
"dockerfile": "Dockerfile-alternate",
"args": 
{"property1": "string",
"property2": "string"
}
},
"image": 
{"name": "eoscsynergy/sqaaas-api-spec:1.0.0",
"registry": 
{"push": true,
"credential_id": "my-dockerhub-cred"
}
},
"hostname": "sqaaas-host",
"volumes": 
[
{"type": "bind",
"source": "./",
"target": "./sqaaas-build"
}
],
"command": "sleep 600000",
"environment": 
{"JPL_IGNOREFAILURES": "defined",
"JPL_DOCKERPUSH": "docs service1 service4"
},
"oneshot": true
}
}
}
}

Gets Jenkins pipeline definition used by the pipeline.

Returns the content of JePL's Jenkinsfile file.

path Parameters

pipeline_id

required

string

ID of the pipeline to get

Responses

Response samples

200

Content type

application/json


[
{"stages": 
[
{"when": 
{"branches": 
["master"
]
},
"pipeline_config": 
{"config_file": "./.sqa/config.yml",
"base_repository": "master",
"base_branch": "https://github.com/eosc-synergy/sqaaas-api-spec",
"credentials_id": "userpass_dockerhub",
"jepl_validator_docker_image": "eoscsynergy/jpl-validator:1.1.0"
}
}
]
}
]

Gets Jenkins configuration for the given pipeline.

Returns the content of Jenkinsfile file for the given pipeline.

path Parameters

pipeline_id

required

string

ID of the pipeline to get

Responses

Response samples

200

Content type

application/json


{"file_name": "Jenkinsfile",
"content": "@Library(['github.com/indigo-dc/jenkins-pipeline-library@release/2.1.0']) _\n\ndef projectConfig\n\npipeline {\n    agent any\n\n    stages {\n        stage('SQA baseline criterion: QC.Sty') {\n            when {\n                branch pattern: 'sqaaas', comparator: ''\n            }\n            steps {\n                script {\n                    projectConfig = pipelineConfig(\n                        configFile: '.sqa/config.yml',\n                        scmConfigs: [ localBranch: true ]\n                    )\n                    buildStages(projectConfig)\n                }\n            }\n            post {\n                cleanup {\n                    cleanWs()\n                }\n            }\n        }\n        stage('SQA baseline criterion: QC.Doc') {\n            when {\n                branch pattern: 'build', comparator: ''\n            }\n            steps {\n                script {\n                    projectConfig = pipelineConfig(\n                        configFile: '.sqa/config.snappy-peach-chicken.yml',\n                        scmConfigs: [ localBranch: true ]\n                    )\n                    buildStages(projectConfig)\n                }\n            }\n            post {\n                cleanup {\n                    cleanWs()\n                }\n            }\n        }\n    }\n}"
}

Runs pipeline.

Executes the given pipeline by means of the Jenkins API.

path Parameters

pipeline_id

required

string

ID of the pipeline to get

query Parameters

issue_badge	boolean Default: false Flag to indicate whether a badge shall be issued if the pipeline succeds
repo_url	string <uri> URL of the upstream repository to fetch the code from
repo_branch	string Branch name of the upstream repository to fetch the code from
keepgoing	boolean Default: false Flag to indicate that the pipeline will run until the end

Responses

Response samples

502

Content type

application/json


{"upstream_status": 0,
"upstream_reason": "string"
}

Get pipeline status.

Obtains the build URL in Jenkins for the given pipeline.

path Parameters

pipeline_id

required

string

ID of the pipeline to get

Responses

Response samples

200
502

Content type

application/json


{"build_url": "http://example.com",
"build_status": "success",
"openbadge_id": "http://example.com"
}

Creates pull request with JePL files.

Create a pull request with the generated JePL files.

path Parameters

pipeline_id

required

string

ID of the pipeline to get

Request Body schema: application/json

repo required	string <uri> URL of the upstream repo
branch	string Brach from the upstream repo used as the base for the pull request

Responses

Request samples

Payload

Content type

application/json


{"repo": "http://example.com",
"branch": "string"
}

Response samples

200
502

Content type

application/json


{"pull_request_url": "https://github.com/eosc-synergy/sqaaas-api-spec/pull/23"
}

Get JePL files in compressed format.

Obtains the generated JePL files in compressed format.

path Parameters

pipeline_id

required

string

ID of the pipeline to get

Responses

Gets badge data associated with the given pipeline

Returns the badge data associated with the pipeline.

path Parameters

pipeline_id

required

string

ID of the pipeline to get

Responses

Response samples

200

Content type

application/json


{"criteria": 
{"property1": 
{"to_fulfill": [ ],
"missing": [ ],
"fulfilled": [ ]
},
"property2": 
{"to_fulfill": [ ],
"missing": [ ],
"fulfilled": [ ]
}
},
"data": 
{"openBadgeID": "https://api.eu.badgr.io/public/assertions/KSwijifTQ_-I1lb9FtX1bw",
"createdAt": "2021-04-07T10:34:02.960Z",
"createdBy": "e3h49VVbQRKQphuAAmxpgQ",
"badgeClass": "sBS3EsJQRAC0ENTmvETtQw",
"issuer": "aS1lWKgIR4u8bGjPZUzAyg",
"image": "https://api.eu.badgr.io/public/assertions/KSwijifTQ_-I1lb9FtX1bw/image",
"recipient": 
{"identity": "sha256$5cb2939f3ae83961b31407fbfd2978e5c642177e50227eb0c7f550c0653803dc",
"hashed": true,
"type": "email",
"plaintextIdentity": "https://github.com/EOSC-synergy/test-sqaaas-web.sqaaas/commit/41a4a73505f407d57e7ed600dd5de7cf963feda3"
},
"issuedOn": "2021-04-07T10:07:00.000Z"
},
"share": "<html>..</html>",
"verification_url": "http://example.com"
}

Get output from pipeline execution

Returns the console output from the pipeline execution.

path Parameters

pipeline_id

required

string

ID of the pipeline to get

query Parameters

validate

boolean

Default: false

Flag to indicate whether the returned output shall be validated using sqaaas-reporting tool

Responses

Response samples

200

Content type

application/json


{"QC.Lic": 
[
{"status": "SUCCESS",
"stdout_command": "+ docker-compose -f .sqa/docker-compose.yml --project-directory /jenkins/workspace/ava-maven-app.assess.sqaaas_main/ exec -T qc.lic_boozy-smalt-maltese /usr/bin/env sh .sqa/script.paltry-taupe-reindeer.sh",
"tool": "licensee",
"validator": "licensee",
"validation": 
{"valid": true,
"data_unstructured": { }
}
}
]
}