openlayer 0.15.0 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (276) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +35 -0
  3. data/README.md +1 -1
  4. data/lib/openlayer/client.rb +8 -0
  5. data/lib/openlayer/models/background_task_retrieve_params.rb +20 -0
  6. data/lib/openlayer/models/background_task_retrieve_response.rb +85 -0
  7. data/lib/openlayer/models/governance/framework_create_params.rb +143 -0
  8. data/lib/openlayer/models/governance/framework_create_response.rb +412 -0
  9. data/lib/openlayer/models/governance/framework_export_params.rb +36 -0
  10. data/lib/openlayer/models/governance/framework_export_response.rb +32 -0
  11. data/lib/openlayer/models/governance/framework_list_params.rb +148 -0
  12. data/lib/openlayer/models/governance/framework_list_project_rule_stats_params.rb +74 -0
  13. data/lib/openlayer/models/governance/framework_list_project_rule_stats_response.rb +279 -0
  14. data/lib/openlayer/models/governance/framework_list_projects_params.rb +39 -0
  15. data/lib/openlayer/models/governance/framework_list_projects_response.rb +315 -0
  16. data/lib/openlayer/models/governance/framework_list_response.rb +423 -0
  17. data/lib/openlayer/models/governance/framework_list_rules_params.rb +39 -0
  18. data/lib/openlayer/models/governance/framework_list_rules_response.rb +696 -0
  19. data/lib/openlayer/models/governance/framework_retrieve_params.rb +22 -0
  20. data/lib/openlayer/models/governance/framework_retrieve_response.rb +412 -0
  21. data/lib/openlayer/models/governance/framework_update_params.rb +200 -0
  22. data/lib/openlayer/models/governance/framework_update_response.rb +412 -0
  23. data/lib/openlayer/models/governance/frameworks/document_list_params.rb +41 -0
  24. data/lib/openlayer/models/governance/frameworks/document_list_response.rb +598 -0
  25. data/lib/openlayer/models/governance/frameworks/document_retrieve_params.rb +30 -0
  26. data/lib/openlayer/models/governance/frameworks/document_retrieve_response.rb +587 -0
  27. data/lib/openlayer/models/governance/frameworks/section_list_rules_params.rb +96 -0
  28. data/lib/openlayer/models/governance/frameworks/section_list_rules_response.rb +700 -0
  29. data/lib/openlayer/models/governance/frameworks/subsection_list_rules_params.rb +88 -0
  30. data/lib/openlayer/models/governance/frameworks/subsection_list_rules_response.rb +700 -0
  31. data/lib/openlayer/models/governance/rule_create_params.rb +173 -0
  32. data/lib/openlayer/models/governance/rule_create_response.rb +677 -0
  33. data/lib/openlayer/models/governance/rule_delete_params.rb +22 -0
  34. data/lib/openlayer/models/governance/rule_list_params.rb +231 -0
  35. data/lib/openlayer/models/governance/rule_list_response.rb +694 -0
  36. data/lib/openlayer/models/governance/rule_result_create_evidence_params.rb +69 -0
  37. data/lib/openlayer/models/governance/rule_result_create_evidence_response.rb +95 -0
  38. data/lib/openlayer/models/governance/rule_result_list_evidence_params.rb +39 -0
  39. data/lib/openlayer/models/governance/rule_result_list_evidence_response.rb +106 -0
  40. data/lib/openlayer/models/governance/rule_result_list_params.rb +149 -0
  41. data/lib/openlayer/models/governance/rule_result_list_response.rb +276 -0
  42. data/lib/openlayer/models/governance/rule_result_retrieve_params.rb +22 -0
  43. data/lib/openlayer/models/governance/rule_result_retrieve_response.rb +264 -0
  44. data/lib/openlayer/models/governance/rule_result_update_params.rb +156 -0
  45. data/lib/openlayer/models/governance/rule_result_update_response.rb +263 -0
  46. data/lib/openlayer/models/governance/rule_retrieve_params.rb +22 -0
  47. data/lib/openlayer/models/governance/rule_retrieve_response.rb +681 -0
  48. data/lib/openlayer/models/governance/rule_stat_retrieve_params.rb +39 -0
  49. data/lib/openlayer/models/governance/rule_stat_retrieve_response.rb +508 -0
  50. data/lib/openlayer/models/governance/rule_tag_list_params.rb +39 -0
  51. data/lib/openlayer/models/governance/rule_tag_list_response.rb +91 -0
  52. data/lib/openlayer/models/governance/rule_update_params.rb +78 -0
  53. data/lib/openlayer/models/governance/rule_update_response.rb +677 -0
  54. data/lib/openlayer/models/inference_pipeline_retrieve_response.rb +0 -1
  55. data/lib/openlayer/models/inference_pipeline_retrieve_sessions_response.rb +3 -0
  56. data/lib/openlayer/models/inference_pipeline_retrieve_users_response.rb +3 -0
  57. data/lib/openlayer/models/inference_pipeline_update_response.rb +0 -1
  58. data/lib/openlayer/models/project_create_response.rb +0 -1
  59. data/lib/openlayer/models/project_list_response.rb +0 -1
  60. data/lib/openlayer/models/project_update_response.rb +0 -1
  61. data/lib/openlayer/models/projects/inference_pipeline_create_params.rb +0 -1
  62. data/lib/openlayer/models/projects/inference_pipeline_create_response.rb +0 -1
  63. data/lib/openlayer/models/projects/inference_pipeline_list_response.rb +0 -1
  64. data/lib/openlayer/models/storage/presigned_url_retrieve_params.rb +28 -0
  65. data/lib/openlayer/models/storage/presigned_url_retrieve_response.rb +19 -0
  66. data/lib/openlayer/models/workspaces/api_key_create_params.rb +17 -1
  67. data/lib/openlayer/models/workspaces/api_key_create_response.rb +73 -3
  68. data/lib/openlayer/models/workspaces/api_key_delete_params.rb +28 -0
  69. data/lib/openlayer/models/workspaces/api_key_list_params.rb +22 -0
  70. data/lib/openlayer/models/workspaces/api_key_list_response.rb +134 -0
  71. data/lib/openlayer/models/workspaces/api_key_retrieve_params.rb +28 -0
  72. data/lib/openlayer/models/workspaces/api_key_retrieve_response.rb +131 -0
  73. data/lib/openlayer/models/workspaces/api_key_rotate_params.rb +56 -0
  74. data/lib/openlayer/models/workspaces/api_key_rotate_response.rb +131 -0
  75. data/lib/openlayer/models/workspaces/api_key_update_params.rb +38 -0
  76. data/lib/openlayer/models/workspaces/api_key_update_response.rb +131 -0
  77. data/lib/openlayer/models.rb +4 -0
  78. data/lib/openlayer/resources/background_tasks.rb +34 -0
  79. data/lib/openlayer/resources/commits.rb +1 -1
  80. data/lib/openlayer/resources/governance/frameworks/documents.rb +72 -0
  81. data/lib/openlayer/resources/governance/frameworks/sections.rb +68 -0
  82. data/lib/openlayer/resources/governance/frameworks/subsections.rb +65 -0
  83. data/lib/openlayer/resources/governance/frameworks.rb +292 -0
  84. data/lib/openlayer/resources/governance/rule_results.rb +187 -0
  85. data/lib/openlayer/resources/governance/rule_stats.rb +43 -0
  86. data/lib/openlayer/resources/governance/rule_tags.rb +43 -0
  87. data/lib/openlayer/resources/governance/rules.rb +210 -0
  88. data/lib/openlayer/resources/governance.rb +34 -0
  89. data/lib/openlayer/resources/inference_pipelines/rows.rb +4 -5
  90. data/lib/openlayer/resources/inference_pipelines.rb +5 -14
  91. data/lib/openlayer/resources/projects/tests.rb +3 -3
  92. data/lib/openlayer/resources/storage/presigned_url.rb +27 -1
  93. data/lib/openlayer/resources/tests.rb +1 -4
  94. data/lib/openlayer/resources/workspaces/api_keys.rb +146 -2
  95. data/lib/openlayer/resources/workspaces/invites.rb +1 -1
  96. data/lib/openlayer/resources/workspaces.rb +1 -1
  97. data/lib/openlayer/version.rb +1 -1
  98. data/lib/openlayer.rb +70 -0
  99. data/rbi/openlayer/client.rbi +6 -0
  100. data/rbi/openlayer/models/background_task_retrieve_params.rbi +38 -0
  101. data/rbi/openlayer/models/background_task_retrieve_response.rbi +105 -0
  102. data/rbi/openlayer/models/governance/framework_create_params.rbi +298 -0
  103. data/rbi/openlayer/models/governance/framework_create_response.rbi +735 -0
  104. data/rbi/openlayer/models/governance/framework_export_params.rbi +58 -0
  105. data/rbi/openlayer/models/governance/framework_export_response.rbi +48 -0
  106. data/rbi/openlayer/models/governance/framework_list_params.rbi +310 -0
  107. data/rbi/openlayer/models/governance/framework_list_project_rule_stats_params.rbi +178 -0
  108. data/rbi/openlayer/models/governance/framework_list_project_rule_stats_response.rbi +441 -0
  109. data/rbi/openlayer/models/governance/framework_list_projects_params.rbi +68 -0
  110. data/rbi/openlayer/models/governance/framework_list_projects_response.rbi +498 -0
  111. data/rbi/openlayer/models/governance/framework_list_response.rbi +776 -0
  112. data/rbi/openlayer/models/governance/framework_list_rules_params.rbi +68 -0
  113. data/rbi/openlayer/models/governance/framework_list_rules_response.rbi +1334 -0
  114. data/rbi/openlayer/models/governance/framework_retrieve_params.rbi +40 -0
  115. data/rbi/openlayer/models/governance/framework_retrieve_response.rbi +735 -0
  116. data/rbi/openlayer/models/governance/framework_update_params.rbi +425 -0
  117. data/rbi/openlayer/models/governance/framework_update_response.rbi +735 -0
  118. data/rbi/openlayer/models/governance/frameworks/document_list_params.rbi +70 -0
  119. data/rbi/openlayer/models/governance/frameworks/document_list_response.rbi +1050 -0
  120. data/rbi/openlayer/models/governance/frameworks/document_retrieve_params.rbi +50 -0
  121. data/rbi/openlayer/models/governance/frameworks/document_retrieve_response.rbi +1006 -0
  122. data/rbi/openlayer/models/governance/frameworks/section_list_rules_params.rbi +193 -0
  123. data/rbi/openlayer/models/governance/frameworks/section_list_rules_response.rbi +1338 -0
  124. data/rbi/openlayer/models/governance/frameworks/subsection_list_rules_params.rbi +182 -0
  125. data/rbi/openlayer/models/governance/frameworks/subsection_list_rules_response.rbi +1338 -0
  126. data/rbi/openlayer/models/governance/rule_create_params.rbi +291 -0
  127. data/rbi/openlayer/models/governance/rule_create_response.rbi +1289 -0
  128. data/rbi/openlayer/models/governance/rule_delete_params.rbi +40 -0
  129. data/rbi/openlayer/models/governance/rule_list_params.rbi +486 -0
  130. data/rbi/openlayer/models/governance/rule_list_response.rbi +1330 -0
  131. data/rbi/openlayer/models/governance/rule_result_create_evidence_params.rbi +90 -0
  132. data/rbi/openlayer/models/governance/rule_result_create_evidence_response.rbi +113 -0
  133. data/rbi/openlayer/models/governance/rule_result_list_evidence_params.rbi +68 -0
  134. data/rbi/openlayer/models/governance/rule_result_list_evidence_response.rbi +156 -0
  135. data/rbi/openlayer/models/governance/rule_result_list_params.rbi +322 -0
  136. data/rbi/openlayer/models/governance/rule_result_list_response.rbi +580 -0
  137. data/rbi/openlayer/models/governance/rule_result_retrieve_params.rbi +43 -0
  138. data/rbi/openlayer/models/governance/rule_result_retrieve_response.rbi +537 -0
  139. data/rbi/openlayer/models/governance/rule_result_update_params.rbi +381 -0
  140. data/rbi/openlayer/models/governance/rule_result_update_response.rbi +537 -0
  141. data/rbi/openlayer/models/governance/rule_retrieve_params.rbi +40 -0
  142. data/rbi/openlayer/models/governance/rule_retrieve_response.rbi +1289 -0
  143. data/rbi/openlayer/models/governance/rule_stat_retrieve_params.rbi +68 -0
  144. data/rbi/openlayer/models/governance/rule_stat_retrieve_response.rbi +877 -0
  145. data/rbi/openlayer/models/governance/rule_tag_list_params.rbi +68 -0
  146. data/rbi/openlayer/models/governance/rule_tag_list_response.rbi +141 -0
  147. data/rbi/openlayer/models/governance/rule_update_params.rbi +108 -0
  148. data/rbi/openlayer/models/governance/rule_update_response.rbi +1289 -0
  149. data/rbi/openlayer/models/inference_pipeline_retrieve_response.rbi +0 -5
  150. data/rbi/openlayer/models/inference_pipeline_retrieve_sessions_response.rbi +2 -0
  151. data/rbi/openlayer/models/inference_pipeline_retrieve_users_response.rbi +2 -0
  152. data/rbi/openlayer/models/inference_pipeline_update_response.rbi +0 -5
  153. data/rbi/openlayer/models/project_create_response.rbi +0 -5
  154. data/rbi/openlayer/models/project_list_response.rbi +0 -5
  155. data/rbi/openlayer/models/project_update_response.rbi +0 -5
  156. data/rbi/openlayer/models/projects/inference_pipeline_create_params.rbi +0 -5
  157. data/rbi/openlayer/models/projects/inference_pipeline_create_response.rbi +0 -5
  158. data/rbi/openlayer/models/projects/inference_pipeline_list_response.rbi +0 -5
  159. data/rbi/openlayer/models/storage/presigned_url_retrieve_params.rbi +47 -0
  160. data/rbi/openlayer/models/storage/presigned_url_retrieve_response.rbi +32 -0
  161. data/rbi/openlayer/models/workspaces/api_key_create_params.rbi +18 -0
  162. data/rbi/openlayer/models/workspaces/api_key_create_response.rbi +117 -5
  163. data/rbi/openlayer/models/workspaces/api_key_delete_params.rbi +48 -0
  164. data/rbi/openlayer/models/workspaces/api_key_list_params.rbi +40 -0
  165. data/rbi/openlayer/models/workspaces/api_key_list_response.rbi +202 -0
  166. data/rbi/openlayer/models/workspaces/api_key_retrieve_params.rbi +48 -0
  167. data/rbi/openlayer/models/workspaces/api_key_retrieve_response.rbi +194 -0
  168. data/rbi/openlayer/models/workspaces/api_key_rotate_params.rbi +85 -0
  169. data/rbi/openlayer/models/workspaces/api_key_rotate_response.rbi +194 -0
  170. data/rbi/openlayer/models/workspaces/api_key_update_params.rbi +60 -0
  171. data/rbi/openlayer/models/workspaces/api_key_update_response.rbi +194 -0
  172. data/rbi/openlayer/models.rbi +4 -0
  173. data/rbi/openlayer/resources/background_tasks.rbi +26 -0
  174. data/rbi/openlayer/resources/commits.rbi +1 -1
  175. data/rbi/openlayer/resources/governance/frameworks/documents.rbi +57 -0
  176. data/rbi/openlayer/resources/governance/frameworks/sections.rbi +56 -0
  177. data/rbi/openlayer/resources/governance/frameworks/subsections.rbi +52 -0
  178. data/rbi/openlayer/resources/governance/frameworks.rbi +261 -0
  179. data/rbi/openlayer/resources/governance/rule_results.rbi +167 -0
  180. data/rbi/openlayer/resources/governance/rule_stats.rbi +34 -0
  181. data/rbi/openlayer/resources/governance/rule_tags.rbi +34 -0
  182. data/rbi/openlayer/resources/governance/rules.rbi +209 -0
  183. data/rbi/openlayer/resources/governance.rbi +27 -0
  184. data/rbi/openlayer/resources/inference_pipelines/rows.rbi +4 -5
  185. data/rbi/openlayer/resources/inference_pipelines.rbi +5 -14
  186. data/rbi/openlayer/resources/projects/tests.rbi +3 -3
  187. data/rbi/openlayer/resources/storage/presigned_url.rbi +16 -1
  188. data/rbi/openlayer/resources/tests.rbi +1 -4
  189. data/rbi/openlayer/resources/workspaces/api_keys.rbi +110 -1
  190. data/rbi/openlayer/resources/workspaces/invites.rbi +1 -1
  191. data/rbi/openlayer/resources/workspaces.rbi +1 -1
  192. data/sig/openlayer/client.rbs +4 -0
  193. data/sig/openlayer/models/background_task_retrieve_params.rbs +23 -0
  194. data/sig/openlayer/models/background_task_retrieve_response.rbs +55 -0
  195. data/sig/openlayer/models/governance/framework_create_params.rbs +124 -0
  196. data/sig/openlayer/models/governance/framework_create_response.rbs +293 -0
  197. data/sig/openlayer/models/governance/framework_export_params.rbs +30 -0
  198. data/sig/openlayer/models/governance/framework_export_response.rbs +21 -0
  199. data/sig/openlayer/models/governance/framework_list_params.rbs +145 -0
  200. data/sig/openlayer/models/governance/framework_list_project_rule_stats_params.rbs +87 -0
  201. data/sig/openlayer/models/governance/framework_list_project_rule_stats_response.rbs +232 -0
  202. data/sig/openlayer/models/governance/framework_list_projects_params.rbs +38 -0
  203. data/sig/openlayer/models/governance/framework_list_projects_response.rbs +248 -0
  204. data/sig/openlayer/models/governance/framework_list_response.rbs +314 -0
  205. data/sig/openlayer/models/governance/framework_list_rules_params.rbs +38 -0
  206. data/sig/openlayer/models/governance/framework_list_rules_response.rbs +547 -0
  207. data/sig/openlayer/models/governance/framework_retrieve_params.rbs +25 -0
  208. data/sig/openlayer/models/governance/framework_retrieve_response.rbs +293 -0
  209. data/sig/openlayer/models/governance/framework_update_params.rbs +175 -0
  210. data/sig/openlayer/models/governance/framework_update_response.rbs +293 -0
  211. data/sig/openlayer/models/governance/frameworks/document_list_params.rbs +40 -0
  212. data/sig/openlayer/models/governance/frameworks/document_list_response.rbs +435 -0
  213. data/sig/openlayer/models/governance/frameworks/document_retrieve_params.rbs +32 -0
  214. data/sig/openlayer/models/governance/frameworks/document_retrieve_response.rbs +418 -0
  215. data/sig/openlayer/models/governance/frameworks/section_list_rules_params.rbs +102 -0
  216. data/sig/openlayer/models/governance/frameworks/section_list_rules_response.rbs +549 -0
  217. data/sig/openlayer/models/governance/frameworks/subsection_list_rules_params.rbs +95 -0
  218. data/sig/openlayer/models/governance/frameworks/subsection_list_rules_response.rbs +549 -0
  219. data/sig/openlayer/models/governance/rule_create_params.rbs +120 -0
  220. data/sig/openlayer/models/governance/rule_create_response.rbs +530 -0
  221. data/sig/openlayer/models/governance/rule_delete_params.rbs +25 -0
  222. data/sig/openlayer/models/governance/rule_list_params.rbs +228 -0
  223. data/sig/openlayer/models/governance/rule_list_response.rbs +547 -0
  224. data/sig/openlayer/models/governance/rule_result_create_evidence_params.rbs +53 -0
  225. data/sig/openlayer/models/governance/rule_result_create_evidence_response.rbs +62 -0
  226. data/sig/openlayer/models/governance/rule_result_list_evidence_params.rbs +38 -0
  227. data/sig/openlayer/models/governance/rule_result_list_evidence_response.rbs +79 -0
  228. data/sig/openlayer/models/governance/rule_result_list_params.rbs +156 -0
  229. data/sig/openlayer/models/governance/rule_result_list_response.rbs +252 -0
  230. data/sig/openlayer/models/governance/rule_result_retrieve_params.rbs +26 -0
  231. data/sig/openlayer/models/governance/rule_result_retrieve_response.rbs +235 -0
  232. data/sig/openlayer/models/governance/rule_result_update_params.rbs +165 -0
  233. data/sig/openlayer/models/governance/rule_result_update_response.rbs +235 -0
  234. data/sig/openlayer/models/governance/rule_retrieve_params.rbs +25 -0
  235. data/sig/openlayer/models/governance/rule_retrieve_response.rbs +530 -0
  236. data/sig/openlayer/models/governance/rule_stat_retrieve_params.rbs +38 -0
  237. data/sig/openlayer/models/governance/rule_stat_retrieve_response.rbs +434 -0
  238. data/sig/openlayer/models/governance/rule_tag_list_params.rbs +38 -0
  239. data/sig/openlayer/models/governance/rule_tag_list_response.rbs +74 -0
  240. data/sig/openlayer/models/governance/rule_update_params.rbs +62 -0
  241. data/sig/openlayer/models/governance/rule_update_response.rbs +530 -0
  242. data/sig/openlayer/models/inference_pipeline_retrieve_response.rbs +1 -2
  243. data/sig/openlayer/models/inference_pipeline_update_response.rbs +1 -2
  244. data/sig/openlayer/models/project_create_response.rbs +1 -2
  245. data/sig/openlayer/models/project_list_response.rbs +1 -2
  246. data/sig/openlayer/models/project_update_response.rbs +1 -2
  247. data/sig/openlayer/models/projects/inference_pipeline_create_params.rbs +1 -2
  248. data/sig/openlayer/models/projects/inference_pipeline_create_response.rbs +1 -2
  249. data/sig/openlayer/models/projects/inference_pipeline_list_response.rbs +1 -2
  250. data/sig/openlayer/models/storage/presigned_url_retrieve_params.rbs +25 -0
  251. data/sig/openlayer/models/storage/presigned_url_retrieve_response.rbs +15 -0
  252. data/sig/openlayer/models/workspaces/api_key_create_params.rbs +5 -1
  253. data/sig/openlayer/models/workspaces/api_key_create_response.rbs +42 -3
  254. data/sig/openlayer/models/workspaces/api_key_delete_params.rbs +30 -0
  255. data/sig/openlayer/models/workspaces/api_key_list_params.rbs +25 -0
  256. data/sig/openlayer/models/workspaces/api_key_list_response.rbs +91 -0
  257. data/sig/openlayer/models/workspaces/api_key_retrieve_params.rbs +30 -0
  258. data/sig/openlayer/models/workspaces/api_key_retrieve_response.rbs +86 -0
  259. data/sig/openlayer/models/workspaces/api_key_rotate_params.rbs +45 -0
  260. data/sig/openlayer/models/workspaces/api_key_rotate_response.rbs +86 -0
  261. data/sig/openlayer/models/workspaces/api_key_update_params.rbs +34 -0
  262. data/sig/openlayer/models/workspaces/api_key_update_response.rbs +86 -0
  263. data/sig/openlayer/models.rbs +4 -0
  264. data/sig/openlayer/resources/background_tasks.rbs +12 -0
  265. data/sig/openlayer/resources/governance/frameworks/documents.rbs +24 -0
  266. data/sig/openlayer/resources/governance/frameworks/sections.rbs +23 -0
  267. data/sig/openlayer/resources/governance/frameworks/subsections.rbs +22 -0
  268. data/sig/openlayer/resources/governance/frameworks.rbs +88 -0
  269. data/sig/openlayer/resources/governance/rule_results.rbs +57 -0
  270. data/sig/openlayer/resources/governance/rule_stats.rbs +16 -0
  271. data/sig/openlayer/resources/governance/rule_tags.rbs +16 -0
  272. data/sig/openlayer/resources/governance/rules.rbs +68 -0
  273. data/sig/openlayer/resources/governance.rbs +17 -0
  274. data/sig/openlayer/resources/storage/presigned_url.rbs +5 -0
  275. data/sig/openlayer/resources/workspaces/api_keys.rbs +33 -0
  276. metadata +212 -2
