From cf7a32bf29a7412a0f4b373ac3045f2555762d03 Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Wed, 17 May 2023 21:07:21 +0000 Subject: Add latest changes from gitlab-org/gitlab@master --- doc/ci/runners/saas/linux_saas_runner.md | 2 +- doc/development/rails_endpoints/index.md | 79 ++++++++++++++++++++++++++++++++ 2 files changed, 80 insertions(+), 1 deletion(-) create mode 100644 doc/development/rails_endpoints/index.md (limited to 'doc') diff --git a/doc/ci/runners/saas/linux_saas_runner.md b/doc/ci/runners/saas/linux_saas_runner.md index ebc1f617691..a1864c59d47 100644 --- a/doc/ci/runners/saas/linux_saas_runner.md +++ b/doc/ci/runners/saas/linux_saas_runner.md @@ -17,7 +17,7 @@ For Free, Premium, and Ultimate plan customers, jobs on these instances consume | | Small | Medium | Large | |-------------------|---------------------------|---------------------------|--------------------------| -| Specs | 1 vCPU, 3.75 GB RAM | 2 vCPUs, 8 GB RAM | 4 vCPUs, 16 GB RAM | +| Specs | 2 vCPU, 8 GB RAM | 4 vCPUs, 16 GB RAM | 8 vCPUs, 32 GB RAM | | GitLab CI/CD tags | `saas-linux-small-amd64` | `saas-linux-medium-amd64` | `saas-linux-large-amd64` | | Subscription | Free, Premium, Ultimate | Free, Premium, Ultimate | Premium, Ultimate | diff --git a/doc/development/rails_endpoints/index.md b/doc/development/rails_endpoints/index.md new file mode 100644 index 00000000000..c5a166dd4be --- /dev/null +++ b/doc/development/rails_endpoints/index.md @@ -0,0 +1,79 @@ +--- +stage: Create +group: Source Code +info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments" +type: reference, api +--- + +# Rails Endpoints + +Rails Endpoints are used by different GitLab components, they cannot be +used by other consumers. This documentation is intended for people +working on the GitLab codebase. + +These Rails Endpoints: + +- May not have extensive documentation or follow the same conventions as our public or private APIs. +- May not adhere to standardized rules or guidelines. +- Are designed to serve specific internal purposes in the codebase. +- Are subject to change at any time. + +## Proof of concept period: Feedback Request + +We are currently evaluating a new approach for documenting Rails endpoints. Please [check out the Feedback Issue](https://gitlab.com/gitlab-org/gitlab/-/issues/411605) and feel free to share your thoughts, suggestions, or concerns. We appreciate your participation in helping us improve the documentation! + +## SAST Scanners + +Static Application Security Testing (SAST) checks your source code for known vulnerabilities. When SAST is enabled +on a Project these endpoints are available. + +### List existing merge request code quality findings sorted by files + +Get a list of existing code quality Findings, if any, sorted by files. + +```plaintext +GET /projects/:id/merge_requests/:merge_request_iid/codequality_mr_diff_reports.json +``` + +Response: + +```json +{ + "files": { + "index.js": [ + { + "line": 1, + "description": "Unexpected 'debugger' statement.", + "severity": "major" + } + ] + } +} +``` + +### List new, resolved and existing merge request code quality findings + +Get a list of new, resolved, and existing code quality Findings, if any. + +```plaintext +GET /projects/:id/merge_requests/:merge_request_iid/codequality_reports.json +``` + +```json +{ + "status": "failed", + "new_errors": [ + { + "description": "Unexpected 'debugger' statement.", + "severity": "major", + "file_path": "index.js", + "line": 1, + "web_url": "https://gitlab.com/jannik_lehmann/code-quality-test/-/blob/ed1c1b3052fe6963beda0e416d5e2ba3378eb715/noise.rb#L12", + "engine_name": "eslint" + } + ], + "resolved_errors": [], + "existing_errors": [], + "summary": { "total": 1, "resolved": 0, "errored": 1 } +} +``` -- cgit v1.2.1