{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/dev-tools:lgtm/get-version":{"get":{"operationId":"dev_tools_lgtm_get_version","summary":"Version information","description":"GET /","tags":["dev-tools"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/get-analysis":{"get":{"operationId":"dev_tools_lgtm_get_analysis","summary":"Get analysis summary","description":"GET /analyses/{analysis-id}","tags":["dev-tools"],"parameters":[{"name":"analysis-id","in":"query","required":true,"description":"The analysis identifier.","schema":{"type":"string","description":"The analysis identifier."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/get-alerts":{"get":{"operationId":"dev_tools_lgtm_get_alerts","summary":"Get detailed alert information","description":"GET /analyses/{analysis-id}/alerts","tags":["dev-tools"],"parameters":[{"name":"analysis-id","in":"query","required":true,"description":"The analysis identifier.","schema":{"type":"string","description":"The analysis identifier."}},{"name":"sarif-version","in":"query","required":false,"description":"The desired version of the SARIF format. Currently supported versions are `1.0.0`, `2.0.0`, and `2.1.0`.","schema":{"type":"string","description":"The desired version of the SARIF format. Currently supported versions are `1.0.0`, `2.0.0`, and `2.1.0`."}},{"name":"excluded-files","in":"query","required":false,"description":"Set `true` to include results in files that are excluded from the output by default. This includes results in test code and generated…","schema":{"type":"boolean","default":false,"description":"Set `true` to include results in files that are excluded from the output by default. This includes results in test code and generated…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/request-analysis":{"post":{"operationId":"dev_tools_lgtm_request_analysis","summary":"Run analysis of a specific commit","description":"POST /analyses/{project-id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["project-id","commit"],"properties":{"project-id":{"type":"integer","description":"The numeric project identifier."},"commit":{"type":"string","description":"The identifier of the commit to analyze."},"language":{"type":"array","description":"The language codes of the languages to analyze. For a list of available languages, see [Supported…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/get-analysis-for-commit":{"get":{"operationId":"dev_tools_lgtm_get_analysis_for_commit","summary":"Get analysis summary for a specific commit","description":"GET /analyses/{project-id}/commits/{commit-id}","tags":["dev-tools"],"parameters":[{"name":"project-id","in":"query","required":true,"description":"The numeric project identifier.","schema":{"type":"integer","description":"The numeric project identifier."}},{"name":"commit-id","in":"query","required":true,"description":"The identifier of a specific commit. Alternatively, use `latest` for the most recent analyzed commit.","schema":{"type":"string","description":"The identifier of a specific commit. Alternatively, use `latest` for the most recent analyzed commit."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/request-review":{"post":{"operationId":"dev_tools_lgtm_request_review","summary":"Run code review for a patch","description":"POST /codereviews/{project-id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["project-id","base","external-id"],"properties":{"project-id":{"type":"integer","description":"The numeric project identifier."},"base":{"type":"string","description":"The identifier for the base commit."},"external-id":{"type":"integer","description":"Your reference number for the code review."},"review-url":{"type":"string","description":"An informative back-link to an external system."},"callback-url":{"type":"string","description":"The callback URL for LGTM to post to on completion of the review. When the code review is complete, the API sends an HTTP POST request to…"},"callback-secret":{"type":"string","description":"The `callback-secret` is used to compute a signature which is included in the `x-lgtm-signature` header of the callback response. The…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/get-code-review":{"get":{"operationId":"dev_tools_lgtm_get_code_review","summary":"Get results of code review","description":"GET /codereviews/{review-id}","tags":["dev-tools"],"parameters":[{"name":"review-id","in":"query","required":true,"description":"The identifier for the review (from the `task-result-url`).","schema":{"type":"string","description":"The identifier for the review (from the `task-result-url`)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/get-issue":{"get":{"operationId":"dev_tools_lgtm_get_issue","summary":"Get detailed alert information for an issue","description":"GET /issues/{project-id}/{alert-key}","tags":["dev-tools"],"parameters":[{"name":"project-id","in":"query","required":true,"description":"The numeric project identifier.","schema":{"type":"integer","description":"The numeric project identifier."}},{"name":"alert-key","in":"query","required":true,"description":"The alert key is generated by LGTM when it posts an issue `create` webhook request to an external system using the [issue tracker Webhook…","schema":{"type":"string","description":"The alert key is generated by LGTM when it posts an issue `create` webhook request to an external system using the [issue tracker Webhook…"},"example":"+ja0cf6+84AGgat15W1jooeMfUY="}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/get-spec":{"get":{"operationId":"dev_tools_lgtm_get_spec","summary":"API specification","description":"GET /openapi","tags":["dev-tools"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/get-operation":{"get":{"operationId":"dev_tools_lgtm_get_operation","summary":"Get operation status","description":"GET /operations/{operation-id}","tags":["dev-tools"],"parameters":[{"name":"operation-id","in":"query","required":true,"description":"The operation identifier returned on creating the task.","schema":{"type":"integer","description":"The operation identifier returned on creating the task."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/get-projects":{"get":{"operationId":"dev_tools_lgtm_get_projects","summary":"List projects","description":"GET /projects","tags":["dev-tools"],"parameters":[{"name":"limit","in":"query","required":false,"description":"The maximum number of projects to return in each response (1-100).","schema":{"type":"integer","default":100,"description":"The maximum number of projects to return in each response (1-100)."}},{"name":"start","in":"query","required":false,"description":"An opaque identifier generated by the API.","schema":{"type":"string","description":"An opaque identifier generated by the API."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/add-project":{"post":{"operationId":"dev_tools_lgtm_add_project","summary":"Add a project to LGTM","description":"POST /projects","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["repository"],"properties":{"repository":{"type":"string","description":"The URL of the repository to analyze. LGTM tests this against the [repository…"},"language":{"type":"array","description":"Optional, a [language code](https://lgtm.com/help/lgtm/analysis-faqs#which-languages-are-supported) to specify which language to analyze.…"},"mode":{"type":"string","enum":["full","sparse","upload"],"description":"The analysis mode of the new project. When set to `full` all commits of the project are analyzed; when set to `sparse` the latest commit…"},"commit":{"type":"string","description":"Required when `mode=upload`, specify the identifier of the commit used to generate the database."},"date":{"type":"string","description":"Optional when `mode=upload`, specify the date and time of the commit used to generate the database; defaults to the current time."},"worker-label":{"type":"array","description":"Optional, any [labels](https://lgtm.com/admin/help/defining-worker-labels) required by workers to analyze this project. To specify more…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/get-project":{"get":{"operationId":"dev_tools_lgtm_get_project","summary":"Get project by numeric identifier","description":"GET /projects/{project-id}","tags":["dev-tools"],"parameters":[{"name":"project-id","in":"query","required":true,"description":"The numeric project identifier","schema":{"type":"integer","description":"The numeric project identifier"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/delete-project":{"post":{"operationId":"dev_tools_lgtm_delete_project","summary":"Delete project by numeric identifier","description":"DELETE /projects/{project-id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["project-id"],"properties":{"project-id":{"type":"integer","description":"The numeric project identifier"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/get-project-config":{"get":{"operationId":"dev_tools_lgtm_get_project_config","summary":"Get configuration for a project identified by numeric identifier","description":"GET /projects/{project-id}/settings/analysis-configuration","tags":["dev-tools"],"parameters":[{"name":"project-id","in":"query","required":true,"description":"The numeric project identifier","schema":{"type":"integer","description":"The numeric project identifier"}},{"name":"source","in":"query","required":false,"description":"The type of project configuration to retrieve. If this parameter isn't specified, the request retrieves the effective configuration. That…","schema":{"type":"string","enum":["repository","administrator"],"description":"The type of project configuration to retrieve. If this parameter isn't specified, the request retrieves the effective configuration. That…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/set-project-config":{"post":{"operationId":"dev_tools_lgtm_set_project_config","summary":"Set the administrator configuration for a project identified by numeric identifier","description":"PUT /projects/{project-id}/settings/analysis-configuration","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["project-id"],"properties":{"project-id":{"type":"integer","description":"The numeric project identifier"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/get-project-by-url-identifier":{"get":{"operationId":"dev_tools_lgtm_get_project_by_url_identifier","summary":"Get project by URL identifier","description":"GET /projects/{provider}/{org}/{name}","tags":["dev-tools"],"parameters":[{"name":"provider","in":"query","required":true,"description":"The first part of the URL identifier of a project, which represents the repository host.","schema":{"type":"string","description":"The first part of the URL identifier of a project, which represents the repository host."}},{"name":"org","in":"query","required":true,"description":"The second part of the URL identifier of a project, the organization.","schema":{"type":"string","description":"The second part of the URL identifier of a project, the organization."}},{"name":"name","in":"query","required":true,"description":"The third part of the URL identifier of a project, the repository name.","schema":{"type":"string","description":"The third part of the URL identifier of a project, the repository name."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/create-query-job":{"post":{"operationId":"dev_tools_lgtm_create_query_job","summary":"Run a CodeQL query on one or more projects","description":"POST /queryjobs","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["language"],"properties":{"language":{"type":"string","description":"The [language](https://lgtm.com/help/lgtm/analysis-faqs#which-languages-are-supported) you want to analyze."},"project-id":{"type":"array","description":"The identifier of the project to analyze. Either `project-id` or `projects-list` must be specified."},"projects-list":{"type":"string","description":"Name of the list containing the projects to analyze. Either `project-id` or `projects-list` must be specified."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/get-query-job":{"get":{"operationId":"dev_tools_lgtm_get_query_job","summary":"Get the status of a query job","description":"GET /queryjobs/{queryjob-id}","tags":["dev-tools"],"parameters":[{"name":"queryjob-id","in":"query","required":true,"description":"The identifier of the query job, from the `task-result` given in the response to the initial `POST /queryjobs` request.","schema":{"type":"string","description":"The identifier of the query job, from the `task-result` given in the response to the initial `POST /queryjobs` request."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/get-query-job-results-overview":{"get":{"operationId":"dev_tools_lgtm_get_query_job_results_overview","summary":"Provide a summary of results for the projects in the query job","description":"GET /queryjobs/{queryjob-id}/results","tags":["dev-tools"],"parameters":[{"name":"queryjob-id","in":"query","required":true,"description":"The identifier of the query job, from the `task-result` given in the response to the initial `POST /queryjobs` request.","schema":{"type":"string","description":"The identifier of the query job, from the `task-result` given in the response to the initial `POST /queryjobs` request."}},{"name":"start","in":"query","required":false,"description":"An opaque identifier generated by the API used for pagination. This identifier will be included as part of the response for this endpoint…","schema":{"type":"string","description":"An opaque identifier generated by the API used for pagination. This identifier will be included as part of the response for this endpoint…"}},{"name":"limit","in":"query","required":false,"description":"The number of results to return. Useful for pagination.","schema":{"type":"integer","default":100,"description":"The number of results to return. Useful for pagination."}},{"name":"filter","in":"query","required":false,"description":"Only return a subset of results. Legal values are `w-results`, `wo-results`, `error`.","schema":{"type":"string","description":"Only return a subset of results. Legal values are `w-results`, `wo-results`, `error`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/get-query-job-results-for-project":{"get":{"operationId":"dev_tools_lgtm_get_query_job_results_for_project","summary":"Fetch the results of a query job for a specific project","description":"GET /queryjobs/{queryjob-id}/results/{project-id}","tags":["dev-tools"],"parameters":[{"name":"queryjob-id","in":"query","required":true,"description":"The identifier of the query job, from the `task-result` given in the response to the initial `POST /queryjobs` request.","schema":{"type":"string","description":"The identifier of the query job, from the `task-result` given in the response to the initial `POST /queryjobs` request."}},{"name":"project-id","in":"query","required":true,"description":"The identifier for the project.","schema":{"type":"string","description":"The identifier for the project."}},{"name":"start","in":"query","required":false,"description":"Start point for the page of results.","schema":{"type":"integer","description":"Start point for the page of results."}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results to display (less than 100).","schema":{"type":"integer","default":100,"description":"The maximum number of results to display (less than 100)."}},{"name":"nofilter","in":"query","required":false,"description":"Include results that are not part of the source tree. These results are filtered out by default.","schema":{"type":"boolean","default":false,"description":"Include results that are not part of the source tree. These results are filtered out by default."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/complete-upload":{"post":{"operationId":"dev_tools_lgtm_complete_upload","summary":"Complete snapshot upload session","description":"POST /snapshots/uploads/{session-id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["session-id"],"properties":{"session-id":{"type":"string","description":"The id of the upload session."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/upload-part":{"post":{"operationId":"dev_tools_lgtm_upload_part","summary":"Upload snapshot","description":"PUT /snapshots/uploads/{session-id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["session-id"],"properties":{"session-id":{"type":"string","description":"The id of the upload session."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/abort-upload":{"post":{"operationId":"dev_tools_lgtm_abort_upload","summary":"Abort database upload process","description":"DELETE /snapshots/uploads/{session-id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["session-id"],"properties":{"session-id":{"type":"string","description":"The id of the upload session."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/get-snapshot":{"get":{"operationId":"dev_tools_lgtm_get_snapshot","summary":"Download a snapshot","description":"GET /snapshots/{project-id}/{language}","tags":["dev-tools"],"parameters":[{"name":"project-id","in":"query","required":true,"description":"The numeric project identifier.","schema":{"type":"integer","description":"The numeric project identifier."}},{"name":"language","in":"query","required":true,"description":"The language of the database to download.","schema":{"type":"string","description":"The language of the database to download."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/init-snapshot-upload":{"post":{"operationId":"dev_tools_lgtm_init_snapshot_upload","summary":"Start snapshot upload session","description":"POST /snapshots/{project-id}/{language}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["project-id","language","commit"],"properties":{"project-id":{"type":"integer","description":"The numeric project identifier."},"language":{"type":"string","description":"The language of the database to upload."},"commit":{"type":"string","description":"The identifier of the analyzed commit."},"date":{"type":"string","description":"The date and time of the analyzed commit (default the current time)."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/get-health":{"get":{"operationId":"dev_tools_lgtm_get_health","summary":"Get a summary of the application's health","description":"GET /system/health","tags":["dev-tools"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/get-metrics":{"get":{"operationId":"dev_tools_lgtm_get_metrics","summary":"Get the identifiers and descriptions of the usage metrics","description":"GET /system/metrics","tags":["dev-tools"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:lgtm/get-metric":{"get":{"operationId":"dev_tools_lgtm_get_metric","summary":"Get the computed values of the specified metric","description":"GET /system/metrics/{metric-id}","tags":["dev-tools"],"parameters":[{"name":"metric-id","in":"query","required":true,"description":"The identifier of the metric.","schema":{"type":"string","description":"The identifier of the metric."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}