Yorumlar API

Herhangi bir kayıtta ekibiniz için notlar ve yanıtlar.

Modül kodu comments · 9 işlem · 3 veri modeli · 9 olay. Bir anahtar ya da token, arkasındaki kişinin bu modülde yapabildiğinden fazlasını asla yapamaz; satır düzeyindeki güvenlik uygulamadakiyle birebir aynıdır. Yetki kapsamları: comments (hepsi), comments:read (yalnız okuma) ya da comments:<yetenek>.

Kaynaklar

Listeler limit (en çok 200), cursor, order (ör. -created_at), fields ve q alır; diğer her sorgu parametresi bir sütun süzgecidir: ?status=paid, ?total[gte]=100, ?id[in]=a,b, ?x=null.

İşlemler

comments.delete

Yorumu sil — Yorumu konudan kaldırır. Yanıtlar kalır ve ana yorum olur.

Gereken izin comments:read · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• REST kısayolu: DELETE /api/v1/comments/{id}
• Asıl adres: POST /api/v1/actions/comments.delete

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: comments.deleted

Neye yazar: comment (update) — Stamps deleted_at

curl -X POST https://app.getera.io/api/v1/comments/COMMENT_ID/actions/delete \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "comments.deleted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.comments.delete("COMMENT_ID")

era comments delete COMMENT_ID

