> ## 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.

# Comentários do aluno

> O que o aluno escreveu nas conversas das aulas.



## OpenAPI

````yaml GET /v1/clubs/{clubId}/classroom/my-comments
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
  - name: exports
  - name: certificates
paths:
  /v1/clubs/{clubId}/classroom/my-comments:
    parameters:
      - $ref: '#/components/parameters/OrgId'
    get:
      tags:
        - classroom
      summary: Lista os comentários do aluno nas aulas
      description: |
        O que quem está na sessão escreveu nas conversas das AULAS — raízes e
        respostas —, do mais recente para o mais antigo, até os 200 últimos.
        Comentário apagado não vem; o oculto por quem modera vem, porque quem
        escreveu continua a vê-lo na aula. Os de post da comunidade ficam de
        fora. Só vem o que a pessoa ainda pode abrir, com a regra das salvas.
      operationId: listClassroomComments
      responses:
        '200':
          description: Os comentários
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassroomOwnCommentList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '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
  schemas:
    ClassroomOwnCommentList:
      type: object
      required:
        - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ClassroomOwnComment'
    ClassroomOwnComment:
      description: Um comentário que o aluno escreveu numa aula.
      type: object
      required:
        - id
        - body
        - created_at
        - is_reply
        - lesson_public_id
        - lesson_title
        - course_public_id
        - course_title
      properties:
        id:
          type: string
          format: uuid
        body:
          description: |
            Texto CRU, como no `Comment`: a menção aparece como `@{uuid}`, e
            `mentions` diz o nome de cada um.
          type: string
        mentions:
          type: array
          items:
            $ref: '#/components/schemas/CommentMention'
        is_reply:
          description: É resposta a outro comentário, e não o início de uma conversa.
          type: boolean
        created_at:
          type: string
          format: date-time
        lesson_public_id:
          type: string
        lesson_title:
          type: string
        course_public_id:
          type: string
        course_title:
          type: string
    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
    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'
    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.
  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'
    TooManyRequests:
      description: Teto por IP atingido
      headers:
        Retry-After:
          schema:
            type: integer
      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

- [Caixa de comentários do club](/api-reference/comments/managed-list.md)
- [Linha do tempo de um aluno](/api-reference/students/activity.md)
- [Mentorias](/essentials/mentorships.md)
- [Comentários da aula](/api-reference/comments/lesson-list.md)
- [Editar o próprio comentário](/api-reference/comments/update.md)
