Atualizar projeto

Versão 3.1.23.2

Atualizar configuração do projeto

Aplicar alterações à configuração de um projeto.

Como configurar o Git para um projeto

Para configurar um projeto do Looker com um repositório git remoto, siga estas etapas:

  1. Chame update_session para selecionar o espaço de trabalho "dev".
  2. Chame create_git_deploy_key para criar uma nova chave de implantação para o projeto
  3. Copiar o texto da chave de implantação na configuração da chave SSH do repositório remoto
  4. Chame update_project para definir git_remote_url () e git_service_name do projeto, se necessário.

Quando você modifica o git_remote_url de um projeto, o Looker se conecta ao repositório remoto para buscar metadados. O repositório git remoto PRECISA ser configurado com a chave de implantação gerada pelo Looker para este projeto antes de definir o git_remote_url do projeto.

Para configurar um projeto do Looker com um repositório Git residente no servidor Looker (um repositório Git "bare"):

  1. Chame update_session para selecionar o espaço de trabalho "dev".
  2. Chame update_project definindo git_remote_url como nulo e git_service_name como "bare".

Solicitação

PATCH /projects/{project_id}
Tipo de dados
Descrição
Solicitação
HTTPRequest
path
HTTPPath
Expandir definição HTTPPath...
project_id
string
ID do projeto
body
Corpo HTTP
Expandir definição HTTPBody...
body
Projeto
Expandir a definição do projeto...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
id
string
ID do projeto
nome
string
Nome de exibição do projeto
usa_git
booleano
Se verdadeiro, o projeto é configurado com um repositório git
git_remote_url
string
URL do repositório remoto do Git
git_username
string
Nome de usuário do Git para autenticação HTTPS. Somente para produção, se estiver usando atributos do usuário.
git_password
string
Senha do Git (somente gravação) para autenticação HTTPS. Somente para produção, se estiver usando atributos do usuário.
git_production_branch_name
string
Nome da ramificação de produção do Git. O padrão é o mestre. Compatível apenas com o Looker 21.0 e versões mais recentes.
use_git_cookie_auth
booleano
Se verdadeiro, o projeto usa um cookie git para autenticação.
git_username_user_attribute
string
Nome do atributo do usuário para o nome de usuário na autenticação HTTPS por usuário.
git_password_user_attribute
string
Nome do atributo do usuário para senha na autenticação HTTPS por usuário.
git_service_name
string
Nome do provedor de serviços Git
git_application_server_http_port
integer
Porta em que o servidor de aplicativos HTTP(S) está sendo executado (para PRs, navegação de arquivos etc.)
git_application_server_http_scheme
string
Scheme executado no servidor de aplicativos (para PRs, navegação de arquivos etc.)
implantar_secreto
string
(Somente gravação) Token confidencial opcional com o qual autenticar solicitações para o endpoint de implantação do webhook. Se não for definido, o endpoint não será autenticado.
Não definido, implantar
booleano
(Somente gravação) Quando verdadeiro, cancela a configuração do secret de implantação para permitir acesso não autenticado ao endpoint de implantação do webhook.
modo_de_solicitação_de_pull
string
A política de solicitação de envio do Git para este projeto. Os valores válidos são: "off", "links", "recommended", "required".
validação_obrigatória
booleano
Política de validação: se verdadeiro, o projeto precisa ser aprovado nas verificações de validação antes que as alterações do projeto possam ser confirmadas no repositório git
git_release_mgmt_enabled
booleano
Se verdadeiro, o gerenciamento avançado de versões do git está ativado neste projeto.
allow_warnings
booleano
Política de validação: se verdadeiro, o projeto poderá ser confirmado com avisos quando "validation_required" for verdadeiro. "allow_warnings" não terá efeito se "validation_required" for falso.
exemplo_is
booleano
Se for "true", o projeto é um exemplo e não pode ser modificado
consulta
Consulta HTTP
Expandir a definição de HTTPQuery...
campos
string
Campos solicitados

Resposta

200: Projeto

Tipo de dados
Descrição
(objeto)
pode
objeto
Operações que o usuário atual pode realizar neste objeto
id
string
ID do projeto
nome
string
Nome de exibição do projeto
usa_git
booleano
Se verdadeiro, o projeto é configurado com um repositório git
git_remote_url
string
URL do repositório remoto do Git
git_username
string
Nome de usuário do Git para autenticação HTTPS. Somente para produção, se estiver usando atributos do usuário.
git_password
string
Senha do Git (somente gravação) para autenticação HTTPS. Somente para produção, se estiver usando atributos do usuário.
git_production_branch_name
string
Nome da ramificação de produção do Git. O padrão é o mestre. Compatível apenas com o Looker 21.0 e versões mais recentes.
use_git_cookie_auth
booleano
Se verdadeiro, o projeto usa um cookie git para autenticação.
git_username_user_attribute
string
Nome do atributo do usuário para o nome de usuário na autenticação HTTPS por usuário.
git_password_user_attribute
string
Nome do atributo do usuário para senha na autenticação HTTPS por usuário.
git_service_name
string
Nome do provedor de serviços Git
git_application_server_http_port
integer
Porta em que o servidor de aplicativos HTTP(S) está sendo executado (para PRs, navegação de arquivos etc.)
git_application_server_http_scheme
string
Scheme executado no servidor de aplicativos (para PRs, navegação de arquivos etc.)
implantar_secreto
string
(Somente gravação) Token confidencial opcional com o qual autenticar solicitações para o endpoint de implantação do webhook. Se não for definido, o endpoint não será autenticado.
Não definido, implantar
booleano
(Somente gravação) Quando verdadeiro, cancela a configuração do secret de implantação para permitir acesso não autenticado ao endpoint de implantação do webhook.
modo_de_solicitação_de_pull
string
A política de solicitação de envio do Git para este projeto. Os valores válidos são: "off", "links", "recommended", "required".
validação_obrigatória
booleano
Política de validação: se verdadeiro, o projeto precisa ser aprovado nas verificações de validação antes que as alterações do projeto possam ser confirmadas no repositório git
git_release_mgmt_enabled
booleano
Se verdadeiro, o gerenciamento avançado de versões do git está ativado neste projeto.
allow_warnings
booleano
Política de validação: se verdadeiro, o projeto poderá ser confirmado com avisos quando "validation_required" for verdadeiro. "allow_warnings" não terá efeito se "validation_required" for falso.
exemplo_is
booleano
Se for "true", o projeto é um exemplo e não pode ser modificado

400: Solicitação inválida

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

404: não encontrado

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

409: recurso já existe

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

422: erro de validação

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
Expandir a definição de ValidationErrorDetail...
campo
string
Campo com erro
código
string
Código do erro
mensagem
string
Mensagem de erro
url_da_documentação
string
Link da documentação
url_da_documentação
string
Link da documentação

429: Solicitações demais

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

500: Erro no servidor

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação