|
3 | 3 | "info": { |
4 | 4 | "title": "Repository Scanner (RESC)", |
5 | 5 | "description": "RESC API helps you to perform several operations upon findings obtained from multiple source code repositories.", |
6 | | - "version": "3.5.0" |
| 6 | + "version": "3.5.1" |
7 | 7 | }, |
8 | 8 | "paths": { |
9 | 9 | "/resc/v1/health": { |
|
1161 | 1161 | "resc-findings" |
1162 | 1162 | ], |
1163 | 1163 | "summary": "Get findings by rule", |
1164 | | - "description": "Retrieve all findings objects paginated by rule\n\n- **db_connection**: Session of the database connection\n- **rule_name**: Name of the rule to filter the findings by\n- **skip**: Integer amount of records to skip to support pagination\n- **limit**: Integer amount of records to return, to support pagination\n- **return**: [FindingRead]\n The output will contain a PaginationModel containing the list of FindingRead type objects,\n or an empty list if no finding was found for the given rule", |
| 1164 | + "description": "Retrieve all findings objects paginated by rule\n\n- **db_connection**: Session of the database connection\n- **rule_name**: Name of the rule to filter the findings by\n- **skip**: Integer amount of records to skip to support pagination\n- **limit**: Integer amount of records to return, to support pagination\n- **include_deleted_repositories**: boolean flag to include deleted repositories\n- **return**: [FindingRead]\n The output will contain a PaginationModel containing the list of FindingRead type objects,\n or an empty list if no finding was found for the given rule", |
1165 | 1165 | "operationId": "get_findings_by_rule_resc_v1_findings_by_rule__rule_name__get", |
1166 | 1166 | "parameters": [ |
1167 | 1167 | { |
|
1208 | 1208 | "type": "null" |
1209 | 1209 | } |
1210 | 1210 | ], |
1211 | | - "title": "IncludeDeletedRepositories", |
1212 | | - "default": false |
| 1211 | + "default": false, |
| 1212 | + "title": "Include Deleted Repositories" |
1213 | 1213 | } |
1214 | 1214 | } |
1215 | 1215 | ], |
|
1515 | 1515 | "resc-findings" |
1516 | 1516 | ], |
1517 | 1517 | "summary": "Get all detailed findings", |
1518 | | - "description": "Retrieve all findings objects paginated\n- **query_string**\n\n A query string with the following format:\n param1=value1¶m2=value2¶m3=value3\n\n Where the possible parameters are:\n\n - vcs_providers [enum] of type VCSProviders, possible values are: BITBUCKET, AZURE_DEVOPS.\n Will default to all if non-specified.\n\n - finding_statuses [enum of type FindingStatus], possible values are:NOT_ANALYZED,FALSE_POSITIVE,\n TRUE_POSITIVE. Will default to all if non-specified.\n\n - rule_pack_versions of type [String]\n\n - rule_names of type [String]\n\n - rule_tags of type [String] findings in the result will have at least one of the specified tags\n for the rules\n\n - project_name of type String\n\n - repository_names of type [String]\n\n - scan_ids of type list Integer\n\n - start_date_time of type datetime with the following format: 1970-01-31T00:00:00\n\n - end_date_time of type datetime with the following format: 1970-01-31T00:00:00\n\n- **db_connection**\n\n Session of the database connection\n\n- **skip**\n\n Integer amount of records to skip to support pagination\n\n- **limit**\n\n Integer amount of records to return, to support pagination\n\n- **return** [FindingRead]\n\n The output will contain a PaginationModel containing the list of DetailedFinding type objects,\n or an empty list if no finding was found", |
| 1518 | + "description": "Retrieve all findings objects paginated\n- **query_string**\n\n A query string with the following format:\n param1=value1¶m2=value2¶m3=value3\n\n Where the possible parameters are:\n\n - vcs_providers [enum] of type VCSProviders, possible values are: BITBUCKET, AZURE_DEVOPS.\n Will default to all if non-specified.\n\n - finding_statuses [enum of type FindingStatus], possible values are:NOT_ANALYZED,FALSE_POSITIVE,\n TRUE_POSITIVE. Will default to all if non-specified.\n\n - rule_pack_versions of type [String]\n\n - rule_names of type [String]\n\n - rule_tags of type [String] findings in the result will have at least one of the specified tags\n for the rules\n\n - project_name of type String\n\n - repository_names of type [String]\n\n - scan_ids of type list Integer\n\n - start_date_time of type datetime with the following format: 1970-01-31T00:00:00\n\n - end_date_time of type datetime with the following format: 1970-01-31T00:00:00\n\n - include_deleted_repositories of type boolean\n\n- **db_connection**\n\n Session of the database connection\n\n- **skip**\n\n Integer amount of records to skip to support pagination\n\n- **limit**\n\n Integer amount of records to return, to support pagination\n\n- **return** [FindingRead]\n\n The output will contain a PaginationModel containing the list of DetailedFinding type objects,\n or an empty list if no finding was found", |
1519 | 1519 | "operationId": "get_all_detailed_findings_resc_v1_detailed_findings_get", |
1520 | 1520 | "parameters": [ |
1521 | 1521 | { |
|
1679 | 1679 | "items": { |
1680 | 1680 | "$ref": "#/components/schemas/VCSProviders" |
1681 | 1681 | }, |
1682 | | - "title": "VCSProviders" |
| 1682 | + "title": "Vcs Provider" |
1683 | 1683 | } |
1684 | 1684 | }, |
1685 | 1685 | { |
|
1731 | 1731 | "type": "null" |
1732 | 1732 | } |
1733 | 1733 | ], |
1734 | | - "title": "IncludeDeletedRepositories", |
1735 | | - "default": false |
| 1734 | + "default": false, |
| 1735 | + "title": "Include Deleted Repositories" |
1736 | 1736 | } |
1737 | 1737 | } |
1738 | 1738 | ], |
|
2011 | 2011 | "items": { |
2012 | 2012 | "$ref": "#/components/schemas/VCSProviders" |
2013 | 2013 | }, |
2014 | | - "title": "VCSProviders" |
| 2014 | + "title": "Vcs Provider" |
2015 | 2015 | } |
2016 | 2016 | }, |
2017 | 2017 | { |
|
2055 | 2055 | "type": "null" |
2056 | 2056 | } |
2057 | 2057 | ], |
2058 | | - "title": "IncludeDeletedRepositories", |
2059 | | - "default": false |
| 2058 | + "default": false, |
| 2059 | + "title": "Include Deleted Repositories" |
2060 | 2060 | } |
2061 | 2061 | } |
2062 | 2062 | ], |
|
2100 | 2100 | "resc-repositories" |
2101 | 2101 | ], |
2102 | 2102 | "summary": "Get all unique repository names", |
2103 | | - "description": "Retrieve all unique repository names\n\n- **db_connection**: Session of the database connection\n- **vcs_providers**: Optional, filter of supported vcs provider types\n- **project_name**: Optional, filter on project name. It is used as a full string match filter\n- **only_if_has_findings**: Optional, filter all repositories that have findings\n- **return**: List[str]\n The output will contain a list of unique repositories", |
| 2103 | + "description": "Retrieve all unique repository names\n\n- **db_connection**: Session of the database connection\n- **vcs_providers**: Optional, filter of supported vcs provider types\n- **project_name**: Optional, filter on project name. It is used as a full string match filter\n- **only_if_has_findings**: Optional, filter all repositories that have findings\n- **only_if_has_untriaged_findings**: Optional, filter repositories with untriaged findings\n- **return**: List[str]\n The output will contain a list of unique repositories", |
2104 | 2104 | "operationId": "get_distinct_repositories_resc_v1_repositories_distinct_repositories__get", |
2105 | 2105 | "parameters": [ |
2106 | 2106 | { |
|
2112 | 2112 | "items": { |
2113 | 2113 | "$ref": "#/components/schemas/VCSProviders" |
2114 | 2114 | }, |
2115 | | - "title": "VCSProviders" |
| 2115 | + "title": "Vcs Provider" |
2116 | 2116 | } |
2117 | 2117 | }, |
2118 | 2118 | { |
|
2156 | 2156 | "type": "null" |
2157 | 2157 | } |
2158 | 2158 | ], |
2159 | | - "title": "IncludeDeletedRepositories", |
2160 | | - "default": false |
| 2159 | + "default": false, |
| 2160 | + "title": "Include Deleted Repositories" |
| 2161 | + } |
| 2162 | + }, |
| 2163 | + { |
| 2164 | + "name": "only_if_has_untriaged_findings", |
| 2165 | + "in": "query", |
| 2166 | + "required": false, |
| 2167 | + "schema": { |
| 2168 | + "type": "boolean", |
| 2169 | + "default": false, |
| 2170 | + "title": "Only If Has Untriaged Findings" |
2161 | 2171 | } |
2162 | 2172 | } |
2163 | 2173 | ], |
|
2260 | 2270 | "resc-repositories" |
2261 | 2271 | ], |
2262 | 2272 | "summary": "Get all repositories with findings metadata", |
2263 | | - "description": "Retrieve all repository objects paginated\n\n- **db_connection**: Session of the database connection\n- **skip**: Integer amount of records to skip to support pagination\n- **limit**: Integer amount of records to return, to support pagination\n- **vcs_providers**: Optional, filter on supported vcs provider types\n- **projectfilter**: Optional, filter on project name. It is used as a string contains filter\n- **repositoryfilter**: Optional, filter on repository name. It is used as a string contains filter\n- **only_if_has_findings**: Optional, filter all repositories those have findings\n- **return**: [RepositoryEnrichedRead]\n The output will contain a PaginationModel containing the list of RepositoryEnrichedRead type objects,\n or an empty list if no repository", |
| 2273 | + "description": "Retrieve all repository objects paginated\n\n- **db_connection**: Session of the database connection\n- **skip**: Integer amount of records to skip to support pagination\n- **limit**: Integer amount of records to return, to support pagination\n- **vcs_providers**: Optional, filter on supported vcs provider types\n- **projectfilter**: Optional, filter on project name. It is used as a string contains filter\n- **repositoryfilter**: Optional, filter on repository name. It is used as a string contains filter\n- **only_if_has_findings**: Optional, filter all repositories those have findings\n- **only_if_has_untriaged_findings**: Optional, filter repositories with untriaged findings\n- **return**: [RepositoryEnrichedRead]\n The output will contain a PaginationModel containing the list of RepositoryEnrichedRead type objects,\n or an empty list if no repository", |
2264 | 2274 | "operationId": "get_all_repositories_with_findings_metadata_resc_v1_repositories_findings_metadata__get", |
2265 | 2275 | "parameters": [ |
2266 | 2276 | { |
|
2294 | 2304 | "items": { |
2295 | 2305 | "$ref": "#/components/schemas/VCSProviders" |
2296 | 2306 | }, |
2297 | | - "title": "VCSProviders" |
| 2307 | + "title": "Vcs Provider" |
2298 | 2308 | } |
2299 | 2309 | }, |
2300 | 2310 | { |
|
2356 | 2366 | "type": "null" |
2357 | 2367 | } |
2358 | 2368 | ], |
2359 | | - "title": "IncludeDeletedRepositories", |
2360 | | - "default": false |
| 2369 | + "default": false, |
| 2370 | + "title": "Include Deleted Repositories" |
| 2371 | + } |
| 2372 | + }, |
| 2373 | + { |
| 2374 | + "name": "only_if_has_untriaged_findings", |
| 2375 | + "in": "query", |
| 2376 | + "required": false, |
| 2377 | + "schema": { |
| 2378 | + "type": "boolean", |
| 2379 | + "default": false, |
| 2380 | + "title": "Only If Has Untriaged Findings" |
2361 | 2381 | } |
2362 | 2382 | } |
2363 | 2383 | ], |
|
2514 | 2534 | } |
2515 | 2535 | } |
2516 | 2536 | }, |
| 2537 | + "/resc/v1/repositories/{repository_id}/toggle-deleted": { |
| 2538 | + "patch": { |
| 2539 | + "tags": [ |
| 2540 | + "resc-repositories" |
| 2541 | + ], |
| 2542 | + "summary": "Toggle the deleted_at for a repository", |
| 2543 | + "description": "Toggle the deleted_at for a repository\n\n Audit all associated findings as GONE (if not audited).\n\n- **db_connection**: Session of the database connection\n- **repository_id**: ID of the repository to toggle\n- **return**: The output will contain the updated metadata of the repository", |
| 2544 | + "operationId": "toggle_deleted_at_for_repository_resc_v1_repositories__repository_id__toggle_deleted_patch", |
| 2545 | + "parameters": [ |
| 2546 | + { |
| 2547 | + "name": "repository_id", |
| 2548 | + "in": "path", |
| 2549 | + "required": true, |
| 2550 | + "schema": { |
| 2551 | + "type": "integer", |
| 2552 | + "title": "Repository Id" |
| 2553 | + } |
| 2554 | + } |
| 2555 | + ], |
| 2556 | + "responses": { |
| 2557 | + "200": { |
| 2558 | + "description": "Toggle the deleted_at of repository <repository_id>", |
| 2559 | + "content": { |
| 2560 | + "application/json": { |
| 2561 | + "schema": { |
| 2562 | + "$ref": "#/components/schemas/RepositoryRead" |
| 2563 | + } |
| 2564 | + } |
| 2565 | + } |
| 2566 | + }, |
| 2567 | + "404": { |
| 2568 | + "description": "Repository <repository_id> not found", |
| 2569 | + "content": { |
| 2570 | + "application/json": { |
| 2571 | + "schema": { |
| 2572 | + "$ref": "#/components/schemas/Model404" |
| 2573 | + } |
| 2574 | + } |
| 2575 | + } |
| 2576 | + }, |
| 2577 | + "500": { |
| 2578 | + "description": "Internal server error. Contact your system administrator" |
| 2579 | + }, |
| 2580 | + "503": { |
| 2581 | + "description": "Unable to communicate with DataBase, Please contact your system administrator" |
| 2582 | + }, |
| 2583 | + "422": { |
| 2584 | + "description": "Validation Error", |
| 2585 | + "content": { |
| 2586 | + "application/json": { |
| 2587 | + "schema": { |
| 2588 | + "$ref": "#/components/schemas/HTTPValidationError" |
| 2589 | + } |
| 2590 | + } |
| 2591 | + } |
| 2592 | + } |
| 2593 | + } |
| 2594 | + } |
| 2595 | + }, |
2517 | 2596 | "/resc/v1/scans": { |
2518 | 2597 | "get": { |
2519 | 2598 | "tags": [ |
|
0 commit comments