> ## 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. # Editar meta > O status é decisão de quem mentora. ## OpenAPI ````yaml PATCH /v1/clubs/{clubId}/mentorship-goals/{goalId} 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}/mentorship-goals/{goalId}: parameters: - $ref: '#/components/parameters/OrgId' - $ref: '#/components/parameters/MentorshipGoalId' patch: tags: - mentorships summary: Edita uma meta, ou a dá por alcançada description: | `status` é decisão de quem mentora: há meta alcançada sem tarefa nenhuma, e há meta com todas as tarefas feitas que não chegou lá. operationId: updateMentorshipGoal requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MentorshipGoalUpdate' responses: '200': description: A meta content: application/json: schema: $ref: '#/components/schemas/MentorshipGoalResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '422': $ref: '#/components/responses/UnprocessableEntity' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' security: - userSession: [] 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 MentorshipGoalId: name: goalId in: path required: true schema: type: string format: uuid schemas: MentorshipGoalUpdate: type: object properties: title: type: string minLength: 1 maxLength: 200 description: type: string maxLength: 4000 nullable: true target_on: type: string format: date nullable: true status: $ref: '#/components/schemas/MentorshipGoalStatus' MentorshipGoalResponse: type: object required: - data properties: data: $ref: '#/components/schemas/MentorshipGoal' MentorshipGoalStatus: type: string enum: - open - achieved - abandoned x-enum-varnames: - GoalOpen - GoalAchieved - GoalAbandoned MentorshipGoal: type: object required: - id - title - status - position - tasks_total - tasks_done - tasks - created_at properties: id: type: string format: uuid title: type: string description: type: string target_on: type: string format: date status: $ref: '#/components/schemas/MentorshipGoalStatus' playbook_id: type: string format: uuid description: O playbook de onde a meta saiu, se saiu. position: type: integer tasks_total: type: integer tasks_done: type: integer tasks: type: array items: $ref: '#/components/schemas/MentorshipTask' created_at: type: string format: date-time 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 MentorshipTask: type: object required: - id - title - position - completed - created_at properties: id: type: string format: uuid goal_id: type: string format: uuid session_id: type: string format: uuid title: type: string description: type: string due_on: type: string format: date position: type: integer completed: type: boolean completed_at: type: string format: date-time completed_by: $ref: '#/components/schemas/MentorshipTaskCompletedBy' completion_note: type: string description: O que o aluno escreveu ao concluir. created_at: type: string format: date-time MentorshipTaskCompletedBy: type: string enum: - student - staff x-enum-varnames: - CompletedByStudent - CompletedByStaff responses: BadRequest: description: Requisição malformada content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' 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' UnprocessableEntity: description: Campos obrigatórios ausentes ou inválidos 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: userSession: type: http scheme: bearer description: | Token OPACO de sessão de quem administra, emitido por `/v1/auth/admin/sign-in` e verificado contra a nossa tabela — o mesmo desenho do `studentSession`, para a outra identidade. É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o `studentSession`; uma rota consumida pelos dois declara os dois esquemas, e o middleware aceita qualquer um deles. As duas credenciais são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em que cada uma existe. O dashboard o guarda em cookie httpOnly, que o BFF troca pelo `Authorization` a cada chamada. ```` ## Related topics - [Editar tarefa](/api-reference/mentorships/task-update.md) - [Editar playbook](/api-reference/mentorships/playbook-update.md) - [Reordenar metas](/api-reference/mentorships/goal-order.md) - [Remover meta](/api-reference/mentorships/goal-delete.md) - [Criar meta ou aplicar playbook](/api-reference/mentorships/goal-create.md)