版本 3.1.23.6
验证项目
对项目中的所有 Lookml 文件执行 lint 验证。 返回发现的错误列表(如果有)。
对于大型项目,验证项目中所有文件的内容可能涉及计算密集型工作。为实现最佳性能,请仅在您确实想要重新计算项目验证时调用 validate_project(project_id)
。如需快速显示最新项目验证(不重新计算)的结果,请使用 project_validation_results(project_id)
。
请求
POST
/projects/{project_id}/validate
数据类型
说明
请求
路径
展开 HTTPPath 定义...
project_id
项目 ID
查询
展开 HTTPQuery 定义...
字段
请求的字段
响应
200:项目验证结果
数据类型
说明
(对象)
错误
展开 ProjectError 定义...
代码
lock
一个稳定令牌,唯一标识此类错误,并忽略参数值。错误消息文本可能会因参数或本地化而异,但错误代码不会。例如,无论相关文件名或用户的显示语言为何,“未找到文件”错误的错误代码都相同:
严重程度
lock
严重性:严重、错误、警告、信息、成功
kind
lock
错误分类:语法、弃用、model_configuration 等
消息
lock
错误消息,其中可能包括一些可能被视为敏感的信息中心或型号名称等信息。避免在 Looker 之外存储或发送此消息
field_name
lock
与此错误关联的字段
文件路径
lock
包含此错误的文件的名称
行号
lock
此错误文件中的行号
model_id
lock
与此错误关联的模型
探索
lock
与此错误相关的探索
帮助网址
lock
指向有关此错误的 Looker 文档的链接
params
lock
错误参数
sanitized_message
lock
不包含潜在敏感信息的错误消息版本。适用于将消息存储或发送到 Looker 之外的消费者的情况(例如外部日志)。经过排错后的消息会显示“(?)”,其中敏感信息会显示在未经过排错的相应消息中
项目摘要
lock
根据项目的当前状态计算得出的哈希值
模型未验证
展开 ModelsNotValidated 定义...
name
lock
模型名称
project_file_id
lock
项目文件
计算时间
lock
项目验证时长(以秒为单位)
400:错误请求
数据类型
说明
(对象)
消息
lock
错误详情
文档网址
lock
文档链接
404:未找到
数据类型
说明
(对象)
消息
lock
错误详情
文档网址
lock
文档链接
422:验证错误
数据类型
说明
(对象)
消息
lock
错误详情
错误
展开 ValidationErrorDetail 定义...
字段
lock
出错的字段
代码
lock
错误代码
消息
lock
错误信息消息
文档网址
lock
文档链接
文档网址
lock
文档链接
429:请求数过多
数据类型
说明
(对象)
消息
lock
错误详情
文档网址
lock
文档链接
示例
Ruby
https://github.com/looker-open-source/sdk-codegen/blob/main/examples/ruby/validate_projects.rb |
TypeScript
https://github.com/looker-open-source/sdk-codegen/blob/main/examples/typescript/validateBranch.ts |
https://github.com/looker-open-source/sdk-codegen/blob/main/examples/typescript/validateBranch.ts |