@@ -0,0 +1,696 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Openlayer
4
+ module Models
5
+ module Governance
6
+ # @see Openlayer::Resources::Governance::Frameworks#list_rules
7
+ class FrameworkListRulesResponse < Openlayer::Internal::Type::BaseModel
8
+ # @!attribute items
9
+ #
10
+ # @return [Array<Openlayer::Models::Governance::FrameworkListRulesResponse::Item>]
11
+ required :items,
12
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::FrameworkListRulesResponse::Item] }
13
+
14
+ # @!method initialize(items:)
15
+ # @param items [Array<Openlayer::Models::Governance::FrameworkListRulesResponse::Item>]
16
+
17
+ class Item < Openlayer::Internal::Type::BaseModel
18
+ # @!attribute name
19
+ # The rule name.
20
+ #
21
+ # @return [String]
22
+ required :name, String
23
+
24
+ # @!attribute scope
25
+ # Whether the rule is evaluated once for the whole workspace, or once per project
26
+ # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
27
+ # the rule is created.
28
+ #
29
+ # @return [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Scope]
30
+ required :scope, enum: -> { Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Scope }
31
+
32
+ # @!attribute type
33
+ # `platform` rules are evaluated automatically from the state of your Openlayer
34
+ # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
35
+ # rule is created.
36
+ #
37
+ # @return [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Type]
38
+ required :type, enum: -> { Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Type }
39
+
40
+ # @!attribute assignee_id
41
+ # The user responsible for satisfying the rule.
42
+ #
43
+ # @return [String, nil]
44
+ optional :assignee_id, String, api_name: :assigneeId, nil?: true
45
+
46
+ # @!attribute automation_params
47
+ # Configuration for the platform check, when the automation takes parameters. Omit
48
+ # or `null` for evidence rules. Fixed once the rule is created.
49
+ #
50
+ # @return [Hash{Symbol=>Object}, nil]
51
+ optional :automation_params,
52
+ Openlayer::Internal::Type::HashOf[Openlayer::Internal::Type::Unknown],
53
+ api_name: :automationParams,
54
+ nil?: true
55
+
56
+ # @!attribute automation_type
57
+ # Which workspace signal a platform rule checks, for example
58
+ # `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. Set it for
59
+ # platform rules; omit or `null` for evidence rules. Fixed once the rule is
60
+ # created.
61
+ #
62
+ # @return [String, nil]
63
+ optional :automation_type, String, api_name: :automationType, nil?: true
64
+
65
+ # @!attribute deactivated
66
+ # Whether the rule is excluded from compliance calculations.
67
+ #
68
+ # @return [Boolean, nil]
69
+ optional :deactivated, Openlayer::Internal::Type::Boolean
70
+
71
+ # @!attribute description
72
+ # What the rule requires.
73
+ #
74
+ # @return [String, nil]
75
+ optional :description, String, nil?: true
76
+
77
+ # @!attribute evidence_type
78
+ # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
79
+ # `null` for platform rules. Fixed once the rule is created.
80
+ #
81
+ # @return [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::EvidenceType, nil]
82
+ optional :evidence_type,
83
+ enum: -> { Openlayer::Models::Governance::FrameworkListRulesResponse::Item::EvidenceType },
84
+ api_name: :evidenceType,
85
+ nil?: true
86
+
87
+ # @!attribute renewal_cadence_days
88
+ # How often evidence must be renewed, in days. Once evidence is older than this,
89
+ # the rule result becomes `due_soon` and then `failing`. The window restarts
90
+ # whenever evidence is attached. Omit or `null` for platform rules.
91
+ #
92
+ # @return [Integer, nil]
93
+ optional :renewal_cadence_days, Integer, api_name: :renewalCadenceDays, nil?: true
94
+
95
+ response_only do
96
+ # @!attribute id
97
+ # The rule id.
98
+ #
99
+ # @return [String]
100
+ required :id, String
101
+
102
+ # @!attribute date_created
103
+ # The creation date.
104
+ #
105
+ # @return [Time]
106
+ required :date_created, Time, api_name: :dateCreated
107
+
108
+ # @!attribute date_updated
109
+ # The last update date.
110
+ #
111
+ # @return [Time]
112
+ required :date_updated, Time, api_name: :dateUpdated
113
+
114
+ # @!attribute workspace_id
115
+ # The id of the workspace the rule belongs to.
116
+ #
117
+ # @return [String]
118
+ required :workspace_id, String, api_name: :workspaceId
119
+
120
+ # @!attribute frameworks
121
+ # The frameworks that include this rule.
122
+ #
123
+ # @return [Array<Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Framework>, nil]
124
+ optional :frameworks,
125
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Framework] }
126
+
127
+ # @!attribute immutable
128
+ # Whether the rule is managed by Openlayer. These rules can't be renamed or
129
+ # deleted; set `deactivated` to exclude one from compliance instead.
130
+ #
131
+ # @return [Boolean, nil]
132
+ optional :immutable, Openlayer::Internal::Type::Boolean
133
+
134
+ # @!attribute results
135
+ # The rule's results, one per entity the rule is evaluated against. Only returned
136
+ # when `includeResults` is `true`.
137
+ #
138
+ # @return [Array<Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result>, nil]
139
+ optional :results,
140
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result] }
141
+
142
+ # @!attribute results_summary
143
+ # Pass-rate counts across all of the rule's entities, independent of any status
144
+ # filter applied to the request.
145
+ #
146
+ # @return [Openlayer::Models::Governance::FrameworkListRulesResponse::Item::ResultsSummary, nil]
147
+ optional :results_summary,
148
+ -> { Openlayer::Models::Governance::FrameworkListRulesResponse::Item::ResultsSummary },
149
+ api_name: :resultsSummary,
150
+ nil?: true
151
+
152
+ # @!attribute tags
153
+ # The rule tags associated with the rule.
154
+ #
155
+ # @return [Array<Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Tag>, nil]
156
+ optional :tags,
157
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Tag] },
158
+ nil?: true
159
+ end
160
+
161
+ # @!method initialize(id:, date_created:, date_updated:, name:, scope:, type:, workspace_id:, assignee_id: nil, automation_params: nil, automation_type: nil, deactivated: nil, description: nil, evidence_type: nil, frameworks: nil, immutable: nil, renewal_cadence_days: nil, results: nil, results_summary: nil, tags: nil)
162
+ # Some parameter documentations has been truncated, see
163
+ # {Openlayer::Models::Governance::FrameworkListRulesResponse::Item} for more
164
+ # details.
165
+ #
166
+ # A single requirement Openlayer tracks. `platform` rules are evaluated
167
+ # automatically from the state of your workspace, and `evidence` rules are
168
+ # satisfied by attaching evidence. A rule can belong to several frameworks, or to
169
+ # none.
170
+ #
171
+ # @param id [String] The rule id.
172
+ #
173
+ # @param date_created [Time] The creation date.
174
+ #
175
+ # @param date_updated [Time] The last update date.
176
+ #
177
+ # @param name [String] The rule name.
178
+ #
179
+ # @param scope [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Scope] Whether the rule is evaluated once for the whole workspace, or once per project
180
+ #
181
+ # @param type [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Type] `platform` rules are evaluated automatically from the state of your Openlayer wo
182
+ #
183
+ # @param workspace_id [String] The id of the workspace the rule belongs to.
184
+ #
185
+ # @param assignee_id [String, nil] The user responsible for satisfying the rule.
186
+ #
187
+ # @param automation_params [Hash{Symbol=>Object}, nil] Configuration for the platform check, when the automation takes parameters. Omit
188
+ #
189
+ # @param automation_type [String, nil] Which workspace signal a platform rule checks, for example `monitoring_mode_enab
190
+ #
191
+ # @param deactivated [Boolean] Whether the rule is excluded from compliance calculations.
192
+ #
193
+ # @param description [String, nil] What the rule requires.
194
+ #
195
+ # @param evidence_type [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::EvidenceType, nil] The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
196
+ #
197
+ # @param frameworks [Array<Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Framework>] The frameworks that include this rule.
198
+ #
199
+ # @param immutable [Boolean] Whether the rule is managed by Openlayer. These rules can't be renamed or delete
200
+ #
201
+ # @param renewal_cadence_days [Integer, nil] How often evidence must be renewed, in days. Once evidence is older than this, t
202
+ #
203
+ # @param results [Array<Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result>] The rule's results, one per entity the rule is evaluated against. Only returned
204
+ #
205
+ # @param results_summary [Openlayer::Models::Governance::FrameworkListRulesResponse::Item::ResultsSummary, nil] Pass-rate counts across all of the rule's entities, independent of any status fi
206
+ #
207
+ # @param tags [Array<Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Tag>, nil] The rule tags associated with the rule.
208
+
209
+ # Whether the rule is evaluated once for the whole workspace, or once per project
210
+ # the rule's frameworks apply to. Must be `project` for platform rules. Fixed once
211
+ # the rule is created.
212
+ #
213
+ # @see Openlayer::Models::Governance::FrameworkListRulesResponse::Item#scope
214
+ module Scope
215
+ extend Openlayer::Internal::Type::Enum
216
+
217
+ PROJECT = :project
218
+ WORKSPACE = :workspace
219
+
220
+ # @!method self.values
221
+ # @return [Array<Symbol>]
222
+ end
223
+
224
+ # `platform` rules are evaluated automatically from the state of your Openlayer
225
+ # workspace. `evidence` rules are satisfied by attaching evidence. Fixed once the
226
+ # rule is created.
227
+ #
228
+ # @see Openlayer::Models::Governance::FrameworkListRulesResponse::Item#type
229
+ module Type
230
+ extend Openlayer::Internal::Type::Enum
231
+
232
+ PLATFORM = :platform
233
+ EVIDENCE = :evidence
234
+
235
+ # @!method self.values
236
+ # @return [Array<Symbol>]
237
+ end
238
+
239
+ # The kind of evidence that satisfies the rule. Set it for evidence rules; omit or
240
+ # `null` for platform rules. Fixed once the rule is created.
241
+ #
242
+ # @see Openlayer::Models::Governance::FrameworkListRulesResponse::Item#evidence_type
243
+ module EvidenceType
244
+ extend Openlayer::Internal::Type::Enum
245
+
246
+ DOCUMENT = :document
247
+ TEXT = :text
248
+ URL = :url
249
+ CATEGORY_VALUE = :categoryValue
250
+
251
+ # @!method self.values
252
+ # @return [Array<Symbol>]
253
+ end
254
+
255
+ class Framework < Openlayer::Internal::Type::BaseModel
256
+ # @!attribute avatar
257
+ # The icon shown for the framework.
258
+ #
259
+ # @return [Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Framework::Avatar, nil]
260
+ required :avatar,
261
+ -> { Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Framework::Avatar },
262
+ nil?: true
263
+
264
+ # @!attribute built_in_slug
265
+ # Identifies a framework that ships with Openlayer, for example `eu_ai_act`,
266
+ # `iso_42001`, `nist_ai_rmf`, or `traiga`. `null` for frameworks you create
267
+ # yourself.
268
+ #
269
+ # @return [String, nil]
270
+ required :built_in_slug, String, api_name: :builtInSlug, nil?: true
271
+
272
+ # @!attribute enabled
273
+ # Whether the framework is active. Rules of a disabled framework are not evaluated
274
+ # and do not count towards compliance.
275
+ #
276
+ # @return [Boolean]
277
+ required :enabled, Openlayer::Internal::Type::Boolean
278
+
279
+ # @!attribute name
280
+ # The framework name.
281
+ #
282
+ # @return [String]
283
+ required :name, String
284
+
285
+ response_only do
286
+ # @!attribute id
287
+ # The framework id.
288
+ #
289
+ # @return [String]
290
+ required :id, String
291
+ end
292
+
293
+ # @!method initialize(id:, avatar:, built_in_slug:, enabled:, name:)
294
+ # Some parameter documentations has been truncated, see
295
+ # {Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Framework} for
296
+ # more details.
297
+ #
298
+ # @param id [String] The framework id.
299
+ #
300
+ # @param avatar [Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Framework::Avatar, nil] The icon shown for the framework.
301
+ #
302
+ # @param built_in_slug [String, nil] Identifies a framework that ships with Openlayer, for example `eu_ai_act`,
303
+ # `iso\_
304
+ #
305
+ # @param enabled [Boolean] Whether the framework is active. Rules of a disabled framework are not evaluated
306
+ #
307
+ # @param name [String] The framework name.
308
+
309
+ # @see Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Framework#avatar
310
+ class Avatar < Openlayer::Internal::Type::BaseModel
311
+ # @!attribute type
312
+ #
313
+ # @return [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Framework::Avatar::Type]
314
+ required :type,
315
+ enum: -> { Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Framework::Avatar::Type }
316
+
317
+ # @!attribute value
318
+ #
319
+ # @return [String]
320
+ required :value, String
321
+
322
+ # @!method initialize(type:, value:)
323
+ # The icon shown for the framework.
324
+ #
325
+ # @param type [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Framework::Avatar::Type]
326
+ # @param value [String]
327
+
328
+ # @see Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Framework::Avatar#type
329
+ module Type
330
+ extend Openlayer::Internal::Type::Enum
331
+
332
+ EMOJI = :emoji
333
+ IMAGE_URL = :imageUrl
334
+ BUILTIN_IMAGE = :builtinImage
335
+
336
+ # @!method self.values
337
+ # @return [Array<Symbol>]
338
+ end
339
+ end
340
+ end
341
+
342
+ class Result < Openlayer::Internal::Type::BaseModel
343
+ # @!attribute deactivated
344
+ # Whether this result is excluded from compliance calculations. Excludes just this
345
+ # result, without deactivating the rule everywhere.
346
+ #
347
+ # @return [Boolean]
348
+ required :deactivated, Openlayer::Internal::Type::Boolean
349
+
350
+ # @!attribute status
351
+ # The compliance status of the rule for this entity. Computed by Openlayer and
352
+ # can't be set directly.
353
+ #
354
+ # @return [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Status]
355
+ required :status,
356
+ enum: -> { Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Status }
357
+
358
+ # @!attribute assignee_id
359
+ # The user responsible for this result.
360
+ #
361
+ # @return [String, nil]
362
+ optional :assignee_id, String, api_name: :assigneeId, nil?: true
363
+
364
+ # @!attribute blocked_by
365
+ # Rule results that must pass before this one can be satisfied.
366
+ #
367
+ # @return [Array<Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::BlockedBy>, nil]
368
+ optional :blocked_by,
369
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::BlockedBy] },
370
+ api_name: :blockedBy
371
+
372
+ # @!attribute blocking
373
+ # Rule results that this one blocks.
374
+ #
375
+ # @return [Array<Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Blocking>, nil]
376
+ optional :blocking,
377
+ -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Blocking] }
378
+
379
+ # @!attribute deactivated_reason
380
+ # Why the result was excluded. Required when setting `deactivated` to `true`.
381
+ #
382
+ # @return [String, nil]
383
+ optional :deactivated_reason, String, api_name: :deactivatedReason, nil?: true
384
+
385
+ # @!attribute status_message
386
+ # A human-readable explanation of the status.
387
+ #
388
+ # @return [String, nil]
389
+ optional :status_message, String, api_name: :statusMessage, nil?: true
390
+
391
+ response_only do
392
+ # @!attribute id
393
+ # The rule result id.
394
+ #
395
+ # @return [String]
396
+ required :id, String
397
+
398
+ # @!attribute date_created
399
+ # The creation date.
400
+ #
401
+ # @return [Time]
402
+ required :date_created, Time, api_name: :dateCreated
403
+
404
+ # @!attribute date_updated
405
+ # The last update date.
406
+ #
407
+ # @return [Time]
408
+ required :date_updated, Time, api_name: :dateUpdated
409
+
410
+ # @!attribute rule_id
411
+ # The rule this result belongs to.
412
+ #
413
+ # @return [String]
414
+ required :rule_id, String, api_name: :ruleId
415
+
416
+ # @!attribute workspace_id
417
+ # The id of the workspace the rule result belongs to.
418
+ #
419
+ # @return [String]
420
+ required :workspace_id, String, api_name: :workspaceId
421
+
422
+ # @!attribute date_last_evaluated
423
+ # When the rule was last evaluated. Platform rules only.
424
+ #
425
+ # @return [Time, nil]
426
+ optional :date_last_evaluated, Time, api_name: :dateLastEvaluated, nil?: true
427
+
428
+ # @!attribute date_of_latest_evidence
429
+ # When the most recent piece of evidence was attached. Evidence rules only.
430
+ #
431
+ # @return [Time, nil]
432
+ optional :date_of_latest_evidence, Time, api_name: :dateOfLatestEvidence, nil?: true
433
+
434
+ # @!attribute date_of_next_evaluation
435
+ # When the rule will next be evaluated. Platform rules only.
436
+ #
437
+ # @return [Time, nil]
438
+ optional :date_of_next_evaluation, Time, api_name: :dateOfNextEvaluation, nil?: true
439
+
440
+ # @!attribute date_of_renewal
441
+ # When the evidence must be renewed. Evidence rules with a renewal cadence only.
442
+ #
443
+ # @return [Time, nil]
444
+ optional :date_of_renewal, Time, api_name: :dateOfRenewal, nil?: true
445
+
446
+ # @!attribute project_id
447
+ # The project this result was evaluated for. `null` for workspace-scoped rules.
448
+ #
449
+ # @return [String, nil]
450
+ optional :project_id, String, api_name: :projectId, nil?: true
451
+ end
452
+
453
+ # @!method initialize(id:, date_created:, date_updated:, deactivated:, rule_id:, status:, workspace_id:, assignee_id: nil, blocked_by: nil, blocking: nil, date_last_evaluated: nil, date_of_latest_evidence: nil, date_of_next_evaluation: nil, date_of_renewal: nil, deactivated_reason: nil, project_id: nil, status_message: nil)
454
+ # Some parameter documentations has been truncated, see
455
+ # {Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result} for
456
+ # more details.
457
+ #
458
+ # The compliance status of one rule for one entity: a project for project-scoped
459
+ # rules, or the workspace for workspace-scoped rules.
460
+ #
461
+ # @param id [String] The rule result id.
462
+ #
463
+ # @param date_created [Time] The creation date.
464
+ #
465
+ # @param date_updated [Time] The last update date.
466
+ #
467
+ # @param deactivated [Boolean] Whether this result is excluded from compliance calculations. Excludes just this
468
+ #
469
+ # @param rule_id [String] The rule this result belongs to.
470
+ #
471
+ # @param status [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Status] The compliance status of the rule for this entity. Computed by Openlayer and can
472
+ #
473
+ # @param workspace_id [String] The id of the workspace the rule result belongs to.
474
+ #
475
+ # @param assignee_id [String, nil] The user responsible for this result.
476
+ #
477
+ # @param blocked_by [Array<Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::BlockedBy>] Rule results that must pass before this one can be satisfied.
478
+ #
479
+ # @param blocking [Array<Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Blocking>] Rule results that this one blocks.
480
+ #
481
+ # @param date_last_evaluated [Time, nil] When the rule was last evaluated. Platform rules only.
482
+ #
483
+ # @param date_of_latest_evidence [Time, nil] When the most recent piece of evidence was attached. Evidence rules only.
484
+ #
485
+ # @param date_of_next_evaluation [Time, nil] When the rule will next be evaluated. Platform rules only.
486
+ #
487
+ # @param date_of_renewal [Time, nil] When the evidence must be renewed. Evidence rules with a renewal cadence only.
488
+ #
489
+ # @param deactivated_reason [String, nil] Why the result was excluded. Required when setting `deactivated` to `true`.
490
+ #
491
+ # @param project_id [String, nil] The project this result was evaluated for. `null` for workspace-scoped rules.
492
+ #
493
+ # @param status_message [String, nil] A human-readable explanation of the status.
494
+
495
+ # The compliance status of the rule for this entity. Computed by Openlayer and
496
+ # can't be set directly.
497
+ #
498
+ # @see Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result#status
499
+ module Status
500
+ extend Openlayer::Internal::Type::Enum
501
+
502
+ RUNNING = :running
503
+ PASSING = :passing
504
+ FAILING = :failing
505
+ SKIPPED = :skipped
506
+ ERROR = :error
507
+ PENDING = :pending
508
+ DUE_SOON = :due_soon
509
+
510
+ # @!method self.values
511
+ # @return [Array<Symbol>]
512
+ end
513
+
514
+ class BlockedBy < Openlayer::Internal::Type::BaseModel
515
+ # @!attribute id
516
+ #
517
+ # @return [String, nil]
518
+ optional :id, String
519
+
520
+ # @!attribute status
521
+ # The compliance status of the rule for this entity. Computed by Openlayer and
522
+ # can't be set directly.
523
+ #
524
+ # @return [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::BlockedBy::Status, nil]
525
+ optional :status,
526
+ enum: -> { Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::BlockedBy::Status }
527
+
528
+ # @!method initialize(id: nil, status: nil)
529
+ # Some parameter documentations has been truncated, see
530
+ # {Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::BlockedBy}
531
+ # for more details.
532
+ #
533
+ # @param id [String]
534
+ #
535
+ # @param status [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::BlockedBy::Status] The compliance status of the rule for this entity. Computed by Openlayer and can
536
+
537
+ # The compliance status of the rule for this entity. Computed by Openlayer and
538
+ # can't be set directly.
539
+ #
540
+ # @see Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::BlockedBy#status
541
+ module Status
542
+ extend Openlayer::Internal::Type::Enum
543
+
544
+ RUNNING = :running
545
+ PASSING = :passing
546
+ FAILING = :failing
547
+ SKIPPED = :skipped
548
+ ERROR = :error
549
+ PENDING = :pending
550
+ DUE_SOON = :due_soon
551
+
552
+ # @!method self.values
553
+ # @return [Array<Symbol>]
554
+ end
555
+ end
556
+
557
+ class Blocking < Openlayer::Internal::Type::BaseModel
558
+ # @!attribute id
559
+ #
560
+ # @return [String, nil]
561
+ optional :id, String
562
+
563
+ # @!attribute status
564
+ # The compliance status of the rule for this entity. Computed by Openlayer and
565
+ # can't be set directly.
566
+ #
567
+ # @return [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Blocking::Status, nil]
568
+ optional :status,
569
+ enum: -> { Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Blocking::Status }
570
+
571
+ # @!method initialize(id: nil, status: nil)
572
+ # Some parameter documentations has been truncated, see
573
+ # {Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Blocking}
574
+ # for more details.
575
+ #
576
+ # @param id [String]
577
+ #
578
+ # @param status [Symbol, Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Blocking::Status] The compliance status of the rule for this entity. Computed by Openlayer and can
579
+
580
+ # The compliance status of the rule for this entity. Computed by Openlayer and
581
+ # can't be set directly.
582
+ #
583
+ # @see Openlayer::Models::Governance::FrameworkListRulesResponse::Item::Result::Blocking#status
584
+ module Status
585
+ extend Openlayer::Internal::Type::Enum
586
+
587
+ RUNNING = :running
588
+ PASSING = :passing
589
+ FAILING = :failing
590
+ SKIPPED = :skipped
591
+ ERROR = :error
592
+ PENDING = :pending
593
+ DUE_SOON = :due_soon
594
+
595
+ # @!method self.values
596
+ # @return [Array<Symbol>]
597
+ end
598
+ end
599
+ end
600
+
601
+ # @see Openlayer::Models::Governance::FrameworkListRulesResponse::Item#results_summary
602
+ class ResultsSummary < Openlayer::Internal::Type::BaseModel
603
+ # @!attribute passing
604
+ #
605
+ # @return [Integer, nil]
606
+ optional :passing, Integer
607
+
608
+ # @!attribute total
609
+ #
610
+ # @return [Integer, nil]
611
+ optional :total, Integer
612
+
613
+ # @!method initialize(passing: nil, total: nil)
614
+ # Pass-rate counts across all of the rule's entities, independent of any status
615
+ # filter applied to the request.
616
+ #
617
+ # @param passing [Integer]
618
+ # @param total [Integer]
619
+ end
620
+
621
+ class Tag < Openlayer::Internal::Type::BaseModel
622
+ # @!attribute name
623
+ # The tag name.
624
+ #
625
+ # @return [String]
626
+ required :name, String
627
+
628
+ # @!attribute color
629
+ # The color the tag is displayed with.
630
+ #
631
+ # @return [String, nil]
632
+ optional :color, String, nil?: true
633
+
634
+ response_only do
635
+ # @!attribute id
636
+ # The rule tag id.
637
+ #
638
+ # @return [String]
639
+ required :id, String
640
+
641
+ # @!attribute creator_id
642
+ # The user who created the tag. `null` for tags that ship with Openlayer.
643
+ #
644
+ # @return [String, nil]
645
+ required :creator_id, String, api_name: :creatorId, nil?: true
646
+
647
+ # @!attribute date_created
648
+ # The creation date.
649
+ #
650
+ # @return [Time]
651
+ required :date_created, Time, api_name: :dateCreated
652
+
653
+ # @!attribute date_updated
654
+ # The last update date.
655
+ #
656
+ # @return [Time]
657
+ required :date_updated, Time, api_name: :dateUpdated
658
+
659
+ # @!attribute immutable
660
+ # Whether the tag is managed by Openlayer. These tags can't be deleted.
661
+ #
662
+ # @return [Boolean]
663
+ required :immutable, Openlayer::Internal::Type::Boolean
664
+
665
+ # @!attribute workspace_id
666
+ # The id of the workspace the tag belongs to.
667
+ #
668
+ # @return [String]
669
+ required :workspace_id, String, api_name: :workspaceId
670
+ end
671
+
672
+ # @!method initialize(id:, creator_id:, date_created:, date_updated:, immutable:, name:, workspace_id:, color: nil)
673
+ # A label that groups rules across frameworks, for example by team or control
674
+ # family.
675
+ #
676
+ # @param id [String] The rule tag id.
677
+ #
678
+ # @param creator_id [String, nil] The user who created the tag. `null` for tags that ship with Openlayer.
679
+ #
680
+ # @param date_created [Time] The creation date.
681
+ #
682
+ # @param date_updated [Time] The last update date.
683
+ #
684
+ # @param immutable [Boolean] Whether the tag is managed by Openlayer. These tags can't be deleted.
685
+ #
686
+ # @param name [String] The tag name.
687
+ #
688
+ # @param workspace_id [String] The id of the workspace the tag belongs to.
689
+ #
690
+ # @param color [String, nil] The color the tag is displayed with.
691
+ end
692
+ end
693
+ end
694
+ end
695
+ end
696
+ end