Программный интерфейс

/web_api/team_member/create

/web_api/team_member/create ​

Страница собрана из снимка JSON Schema в репозитории документации. Снимок обновляется отдельной командой из каталога основного приложения и при сборке сайта не переписывается.

Запрос ​

main-app://schemas/api_elements/team_member/create.request.json

REQUEST /web_api/team_member/create

ИмяТипОбязательноеОграничение
team_idintegerДаminimum 0
user_idintegerДаminimum 0
team_member_statusenumНет"PENDING", "ACCEPTED", "BANNED", "REJECTED"
member_roleenumНет"ADMINISTRATOR", "MEMBER", "READONLY"
created_atstringНет-
updated_atstringНет-

Другие поля верхнего уровня запрещены.

Ответ ​

main-app://schemas/api_elements/team_member/create.response.json

RESPONSE /web_api/team_member/create

ИмяТипОбязательноеОграничение
api_codeintegerДаconst 200
api_resultobjectДадругие поля допустимы
emptybooleanНет-

Другие поля верхнего уровня запрещены.

api_result ​

ИмяТипОбязательноеОграничение
team_member_idintegerНетminimum 0
team_idintegerНетminimum 0
user_idintegerНетminimum 0
team_member_statusenumНет"PENDING", "ACCEPTED", "BANNED", "REJECTED"
member_roleenumНет"ADMINISTRATOR", "MEMBER", "READONLY"
created_atstringНет-
updated_atstringНет-

Исходная схема ​

Файлы ниже скопированы из снимка без изменений. Фрагмент по $ref приведён отдельным блоком, схемы не сливаются.

Запрос: main-app://schemas/api_elements/team_member/create.request.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/team_member/create.request.json",
  "title": "REQUEST /web_api/team_member/create",
  "$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "team_id": {
      "type": "integer",
      "minimum": 0
    },
    "user_id": {
      "type": "integer",
      "minimum": 0
    },
    "team_member_status": {
      "type": "string",
      "enum": [
        "PENDING",
        "ACCEPTED",
        "BANNED",
        "REJECTED"
      ]
    },
    "member_role": {
      "type": "string",
      "enum": [
        "ADMINISTRATOR",
        "MEMBER",
        "READONLY"
      ]
    },
    "created_at": {
      "type": "string",
      "description": "timestamp Y-m-d H:i:s"
    },
    "updated_at": {
      "type": "string",
      "description": "timestamp Y-m-d H:i:s"
    }
  },
  "required": [
    "team_id",
    "user_id"
  ]
}
Ответ: main-app://schemas/api_elements/team_member/create.response.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/team_member/create.response.json",
  "title": "RESPONSE /web_api/team_member/create",
  "$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
  "allOf": [
    {
      "$ref": "main-app://schemas/_shared/envelope-success.json"
    },
    {
      "type": "object",
      "properties": {
        "api_result": {
          "$ref": "main-app://schemas/api_elements/team_member/row.json"
        }
      }
    }
  ]
}
Фрагмент: 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
}
Фрагмент: main-app://schemas/api_elements/team_member/row.json
json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "main-app://schemas/api_elements/team_member/row.json",
  "title": "Row team_member",
  "$comment": "Generated from the DB model structure_scheme. Edit the model, then run node fill-from-structure-scheme.mjs.",
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "team_member_id": {
      "type": "integer",
      "minimum": 0
    },
    "team_id": {
      "type": "integer",
      "minimum": 0
    },
    "user_id": {
      "type": "integer",
      "minimum": 0
    },
    "team_member_status": {
      "type": "string",
      "enum": [
        "PENDING",
        "ACCEPTED",
        "BANNED",
        "REJECTED"
      ]
    },
    "member_role": {
      "type": "string",
      "enum": [
        "ADMINISTRATOR",
        "MEMBER",
        "READONLY"
      ]
    },
    "created_at": {
      "type": "string",
      "description": "timestamp Y-m-d H:i:s"
    },
    "updated_at": {
      "type": "string",
      "description": "timestamp Y-m-d H:i:s"
    }
  }
}

Версия 1.0.0 · Последнее изменение 2026-10-07

Страница не помогла?