API

Todo

Usar a opção de autohttp.flask para atualizar automaticamente essa seção

Nessa seção vamos definir toda a documentação da API do projeto.

Autenticação

Em breve

Documentos

Nesse recurso, é aonde fica disponibilizado e persistido os documentos do projeto. Temos as seguintes URIs:

GET /api/v1/(string: bucket)/documentos/

Lista os documentos de um determinado sistema a partir do seu bucket.

Exemplo de requisição:

GET /api/v1/procult/documentos/ HTTP/1.1
Authorization: Token 1af538baa9045a84c0e889f672baf83ff24
Host: octofiles.cultura.df.gov.br

Parameters:

• bucket – Nome do bucket do sistema.

Request Headers:  

• Authorization – Token para autenticação

Exemplo de resposta:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

[
    {
        "document_url": "http://octofiles.cultura.df.gov.br/api/v1/procult/propostas/alsd01lkasd9123jalsd123.pdf",
        "self_url": "http://octofiles.cultura.df.gov.br/api/v1/procult/ask12312309aslk1230",
        "metadata": {
          "name": "Fotos do Show",
          "type": "pdf",
          "size": 1200000
        },
        "owner_uid": "asdk1239asdlk12309as",
        "mode": "private"
    }
]

Response Headers:  

• Content-Type – Formato JSON

Status Codes:

• 200 OK – Requisição aceita com sucesso
• 400 Bad Request – Problema na requisição enviada
• 500 Internal Server Error – Erro na consulta dos documentos

POST /api/v1/(string: bucket)/documentos/

Envia um novo documento para armazenamento, a partir do seu bucket.

Parameters:

• bucket – Nome do bucket do sistema

Form Parameters:  

• name – Nome do Arquivo
• path – Caminho do arquivo a ser salvo
• file – Binário do arquivo para upload
• mode – Modo de visualização: public ou private
• owner – Se o modo de visualização for private, o identificador único do dono do arquivo

Request Headers:  

• Authorization – Token para autenticação

Response Headers:  

• Content-Type – Formato JSON
• Location – URI do arquivo recém criado

Status Codes:

• 201 Created – Documento criado com sucesso
• 400 Bad Request – Erro na montagem da requisição para upload do arquivo
• 500 Internal Server Error – Erro durante o upload do arquivo

GET /api/v1/(string: bucket)/(string: uid)

Retorna informações do documento pesquisado a partir do seu bucket e o uid do arquivo.

Exemplo de requisição:

GET /api/v1/procult/ask12312309aslk1230 HTTP/1.1
Authorization: Token 1af538baa9045a84c0e889f672baf83ff24
Host: octofiles.cultura.df.gov.br

Parameters:

• bucket – Nome do bucket do sistema.
• uid – Identificador único (UID) do arquivo salvo

Request Headers:  

• Authorization – Token para autenticação

Exemplo de resposta:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "document_url": "http://octofiles.cultura.df.gov.br/api/v1/procult/propostas/alsd01lkasd9123jalsd123.pdf",
    "self_url": "http://octofiles.cultura.df.gov.br/api/v1/procult/ask12312309aslk1230",
    "metadata": {
      "name": "Fotos do Show",
      "type": "pdf",
      "size": 1200000
    },
    "owner_uid": "asdk1239asdlk12309as",
    "mode": "private"
}

Response Headers:  

• Content-Type – Formato JSON

Status Codes:

• 200 OK – Requisição aceita com sucesso
• 400 Bad Request – Problema na requisição enviada
• 500 Internal Server Error – Erro na consulta do documento

PUT /api/v1/(string: bucket)/(string: uid)

Atualiza as informações do documento selecionado a partir do seu bucket e o uid do arquivo.

Parameters:

• bucket – Nome do bucket do sistema
• uid – Identificador único (UID) do arquivo salvo

Form Parameters:  

• name – Nome do Arquivo
• mode – Modo de visualização: public ou private
• owner – Se o modo de visualização for private, o identificador único do dono do arquivo

Request Headers:  

• Authorization – Token para autenticação

Response Headers:  

• Content-Type – Formato JSON
• Location – URI do arquivo recém criado

Status Codes:

• 200 OK – Documento atualizado com sucesso
• 400 Bad Request – Erro na montagem da requisição para atualização do arquivo
• 500 Internal Server Error – Erro durante atualização do arquivo

DELETE /api/v1/(string: bucket)/(string: uid)

Remove o documento selecionado a partir do seu bucket e o uid do arquivo.

Parameters:

• bucket – Nome do bucket do sistema
• uid – Identificador único (UID) do arquivo salvo

Request Headers:  

• Authorization – Token para autenticação

Status Codes:

• 204 No Content – Documento excluido com sucesso
• 400 Bad Request – Erro na montagem da requisição para remoção do arquivo
• 500 Internal Server Error – Erro durante remoção do arquivo