Документация · v1

Creodock API

Все операции
PATCHИнтерфейс Creodock

Изменить: аккаунт

Изменяет аккаунт и возвращает результат операции.

OpenAPI: Update personal profile with optimistic versioning

PATCHhttps://api.creodock.com/api/v1/me/profile
Кто вызывает
Интерфейс Creodock
Операция выполняется от имени вошедшего пользователя через защищённую cookie-сессию.
Доступ
Определяется ролью и принадлежностью объекта
Отдельный scope не объявлен в OpenAPI. Сервер проверяет роль и рабочую область.

Что произойдёт

Поведение, которое важно учесть до отправки запроса.

  • Изменяет существующий ресурс. Передавайте только актуальные данные объекта.
  • Идемпотентность явно не объявлена в контракте: не повторяйте запрос автоматически.

Тело запроса

Обязательно для этой операции.

application/json

Схема: PersonalProfileUpdate

ПолеТипОписание
localeОбязательно
string
Поле «locale» в структуре запроса или ответа.
nameОбязательно
string
Отображаемое название.Минимальная длина: 2 · Максимальная длина: 80
timezoneОбязательно
string
Поле «timezone» в структуре запроса или ответа.
versionОбязательно
integer · int64
Версия объекта для защиты от конфликтующих изменений.Минимум: 1

Ответы

Все состояния ответа, объявленные этой операцией в OpenAPI.

200

Updated personal profile

application/json

Схема: PersonalProfile

ПолеТипОписание
activityОбязательно
object
Authenticated session entries grouped by the account's local calendar day.
avatarUrlНеобязательно
object
Поле «avatarUrl» в структуре запроса или ответа.
emailОбязательно
string · email
Email в нормализованном виде.
idОбязательно
string · uuid
Уникальный идентификатор объекта.
localeОбязательно
string
Поле «locale» в структуре запроса или ответа.
nameОбязательно
string
Отображаемое название.Минимальная длина: 2 · Максимальная длина: 80
timezoneОбязательно
string
Поле «timezone» в структуре запроса или ответа.
versionОбязательно
integer · int64
Версия объекта для защиты от конфликтующих изменений.
{
  "activity": {},
  "email": "developer@example.com",
  "id": "00000000-0000-0000-0000-000000000000",
  "locale": "string",
  "name": "string",
  "timezone": "string",
  "version": 1
}
409

Problem Details response

application/json

Схема: Problem

422

Problem Details response

application/json

Схема: Problem

Ошибки и восстановление

Не только причина, но и конкретное действие для вызывающей стороны.

СтатусЧто означаетПовторЧто делать
409Конфликт состояния или версииПосле чтенияПолучите актуальный объект и повторите изменение.
422Данные не прошли бизнес-проверкуПосле исправленияИсправьте поля, перечисленные в fieldErrors.

Формат Problem Details

{
  "type": "https://api.creodock.com/problems/invalid-request",
  "title": "Данные не прошли проверку",
  "status": 422,
  "code": "invalid_request",
  "detail": "Проверьте отмеченные поля.",
  "traceId": "req_01J8M4Y6QX",
  "fieldErrors": [
    { "field": "items[0].formats", "code": "required", "message": "Выберите формат." }
  ]
}