> ## Documentation Index
> Fetch the complete documentation index at: https://docs.weve.cx/llms.txt
> Use this file to discover all available pages before exploring further.

# Respostas de um comentário

> A conversa completa de uma raiz, paginada.



## OpenAPI

````yaml GET /v1/clubs/{clubId}/classroom/comments/{commentId}/replies
openapi: 3.0.3
info:
  title: weve API
  description: >
    Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de
    verdade**:

    os tipos e a interface de servidor em Go, e o client TypeScript, são todos

    gerados daqui (`make openapi`). Handler que divergir da interface não
    compila.


    A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de

    máquina, protegido por segredo dedicado, e não é contrato de cliente.
  version: 0.2.0
servers:
  - url: https://api.weve.cx
    description: produção
  - url: http://localhost:8080
    description: desenvolvimento
security: []
tags:
  - name: health
  - name: session
  - name: account
  - name: clubs
  - name: members
  - name: webhooks
  - name: outgoing-webhooks
  - name: sales-platforms
  - name: catalog
  - name: content
  - name: classroom
  - name: community
  - name: mentorships
  - name: agents
  - name: lives
  - name: students
  - name: auth
  - name: campaigns
  - name: workflows
  - name: email
paths:
  /v1/clubs/{clubId}/classroom/comments/{commentId}/replies:
    parameters:
      - $ref: '#/components/parameters/OrgId'
      - $ref: '#/components/parameters/CommentId'
    get:
      tags:
        - comments
      summary: As respostas de um comentário
      description: |
        Da mais antiga para a mais nova — a ordem em que a conversa
        aconteceu. É o "ver as outras respostas" da tela.
      operationId: listCommentReplies
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            default: 1
      responses:
        '200':
          description: As respostas
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommentList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - studentSession: []
components:
  parameters:
    OrgId:
      name: clubId
      in: path
      required: true
      description: >
        Id público da organização — o mesmo que `GET /v1/me` devolve em

        `organization_id`.


        Na URL o recurso se chama **club**; no contrato e no domínio,
        organization.

        A divergência é deliberada: `clubs` é a palavra do produto, e a URL é o
        que

        as pessoas leem.


        É o identificador do provedor de autenticação, e é assim de propósito:

        o cliente precisa nomear a organização ao pedir o token, e o token é o

        que prova o escopo. Um id só nosso obrigaria a traduzir um no outro

        antes de ter um token — e a tradução exigiria uma chamada escopada, que

        é justamente a que ainda não dá para fazer.


        O uuid interno da organização não aparece no contrato: ele é o que as

        chaves estrangeiras do domínio referenciam, e continua sendo nosso.
      schema:
        type: string
        format: uuid
    CommentId:
      name: commentId
      in: path
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    CommentList:
      type: object
      required:
        - data
        - total
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Comment'
        total:
          type: integer
    Comment:
      type: object
      required:
        - id
        - body
        - author
        - reactions
        - replies_count
        - created_at
        - deleted
        - hidden
        - pinned
        - mine
      properties:
        id:
          type: string
          format: uuid
        parent_id:
          type: string
          format: uuid
          description: A raiz, quando este comentário é uma resposta.
        body:
          description: |
            Texto CRU, como a pessoa escreveu — a tela escapa na hora de
            exibir. A menção aparece como `@{uuid}`, e `mentions` diz o nome de
            cada um.
          type: string
        author:
          $ref: '#/components/schemas/CommentAuthor'
        mentions:
          type: array
          items:
            $ref: '#/components/schemas/CommentMention'
        images:
          description: >-
            As imagens do comentário, na ordem, assinadas no momento da
            resposta.
          type: array
          items:
            $ref: '#/components/schemas/Playback'
        reactions:
          description: |
            Por emoji, do mais usado para o menos, com a contagem e se quem
            está na sessão é uma delas.
          type: array
          items:
            $ref: '#/components/schemas/CommentReaction'
        replies_count:
          type: integer
          description: Quantas respostas existem ao todo — zero numa resposta.
        answered:
          type: boolean
          description: Alguém que administra o club já respondeu nesta conversa.
        replies:
          description: |
            As primeiras respostas, para a tela desenhar a conversa sem uma
            segunda ida. O resto vem por `/replies`.
          type: array
          items:
            $ref: '#/components/schemas/Comment'
        created_at:
          type: string
          format: date-time
        edited_at:
          type: string
          format: date-time
        hidden:
          type: boolean
          description: |
            Ocultado por quem administra. Só chega a quem o escreveu e a quem
            administra — para o resto da turma o comentário não existe.
        pinned:
          type: boolean
          description: |
            Fixado por quem administra: a listagem traz os fixados no topo, do
            fixado mais recentemente para o mais antigo. Só a raiz se fixa.
        saved:
          type: boolean
          description: |
            Salvo pela equipe do club. Vem só para quem administra — para o
            aluno o campo não existe, e ele não sabe que o comentário foi salvo.
        deleted:
          type: boolean
          description: >-
            Removido; o corpo vem vazio e a linha só continua por causa das
            respostas.
        mine:
          type: boolean
          description: Foi escrito por quem está na sessão — quem pode editar e remover.
    ErrorEnvelope:
      type: object
      description: >-
        Envelope único de erro da API. O `code` é o contrato com o cliente — a
        `message` é diagnóstico, e pode mudar.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
          properties:
            code:
              type: string
            message:
              type: string
    CommentAuthor:
      type: object
      required:
        - name
        - role
      properties:
        id:
          type: string
          format: uuid
          description: |
            Ausente quando o autor é o assistente. É o id que uma menção usa
            (`@{uuid}` no corpo).
        name:
          type: string
        role:
          $ref: '#/components/schemas/CommentAuthorRole'
        anonymized:
          type: boolean
          description: A conta de quem escreveu foi removida.
    CommentMention:
      type: object
      required:
        - id
        - name
        - role
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          description: |
            O nome de HOJE de quem foi citado — o corpo guarda só o id, então
            quem trocou de nome aparece com o novo em tudo que já foi escrito.
        role:
          $ref: '#/components/schemas/CommentAuthorRole'
    Playback:
      description: |
        A entrega, assinada no momento em que sai e com prazo curto. Não é
        guardada em coluna nem em cache — link assinado dentro de cache é link
        que expira guardado.
      type: object
      required:
        - kind
        - provider
        - url
        - expires_at
        - signed
      properties:
        kind:
          $ref: '#/components/schemas/MediaKind'
        provider:
          $ref: '#/components/schemas/MediaProvider'
        url:
          description: A playlist HLS, o arquivo, ou o id/URL de quem é de fora.
          type: string
        thumbnail_url:
          type: string
        duration_seconds:
          type: integer
        title:
          type: string
        expires_at:
          type: string
          format: date-time
        signed:
          description: |
            Falso quando a entrega é aberta — mídia pública, ou zona de vídeo
            sem chave de token. A resposta não finge proteção que não existe.
          type: boolean
    CommentReaction:
      type: object
      required:
        - reaction
        - count
        - mine
      properties:
        reaction:
          $ref: '#/components/schemas/CommentReactionKind'
        count:
          type: integer
        mine:
          type: boolean
          description: Quem está na sessão é uma destas.
    CommentAuthorRole:
      type: string
      enum:
        - student
        - manager
        - assistant
      description: |
        Quem escreveu: o aluno, quem administra o club (o selo da tela), ou o
        assistente. São as duas identidades do produto mais a linha sem dono
        humano; o papel sai da COLUNA que ficou preenchida no comentário, e
        não de uma consulta de permissão na hora de ler — quem respondeu como
        instrutora continua tendo respondido como instrutora depois de sair do
        club.
    MediaKind:
      description: Rótulo de tela — o ícone e o filtro. Nada de acesso lê isto.
      type: string
      enum:
        - video
        - audio
        - image
        - document
    MediaProvider:
      description: |
        Onde o bit mora. `bunny_stream` é o vídeo que hospedamos e `r2` o
        arquivo; `youtube`, `vimeo` e `external` são referências a algo de fora,
        que a biblioteca guarda para a aula ter um caminho só.
      type: string
      enum:
        - bunny_stream
        - r2
        - youtube
        - vimeo
        - external
    CommentReactionKind:
      type: string
      enum:
        - ❤️
        - 👍
        - 🔥
        - 👏
        - 😂
      x-enum-varnames:
        - ReactionHeart
        - ReactionThumbsUp
        - ReactionFire
        - ReactionClap
        - ReactionLaugh
      description: |
        As reações possíveis. Lista fechada, igual ao CHECK da tabela: emoji
        livre é texto livre ao lado do nome de outra pessoa.
  responses:
    Unauthorized:
      description: Sessão ausente, expirada ou revogada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: >
        A sessão é válida, mas não age nesta organização. É a mesma resposta
        para

        uma organização que não existe — distinguir as duas deixaria enumerar

        organizações alheias.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Recurso não encontrado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalError:
      description: >-
        Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no
        rastreamento.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    studentSession:
      type: http
      scheme: bearer
      description: |
        Token OPACO de sessão de aluno, emitido por `/v1/auth/sign-in` e
        verificado contra a nossa tabela — não é JWT e não se lê nada dele.

        A ida ao banco não é custo novo: toda requisição autenticada já resolve
        o dono da sessão. Em troca, encerrar uma sessão vale no mesmo instante,
        sem lista de bloqueio nem janela de tolerância.

        O classroom o guarda em cookie **host-only**: um cookie de domínio o
        mandaria para os subdomínios dos outros clubs.

````

## Related topics

- [Remover um comentário](/api-reference/comments/managed-delete.md)
- [Comentários da aula](/api-reference/comments/lesson-list.md)
- [Remover o próprio comentário](/api-reference/comments/delete.md)
- [Editar o próprio comentário](/api-reference/comments/update.md)
- [Caixa de comentários do club](/api-reference/comments/managed-list.md)