{
  "name": "era__comments__delete",
  "arguments": {
    "id": "COMMENT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde comments:read izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 comment_not_found, cannot_delete_comment · 429 çok sık istek

comments.edit

Yorumu düzenle — Yazdığınız bir yorumu yeniden yazar ve değiştiğini ekranda belirtir.

Gereken izin comments:read · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/comments.edit

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: comments.edited, comments.mentioned

Neye yazar: comment (update) — Rewrites the body and stamps edited_at; comment_mention (insert) — Records anyone newly mentioned

curl -X POST https://app.getera.io/api/v1/comments/COMMENT_ID/actions/edit \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"body":"Comment"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "comments.edited",
    "comments.mentioned"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.comments.edit("COMMENT_ID", {
  body: "Comment"
})

era comments edit COMMENT_ID \
  --body "Comment"

{
  "name": "era__comments__edit",
  "arguments": {
    "id": "COMMENT_ID",
    "body": "Comment"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde comments:read izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 comment_not_found, not_author, empty_body, mentioned_cannot_read · 429 çok sık istek

comments.post

Kayda yorum yaz — Bir kayda yorum ekler. Biri yayımlayana kadar iç yorumdur.

Gereken izin comments:read · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/comments.post

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: comments.posted, comments.mentioned

Neye yazar: comment (insert) — Writes the comment; comment_mention (insert) — Records who was mentioned

curl -X POST https://app.getera.io/api/v1/comments/actions/post \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"recordType":"Record type","recordId":"RECORD_ID","body":"Comment"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "comments.posted",
    "comments.mentioned"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.comments.post({
  recordType: "Record type",
  recordId: "RECORD_ID",
  body: "Comment"
})

era comments post \
  --record-type "Record type" \
  --record-id "RECORD_ID" \
  --body "Comment"

{
  "name": "era__comments__post",
  "arguments": {
    "recordType": "Record type",
    "recordId": "RECORD_ID",
    "body": "Comment"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde comments:read izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 unknown_record_type, cannot_comment, empty_body, record_not_found, mentioned_cannot_read · 429 çok sık istek

comments.publish

Yorumu yayımla — Yorumu mağaza sitesinde gösterir. Varsayılan olarak yapılmaz.

Gereken izin comments:read · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır) · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/comments.publish

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: comments.published

Neye yazar: comment (update) — Sets is_public

curl -X POST https://app.getera.io/api/v1/comments/COMMENT_ID/actions/publish \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "comments.published"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.comments.publish("COMMENT_ID")

era comments publish COMMENT_ID

{
  "name": "era__comments__publish",
  "arguments": {
    "id": "COMMENT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde comments:read izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 comment_not_found, cannot_manage_record, is_a_reply, already_public · 429 çok sık istek

comments.react

Yoruma tepki ver — Bir yoruma tepkinizi ekler; daha önce verdiyseniz geri alır.

Gereken izin comments:read · siler ya da geri alınamaz

• Asıl adres: POST /api/v1/actions/comments.react

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: comments.reacted

Neye yazar: comment_reaction (insert) — Adds the reaction; comment_reaction (delete) — Takes a reaction back

curl -X POST https://app.getera.io/api/v1/comment_reactions/actions/react \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"id":"COMMENT_ID","reaction":"Reaction"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "comments.reacted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.commentReactions.react({
  id: "COMMENT_ID",
  reaction: "Reaction"
})

era comment_reactions react \
  --id "COMMENT_ID" \
  --reaction "Reaction"

{
  "name": "era__comments__react",
  "arguments": {
    "id": "COMMENT_ID",
    "reaction": "Reaction"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde comments:read izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 invalid_reaction, comment_not_found, cannot_comment · 429 çok sık istek

comments.reopen

Konuyu yeniden aç — Çözülmüş bir konuyu listeye geri koyar.

Gereken izin comments:read · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/comments.reopen

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: comments.reopened

Neye yazar: comment (update) — Clears resolved_at

curl -X POST https://app.getera.io/api/v1/comments/COMMENT_ID/actions/reopen \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "comments.reopened"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.comments.reopen("COMMENT_ID")

era comments reopen COMMENT_ID

{
  "name": "era__comments__reopen",
  "arguments": {
    "id": "COMMENT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde comments:read izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 comment_not_found, cannot_comment, not_resolved · 429 çok sık istek

comments.reply

Yoruma yanıt ver — Bir yorumu yanıtlar. Yanıtlar yalnızca bir seviye derine iner.

Gereken izin comments:read · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/comments.reply

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: comments.posted, comments.mentioned

Neye yazar: comment (insert) — Writes the reply; comment_mention (insert) — Records who was mentioned

curl -X POST https://app.getera.io/api/v1/comments/COMMENT_ID/actions/reply \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"body":"Reply"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "comments.posted",
    "comments.mentioned"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.comments.reply("COMMENT_ID", {
  body: "Reply"
})

era comments reply COMMENT_ID \
  --body "Reply"

{
  "name": "era__comments__reply",
  "arguments": {
    "parentId": "COMMENT_ID",
    "body": "Reply"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde comments:read izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 parent_not_found, parent_is_a_reply, cannot_comment, empty_body, mentioned_cannot_read · 429 çok sık istek

comments.resolve

Konuyu çözüldü olarak işaretle — Konuyu kapanmış olarak işaretler; panel geriye kalanların listesi olur.

Gereken izin comments:read · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/comments.resolve

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: comments.resolved

Neye yazar: comment (update) — Stamps resolved_at

curl -X POST https://app.getera.io/api/v1/comments/COMMENT_ID/actions/resolve \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "comments.resolved"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.comments.resolve("COMMENT_ID")

era comments resolve COMMENT_ID

{
  "name": "era__comments__resolve",
  "arguments": {
    "id": "COMMENT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde comments:read izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 comment_not_found, cannot_comment, is_a_reply, already_resolved · 429 çok sık istek

comments.unpublish

Yorumu yayından kaldır — Yayımlanmış bir yorumu mağaza sitesinden geri alır.

Gereken izin comments:read · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/comments.unpublish

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: comments.unpublished

Neye yazar: comment (update) — Clears is_public

curl -X POST https://app.getera.io/api/v1/comments/COMMENT_ID/actions/unpublish \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "comments.unpublished"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.comments.unpublish("COMMENT_ID")

era comments unpublish COMMENT_ID

{
  "name": "era__comments__unpublish",
  "arguments": {
    "id": "COMMENT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde comments:read izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 comment_not_found, cannot_manage_record, already_private · 429 çok sık istek

Veri modelleri

CommentMention

Tablo comment_mention · Kaynak comment_mentions

• GET /api/v1/comment_mentions
• GET /api/v1/comment_mentions/{id}

Birincil anahtar: id

CommentReaction

Tablo comment_reaction · Kaynak comment_reactions

• GET /api/v1/comment_reactions
• GET /api/v1/comment_reactions/{id}

Birincil anahtar: id

Tekil: comment_id, user_id, reaction

Denetimler:

• CHECK (((length(reaction) >= 1) AND (length(reaction) <= 32)))

Comment

Tablo comment · Kaynak comments

• GET /api/v1/comments
• GET /api/v1/comments/{id}
• DELETE /api/v1/comments/{id} → comments.delete

Birincil anahtar: id

Denetimler:

• CHECK ((length(btrim(body)) > 0))
• CHECK (((parent_id IS NULL) OR (parent_id <> id)))
• CHECK (((resolved_at IS NULL) OR (parent_id IS NULL)))
• CHECK (((resolved_at IS NULL) = (resolved_by_user_id IS NULL)))

Olaylar

İş akışları ve webhook'lar bu olaylara tepki verir.