API

/web_api/bug/summary

/web_api/bug/summary ​

This page is built from the JSON Schema snapshot in the documentation repository. The snapshot is updated by a separate command from the main app catalog and is not rewritten when the site is built.

Request ​

main-app://schemas/api_elements/bug/summary.request.json

GET|POST /web_api/bug/summary body

NameTypeRequiredConstraint
project_idintegerYes-

Other top-level fields are allowed.

Response ​

main-app://schemas/api_elements/bug/summary.response.json

GET|POST /web_api/bug/summary success

NameTypeRequiredConstraint
api_codeintegerYesconst 200
api_resultobjectYesno other fields
emptybooleanNo-

Other top-level fields are not allowed.

api_result ​

NameTypeRequiredConstraint
bug_countintegerYes-
open_countintegerYes-
in_progress_countintegerYes-
closed_countintegerYes-
opened_countintegerYes-
covered_countintegerYes-

Source schema ​

The files below are copied from the snapshot unchanged. A $ref fragment is a separate block. The schemas are not merged.

Request: main-app://schemas/api_elements/bug/summary.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/bug/summary.request.json",
  "title": "GET|POST /web_api/bug/summary body",
  "type": "object",
  "required": [
    "project_id"
  ],
  "additionalProperties": true,
  "properties": {
    "project_id": {
      "type": "integer"
    }
  }
}
Response: main-app://schemas/api_elements/bug/summary.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/bug/summary.response.json",
  "title": "GET|POST /web_api/bug/summary success",
  "allOf": [
    {
      "$ref": "main-app://schemas/_shared/envelope-success.json"
    },
    {
      "type": "object",
      "properties": {
        "api_result": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "bug_count",
            "open_count",
            "in_progress_count",
            "closed_count",
            "opened_count",
            "covered_count"
          ],
          "properties": {
            "bug_count": {
              "type": "integer"
            },
            "open_count": {
              "type": "integer"
            },
            "in_progress_count": {
              "type": "integer"
            },
            "closed_count": {
              "type": "integer"
            },
            "opened_count": {
              "type": "integer"
            },
            "covered_count": {
              "type": "integer"
            }
          }
        }
      }
    }
  ]
}
Fragment: main-app://schemas/_shared/envelope-success.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/_shared/envelope-success.json",
  "title": "Canonical success envelope",
  "type": "object",
  "required": ["api_code", "api_result"],
  "properties": {
    "api_code": { "const": 200 },
    "api_result": true,
    "empty": { "type": "boolean" }
  },
  "additionalProperties": false
}

Version 1.0.0 · Last updated 2026-10-07

Did this page help?