coderockr / vitrine-social Goto Github PK

Necessidade [/need/{id}]

Atualizar Need [PUT]

• Parameters

  • id (number) - Id da necessidade

• Request Atualizar

  • Headers

      Accept: application/json
      Content-Type: application/json
      Authorization: JWT
    

  • Attributes (NeedPayload)

• Response 204 (application/json)

• Response 400 (application/json)

  • Attributes (Error)

Usando o api blueprint

Remover imagem [/organization/{id}/image/{image_id}]

Remover imagem [DELETE]

• Parameters

  • id (number) - Id da ONG
  • image_id (number) - Id da imagem

• Request

  • Headers

      Accept: application/json
      Content-Type: application/json
      Authorization: JWT
    

• Response 204

• Response 400 (application/json)

  • Attributes (Error)

Organização [/organization/{id}]

Perfil da ONG [GET]

• Parameters

  • id (number) - Id da ONG

• Response 200 (application/json)

  • Attributes (DetailedOrganization)

• Response 404 (application/json)

  • Attributes (Error)

Talvez pedir para algum fornecedor de hospedagem patrocinar?

Search [/search?text={text}&category={categories}&org={org}&page={page}]

Fazer busca [GET]

• Parameters

  • text: texto a ser pesquisado (string, optional) - Texto a ser pesquidado
  • categories: 1,2,3 (string, optional) - Ids das categorias
  • org: 1 (number, optional) - Id da entidade para filtrar
  • page: 1 (number, optional) - Paginação (vai trazer sempre 10 por página)

• Request Busca das necessidades

  • Headers

      Accept: application/json
      Content-Type: application/json
    

• Response 200 (application/json)

  • Attributes (array[BaseNeed])

Criar uma tela que deve receber um token JWT pela URL e solicitar que a Organização informe uma senha para acessar o sistema, depois disso a tela enviar a nova senha para o backend deve redirecionar para a tela de login.

Unsubscribe [/organization/{id}/unsubscribe/{email}]

Parar de receber notificações [GET]

• Parameters

  • id (number) - Id da ONG
  • email (string) - E-mail

• Response 204 (application/json)

• Response 404 (application/json)

  • Attributes (Error)

• ajustar overflow

Upload [/organization/{id}/upload]

Fazer upload [POST]

• Parameters

  • id (number) - Id da ONG

• Request Upload de um arquivo

  • Headers

      Accept: application/json
      Content-Type: application/json
      Authorization: JWT
    

  • Attributes (UploadFile)

• Response 201 (application/json)

  • Attributes (Created)

• Response 400 (application/json)

  • Attributes (Error)

A Organização deve definir qual é a unidade que está precisando (kg, pessoas)

POST /v1/auth/update-password
Example URI: POST http://api.vitrine.dev:8001/v1/v1/auth/update-password

Request Atualizar SenhaHide

Headers

Accept: application/json
Content-Type: application/json
Authorization: JWT

Body

{
  "currentPassword": "123",
  "newPassword": "1234"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "currentPassword": {
      "type": "string",
      "description": "Senha Atual"
    },
    "newPassword": {
      "type": "string",
      "description": "Nova Senha"
    }
  }
}

Response 200

Response 400

Headers

Content-Type: application/json

Body

{
  "code": 400,
  "message": "Hello, world!"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    }
  }
}

What is the objective?

Implementar storage para subir arquivos no S3.

Be careful on ...

• Rever handler DeleteOrganizationImage para remover o arquivo do storage também.

Criar um cliente simples para incluir organizações no banco de dados após aprovadas

Remover imagem [/need/{id}/image/{image_id}]

Remover imagem [DELETE]

• Parameters

  • id (number) - Id da necessidade
  • image_id (number) - Id da imagem

• Request

  • Headers

      Accept: application/json
      Content-Type: application/json
      Authorization: JWT
    

• Response 204

• Response 400 (application/json)

  • Attributes (Error)

Para pre-carregar os dados e facilitar as migrações de dados

Necessidade [/need/{id}]

Dados da necessidade [GET]

• Parameters

  • id (number) - Id da necessidade

• Response 200 (application/json)

  • Attributes (Need)

• Response 404 (application/json)

  • Attributes (Error)

Subscribe [/organization/{id}/subscribe]

Receber notificações [POST]

• Parameters

  • id (number) - Id da ONG

• Request

  • Attributes
    • email (string) - E-mail
    • name (string) - Nome
    • phone (string) - Telefone

• Response 204 (application/json)

• Response 404 (application/json)

  • Attributes (Error)

requires #45

Response [/need/{id}/response]

Responder a uma necessidade [POST]

• Parameters

  • id (number) - Id da necessidade

• Request

  • Attributes
    • email (string) - E-mail
    • name (string) - Nome
    • phone (string) - Telefone
    • address (string) - Endereço
    • message (string) - Mensagem enviada para a ONG

• Response 204 (application/json)

• Response 404 (application/json)

  • Attributes (Error)

Carrossel de imagens foi para #79

Upload [/need/{id}/upload]

Fazer upload [POST]

• Parameters

  • id (number) - Id da necessidade

• Request Upload de um arquivo

  • Headers

      Accept: application/json
      Content-Type: application/json
      Authorization: JWT
    

  • Attributes (UploadFile)

• Response 201 (application/json)

  • Attributes (Created)

• Response 400 (application/json)

  • Attributes (Error)

Login [/auth/login]

Realizar login [POST]

• Request Login

  • Headers
    Accept: application/json
    Content-Type: application/json
  • Attributes (Login)

• Response 200 (application/json)

  • Attributes
    • organization (BaseOrganization)
    • token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ (string)

• Response 404 (application/json)

  • Attributes (Error)

Logout [/auth/logout]

Realizar logout [POST]

• Request Logout

  • Headers
    Accept: application/json
    Content-Type: application/json
    Authorization: JWT

• Response 204

Scopo Inicial do MVP

related to #35

Organização [/organization/{id}]

Atualizar ONG [PUT]

• Parameters

  • id (number) - Id da ONG

• Request Atualizar

  • Headers
    Accept: application/json
    Content-Type: application/json
    Authorization: JWT
  • Attributes (DetailedOrganization)

• Response 204 (application/json)

• Response 400 (application/json)

  • Attributes (Error)

Criar [/need]

Criar Need [POST]

• Request Criar

  • Headers

      Accept: application/json
      Content-Type: application/json
      Authorization: JWT
    

  • Attributes (NeedPayload)

• Response 201 (application/json)

  • Attributes (Created)

• Response 400 (application/json)

  • Attributes (Error)