openlayer 0.15.0 → 0.16.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +21 -0
- data/README.md +1 -1
- data/lib/openlayer/client.rb +8 -0
- data/lib/openlayer/models/background_task_retrieve_params.rb +20 -0
- data/lib/openlayer/models/background_task_retrieve_response.rb +81 -0
- data/lib/openlayer/models/governance/framework_create_params.rb +143 -0
- data/lib/openlayer/models/governance/framework_create_response.rb +407 -0
- data/lib/openlayer/models/governance/framework_export_params.rb +31 -0
- data/lib/openlayer/models/governance/framework_export_response.rb +32 -0
- data/lib/openlayer/models/governance/framework_list_params.rb +148 -0
- data/lib/openlayer/models/governance/framework_list_project_rule_stats_params.rb +74 -0
- data/lib/openlayer/models/governance/framework_list_project_rule_stats_response.rb +277 -0
- data/lib/openlayer/models/governance/framework_list_projects_params.rb +39 -0
- data/lib/openlayer/models/governance/framework_list_projects_response.rb +315 -0
- data/lib/openlayer/models/governance/framework_list_response.rb +418 -0
- data/lib/openlayer/models/governance/framework_list_rules_params.rb +39 -0
- data/lib/openlayer/models/governance/framework_list_rules_response.rb +656 -0
- data/lib/openlayer/models/governance/framework_retrieve_params.rb +22 -0
- data/lib/openlayer/models/governance/framework_retrieve_response.rb +407 -0
- data/lib/openlayer/models/governance/framework_update_params.rb +200 -0
- data/lib/openlayer/models/governance/framework_update_response.rb +407 -0
- data/lib/openlayer/models/governance/frameworks/document_list_params.rb +41 -0
- data/lib/openlayer/models/governance/frameworks/document_list_response.rb +572 -0
- data/lib/openlayer/models/governance/frameworks/document_retrieve_params.rb +30 -0
- data/lib/openlayer/models/governance/frameworks/document_retrieve_response.rb +561 -0
- data/lib/openlayer/models/governance/frameworks/section_list_rules_params.rb +96 -0
- data/lib/openlayer/models/governance/frameworks/section_list_rules_response.rb +660 -0
- data/lib/openlayer/models/governance/frameworks/subsection_list_rules_params.rb +88 -0
- data/lib/openlayer/models/governance/frameworks/subsection_list_rules_response.rb +660 -0
- data/lib/openlayer/models/governance/rule_create_params.rb +164 -0
- data/lib/openlayer/models/governance/rule_create_response.rb +638 -0
- data/lib/openlayer/models/governance/rule_delete_params.rb +22 -0
- data/lib/openlayer/models/governance/rule_list_params.rb +231 -0
- data/lib/openlayer/models/governance/rule_list_response.rb +654 -0
- data/lib/openlayer/models/governance/rule_result_create_evidence_params.rb +68 -0
- data/lib/openlayer/models/governance/rule_result_create_evidence_response.rb +90 -0
- data/lib/openlayer/models/governance/rule_result_list_evidence_params.rb +39 -0
- data/lib/openlayer/models/governance/rule_result_list_evidence_response.rb +101 -0
- data/lib/openlayer/models/governance/rule_result_list_params.rb +149 -0
- data/lib/openlayer/models/governance/rule_result_list_response.rb +255 -0
- data/lib/openlayer/models/governance/rule_result_retrieve_params.rb +22 -0
- data/lib/openlayer/models/governance/rule_result_retrieve_response.rb +243 -0
- data/lib/openlayer/models/governance/rule_result_update_params.rb +140 -0
- data/lib/openlayer/models/governance/rule_result_update_response.rb +242 -0
- data/lib/openlayer/models/governance/rule_retrieve_params.rb +22 -0
- data/lib/openlayer/models/governance/rule_retrieve_response.rb +642 -0
- data/lib/openlayer/models/governance/rule_stat_retrieve_params.rb +39 -0
- data/lib/openlayer/models/governance/rule_stat_retrieve_response.rb +504 -0
- data/lib/openlayer/models/governance/rule_tag_list_params.rb +39 -0
- data/lib/openlayer/models/governance/rule_tag_list_response.rb +88 -0
- data/lib/openlayer/models/governance/rule_update_params.rb +77 -0
- data/lib/openlayer/models/governance/rule_update_response.rb +638 -0
- data/lib/openlayer/models/inference_pipeline_retrieve_response.rb +0 -1
- data/lib/openlayer/models/inference_pipeline_update_response.rb +0 -1
- data/lib/openlayer/models/project_create_response.rb +0 -1
- data/lib/openlayer/models/project_list_response.rb +0 -1
- data/lib/openlayer/models/project_update_response.rb +0 -1
- data/lib/openlayer/models/projects/inference_pipeline_create_params.rb +0 -1
- data/lib/openlayer/models/projects/inference_pipeline_create_response.rb +0 -1
- data/lib/openlayer/models/projects/inference_pipeline_list_response.rb +0 -1
- data/lib/openlayer/models/storage/presigned_url_retrieve_params.rb +24 -0
- data/lib/openlayer/models/storage/presigned_url_retrieve_response.rb +19 -0
- data/lib/openlayer/models.rb +4 -0
- data/lib/openlayer/resources/background_tasks.rb +38 -0
- data/lib/openlayer/resources/governance/frameworks/documents.rb +80 -0
- data/lib/openlayer/resources/governance/frameworks/sections.rb +72 -0
- data/lib/openlayer/resources/governance/frameworks/subsections.rb +69 -0
- data/lib/openlayer/resources/governance/frameworks.rb +344 -0
- data/lib/openlayer/resources/governance/rule_results.rb +212 -0
- data/lib/openlayer/resources/governance/rule_stats.rb +47 -0
- data/lib/openlayer/resources/governance/rule_tags.rb +47 -0
- data/lib/openlayer/resources/governance/rules.rb +241 -0
- data/lib/openlayer/resources/governance.rb +34 -0
- data/lib/openlayer/resources/storage/presigned_url.rb +32 -0
- data/lib/openlayer/version.rb +1 -1
- data/lib/openlayer.rb +61 -0
- data/rbi/openlayer/client.rbi +6 -0
- data/rbi/openlayer/models/background_task_retrieve_params.rbi +38 -0
- data/rbi/openlayer/models/background_task_retrieve_response.rbi +102 -0
- data/rbi/openlayer/models/governance/framework_create_params.rbi +298 -0
- data/rbi/openlayer/models/governance/framework_create_response.rbi +730 -0
- data/rbi/openlayer/models/governance/framework_export_params.rbi +54 -0
- data/rbi/openlayer/models/governance/framework_export_response.rbi +48 -0
- data/rbi/openlayer/models/governance/framework_list_params.rbi +310 -0
- data/rbi/openlayer/models/governance/framework_list_project_rule_stats_params.rbi +178 -0
- data/rbi/openlayer/models/governance/framework_list_project_rule_stats_response.rbi +440 -0
- data/rbi/openlayer/models/governance/framework_list_projects_params.rbi +68 -0
- data/rbi/openlayer/models/governance/framework_list_projects_response.rbi +498 -0
- data/rbi/openlayer/models/governance/framework_list_response.rbi +771 -0
- data/rbi/openlayer/models/governance/framework_list_rules_params.rbi +68 -0
- data/rbi/openlayer/models/governance/framework_list_rules_response.rbi +1298 -0
- data/rbi/openlayer/models/governance/framework_retrieve_params.rbi +40 -0
- data/rbi/openlayer/models/governance/framework_retrieve_response.rbi +730 -0
- data/rbi/openlayer/models/governance/framework_update_params.rbi +425 -0
- data/rbi/openlayer/models/governance/framework_update_response.rbi +730 -0
- data/rbi/openlayer/models/governance/frameworks/document_list_params.rbi +70 -0
- data/rbi/openlayer/models/governance/frameworks/document_list_response.rbi +1012 -0
- data/rbi/openlayer/models/governance/frameworks/document_retrieve_params.rbi +50 -0
- data/rbi/openlayer/models/governance/frameworks/document_retrieve_response.rbi +968 -0
- data/rbi/openlayer/models/governance/frameworks/section_list_rules_params.rbi +193 -0
- data/rbi/openlayer/models/governance/frameworks/section_list_rules_response.rbi +1302 -0
- data/rbi/openlayer/models/governance/frameworks/subsection_list_rules_params.rbi +182 -0
- data/rbi/openlayer/models/governance/frameworks/subsection_list_rules_response.rbi +1302 -0
- data/rbi/openlayer/models/governance/rule_create_params.rbi +276 -0
- data/rbi/openlayer/models/governance/rule_create_response.rbi +1253 -0
- data/rbi/openlayer/models/governance/rule_delete_params.rbi +40 -0
- data/rbi/openlayer/models/governance/rule_list_params.rbi +486 -0
- data/rbi/openlayer/models/governance/rule_list_response.rbi +1294 -0
- data/rbi/openlayer/models/governance/rule_result_create_evidence_params.rbi +88 -0
- data/rbi/openlayer/models/governance/rule_result_create_evidence_response.rbi +108 -0
- data/rbi/openlayer/models/governance/rule_result_list_evidence_params.rbi +68 -0
- data/rbi/openlayer/models/governance/rule_result_list_evidence_response.rbi +151 -0
- data/rbi/openlayer/models/governance/rule_result_list_params.rbi +322 -0
- data/rbi/openlayer/models/governance/rule_result_list_response.rbi +567 -0
- data/rbi/openlayer/models/governance/rule_result_retrieve_params.rbi +43 -0
- data/rbi/openlayer/models/governance/rule_result_retrieve_response.rbi +524 -0
- data/rbi/openlayer/models/governance/rule_result_update_params.rbi +373 -0
- data/rbi/openlayer/models/governance/rule_result_update_response.rbi +524 -0
- data/rbi/openlayer/models/governance/rule_retrieve_params.rbi +40 -0
- data/rbi/openlayer/models/governance/rule_retrieve_response.rbi +1253 -0
- data/rbi/openlayer/models/governance/rule_stat_retrieve_params.rbi +68 -0
- data/rbi/openlayer/models/governance/rule_stat_retrieve_response.rbi +874 -0
- data/rbi/openlayer/models/governance/rule_tag_list_params.rbi +68 -0
- data/rbi/openlayer/models/governance/rule_tag_list_response.rbi +139 -0
- data/rbi/openlayer/models/governance/rule_update_params.rbi +106 -0
- data/rbi/openlayer/models/governance/rule_update_response.rbi +1253 -0
- data/rbi/openlayer/models/inference_pipeline_retrieve_response.rbi +0 -5
- data/rbi/openlayer/models/inference_pipeline_update_response.rbi +0 -5
- data/rbi/openlayer/models/project_create_response.rbi +0 -5
- data/rbi/openlayer/models/project_list_response.rbi +0 -5
- data/rbi/openlayer/models/project_update_response.rbi +0 -5
- data/rbi/openlayer/models/projects/inference_pipeline_create_params.rbi +0 -5
- data/rbi/openlayer/models/projects/inference_pipeline_create_response.rbi +0 -5
- data/rbi/openlayer/models/projects/inference_pipeline_list_response.rbi +0 -5
- data/rbi/openlayer/models/storage/presigned_url_retrieve_params.rbi +45 -0
- data/rbi/openlayer/models/storage/presigned_url_retrieve_response.rbi +32 -0
- data/rbi/openlayer/models.rbi +4 -0
- data/rbi/openlayer/resources/background_tasks.rbi +30 -0
- data/rbi/openlayer/resources/governance/frameworks/documents.rbi +65 -0
- data/rbi/openlayer/resources/governance/frameworks/sections.rbi +60 -0
- data/rbi/openlayer/resources/governance/frameworks/subsections.rbi +56 -0
- data/rbi/openlayer/resources/governance/frameworks.rbi +314 -0
- data/rbi/openlayer/resources/governance/rule_results.rbi +193 -0
- data/rbi/openlayer/resources/governance/rule_stats.rbi +38 -0
- data/rbi/openlayer/resources/governance/rule_tags.rbi +38 -0
- data/rbi/openlayer/resources/governance/rules.rbi +233 -0
- data/rbi/openlayer/resources/governance.rbi +27 -0
- data/rbi/openlayer/resources/storage/presigned_url.rbi +23 -0
- data/sig/openlayer/client.rbs +4 -0
- data/sig/openlayer/models/background_task_retrieve_params.rbs +23 -0
- data/sig/openlayer/models/background_task_retrieve_response.rbs +55 -0
- data/sig/openlayer/models/governance/framework_create_params.rbs +124 -0
- data/sig/openlayer/models/governance/framework_create_response.rbs +293 -0
- data/sig/openlayer/models/governance/framework_export_params.rbs +30 -0
- data/sig/openlayer/models/governance/framework_export_response.rbs +21 -0
- data/sig/openlayer/models/governance/framework_list_params.rbs +145 -0
- data/sig/openlayer/models/governance/framework_list_project_rule_stats_params.rbs +87 -0
- data/sig/openlayer/models/governance/framework_list_project_rule_stats_response.rbs +232 -0
- data/sig/openlayer/models/governance/framework_list_projects_params.rbs +38 -0
- data/sig/openlayer/models/governance/framework_list_projects_response.rbs +248 -0
- data/sig/openlayer/models/governance/framework_list_response.rbs +314 -0
- data/sig/openlayer/models/governance/framework_list_rules_params.rbs +38 -0
- data/sig/openlayer/models/governance/framework_list_rules_response.rbs +547 -0
- data/sig/openlayer/models/governance/framework_retrieve_params.rbs +25 -0
- data/sig/openlayer/models/governance/framework_retrieve_response.rbs +293 -0
- data/sig/openlayer/models/governance/framework_update_params.rbs +175 -0
- data/sig/openlayer/models/governance/framework_update_response.rbs +293 -0
- data/sig/openlayer/models/governance/frameworks/document_list_params.rbs +40 -0
- data/sig/openlayer/models/governance/frameworks/document_list_response.rbs +435 -0
- data/sig/openlayer/models/governance/frameworks/document_retrieve_params.rbs +32 -0
- data/sig/openlayer/models/governance/frameworks/document_retrieve_response.rbs +418 -0
- data/sig/openlayer/models/governance/frameworks/section_list_rules_params.rbs +102 -0
- data/sig/openlayer/models/governance/frameworks/section_list_rules_response.rbs +549 -0
- data/sig/openlayer/models/governance/frameworks/subsection_list_rules_params.rbs +95 -0
- data/sig/openlayer/models/governance/frameworks/subsection_list_rules_response.rbs +549 -0
- data/sig/openlayer/models/governance/rule_create_params.rbs +120 -0
- data/sig/openlayer/models/governance/rule_create_response.rbs +530 -0
- data/sig/openlayer/models/governance/rule_delete_params.rbs +25 -0
- data/sig/openlayer/models/governance/rule_list_params.rbs +228 -0
- data/sig/openlayer/models/governance/rule_list_response.rbs +547 -0
- data/sig/openlayer/models/governance/rule_result_create_evidence_params.rbs +53 -0
- data/sig/openlayer/models/governance/rule_result_create_evidence_response.rbs +62 -0
- data/sig/openlayer/models/governance/rule_result_list_evidence_params.rbs +38 -0
- data/sig/openlayer/models/governance/rule_result_list_evidence_response.rbs +79 -0
- data/sig/openlayer/models/governance/rule_result_list_params.rbs +156 -0
- data/sig/openlayer/models/governance/rule_result_list_response.rbs +252 -0
- data/sig/openlayer/models/governance/rule_result_retrieve_params.rbs +26 -0
- data/sig/openlayer/models/governance/rule_result_retrieve_response.rbs +235 -0
- data/sig/openlayer/models/governance/rule_result_update_params.rbs +165 -0
- data/sig/openlayer/models/governance/rule_result_update_response.rbs +235 -0
- data/sig/openlayer/models/governance/rule_retrieve_params.rbs +25 -0
- data/sig/openlayer/models/governance/rule_retrieve_response.rbs +530 -0
- data/sig/openlayer/models/governance/rule_stat_retrieve_params.rbs +38 -0
- data/sig/openlayer/models/governance/rule_stat_retrieve_response.rbs +434 -0
- data/sig/openlayer/models/governance/rule_tag_list_params.rbs +38 -0
- data/sig/openlayer/models/governance/rule_tag_list_response.rbs +74 -0
- data/sig/openlayer/models/governance/rule_update_params.rbs +62 -0
- data/sig/openlayer/models/governance/rule_update_response.rbs +530 -0
- data/sig/openlayer/models/inference_pipeline_retrieve_response.rbs +1 -2
- data/sig/openlayer/models/inference_pipeline_update_response.rbs +1 -2
- data/sig/openlayer/models/project_create_response.rbs +1 -2
- data/sig/openlayer/models/project_list_response.rbs +1 -2
- data/sig/openlayer/models/project_update_response.rbs +1 -2
- data/sig/openlayer/models/projects/inference_pipeline_create_params.rbs +1 -2
- data/sig/openlayer/models/projects/inference_pipeline_create_response.rbs +1 -2
- data/sig/openlayer/models/projects/inference_pipeline_list_response.rbs +1 -2
- data/sig/openlayer/models/storage/presigned_url_retrieve_params.rbs +25 -0
- data/sig/openlayer/models/storage/presigned_url_retrieve_response.rbs +15 -0
- data/sig/openlayer/models.rbs +4 -0
- data/sig/openlayer/resources/background_tasks.rbs +12 -0
- data/sig/openlayer/resources/governance/frameworks/documents.rbs +24 -0
- data/sig/openlayer/resources/governance/frameworks/sections.rbs +23 -0
- data/sig/openlayer/resources/governance/frameworks/subsections.rbs +22 -0
- data/sig/openlayer/resources/governance/frameworks.rbs +88 -0
- data/sig/openlayer/resources/governance/rule_results.rbs +57 -0
- data/sig/openlayer/resources/governance/rule_stats.rbs +16 -0
- data/sig/openlayer/resources/governance/rule_tags.rbs +16 -0
- data/sig/openlayer/resources/governance/rules.rbs +68 -0
- data/sig/openlayer/resources/governance.rbs +17 -0
- data/sig/openlayer/resources/storage/presigned_url.rbs +5 -0
- metadata +185 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: '0933f3fa1e05be26e6dcc831a8facff8bfa464bda977ceebf98b4b169fe1a62f'
|
|
4
|
+
data.tar.gz: 190e3cfd879021c37d835aab1448a24492088858c30d897cae7d0952af9c69e1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9e99803e0f0670f51ac111ccea8ae4ef6bd00b023d67627533c6ac3c617de58040fc94555849181e626cb0cc563408128a4ef98c0df42e11053b0ecb9340845d
|
|
7
|
+
data.tar.gz: 956452b2ecdf1ffc9afca07ca8d6ae30f7a87f125b9c19bcf370e83722f4a3ceb6d8e913e00334e23440cd277b5e5b075f8e53f6283df7a9505b417399c7eee5
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.16.0](https://github.com/openlayer-ai/openlayer-ruby/compare/v0.15.0...v0.16.0) (2026-09-21)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **governance:** add the governance write endpoints and generate governance SDK methods ([e5cb5d9](https://github.com/openlayer-ai/openlayer-ruby/commit/e5cb5d9fab46bb429e9356bbd858aed9545b7c44))
|
|
9
|
+
* initial stlc build ([3fdcbcc](https://github.com/openlayer-ai/openlayer-ruby/commit/3fdcbccd3863e2d21a590517c60031919c88e59e))
|
|
10
|
+
* **stlc:** add stlc workspace and CI automation ([83d35a9](https://github.com/openlayer-ai/openlayer-ruby/commit/83d35a941482daba7c53b262c5b62864e3a8b090))
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Chores
|
|
14
|
+
|
|
15
|
+
* **ci:** point stlc workflows at openlayer-ai ([54b22ff](https://github.com/openlayer-ai/openlayer-ruby/commit/54b22ffedd33139788fec2b4a8db0ca0048a8f13))
|
|
16
|
+
* **internal:** allow the mock server port to be set with STAINLESS_MOCK_PORT ([13bce4e](https://github.com/openlayer-ai/openlayer-ruby/commit/13bce4ee5406cf25d9355cdc61be0873f58f5b39))
|
|
17
|
+
* merge next into main to re-anchor the stlc integrated trunk ([19af091](https://github.com/openlayer-ai/openlayer-ruby/commit/19af0919ec69ece14ec67338e51dad71737f82a4))
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Documentation
|
|
21
|
+
|
|
22
|
+
* **closes OPEN-9410:** expose the governance framework endpoints ([235106d](https://github.com/openlayer-ai/openlayer-ruby/commit/235106d83727df6a51ecc9c14dd1a42af2618a30))
|
|
23
|
+
|
|
3
24
|
## 0.15.0 (2026-08-03)
|
|
4
25
|
|
|
5
26
|
Full Changelog: [v0.14.1...v0.15.0](https://github.com/openlayer-ai/openlayer-ruby/compare/v0.14.1...v0.15.0)
|
data/README.md
CHANGED
data/lib/openlayer/client.rb
CHANGED
|
@@ -36,6 +36,12 @@ module Openlayer
|
|
|
36
36
|
# @return [Openlayer::Resources::Tests]
|
|
37
37
|
attr_reader :tests
|
|
38
38
|
|
|
39
|
+
# @return [Openlayer::Resources::BackgroundTasks]
|
|
40
|
+
attr_reader :background_tasks
|
|
41
|
+
|
|
42
|
+
# @return [Openlayer::Resources::Governance]
|
|
43
|
+
attr_reader :governance
|
|
44
|
+
|
|
39
45
|
# @api private
|
|
40
46
|
#
|
|
41
47
|
# @return [Hash{String=>String}]
|
|
@@ -99,6 +105,8 @@ module Openlayer
|
|
|
99
105
|
@inference_pipelines = Openlayer::Resources::InferencePipelines.new(client: self)
|
|
100
106
|
@storage = Openlayer::Resources::Storage.new(client: self)
|
|
101
107
|
@tests = Openlayer::Resources::Tests.new(client: self)
|
|
108
|
+
@background_tasks = Openlayer::Resources::BackgroundTasks.new(client: self)
|
|
109
|
+
@governance = Openlayer::Resources::Governance.new(client: self)
|
|
102
110
|
end
|
|
103
111
|
end
|
|
104
112
|
end
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Openlayer
|
|
4
|
+
module Models
|
|
5
|
+
# @see Openlayer::Resources::BackgroundTasks#retrieve
|
|
6
|
+
class BackgroundTaskRetrieveParams < Openlayer::Internal::Type::BaseModel
|
|
7
|
+
extend Openlayer::Internal::Type::RequestParameters::Converter
|
|
8
|
+
include Openlayer::Internal::Type::RequestParameters
|
|
9
|
+
|
|
10
|
+
# @!attribute task_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :task_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(task_id:, request_options: {})
|
|
16
|
+
# @param task_id [String]
|
|
17
|
+
# @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Openlayer
|
|
4
|
+
module Models
|
|
5
|
+
# @see Openlayer::Resources::BackgroundTasks#retrieve
|
|
6
|
+
class BackgroundTaskRetrieveResponse < Openlayer::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute complete
|
|
8
|
+
# Whether the task has finished. Check this before reading `outputs`.
|
|
9
|
+
#
|
|
10
|
+
# @return [Boolean]
|
|
11
|
+
required :complete, Openlayer::Internal::Type::Boolean
|
|
12
|
+
|
|
13
|
+
# @!attribute progress
|
|
14
|
+
# How far along the task is, from 0 to 100.
|
|
15
|
+
#
|
|
16
|
+
# @return [Float]
|
|
17
|
+
required :progress, Float
|
|
18
|
+
|
|
19
|
+
# @!attribute error
|
|
20
|
+
# Why the task failed, or `null` if it has not failed.
|
|
21
|
+
#
|
|
22
|
+
# @return [String, nil]
|
|
23
|
+
optional :error, String, nil?: true
|
|
24
|
+
|
|
25
|
+
# @!attribute outputs
|
|
26
|
+
# Whatever the task produced, keyed by name. `null` until the task completes. A
|
|
27
|
+
# framework export returns `storageUri` -- pass it to `GET /storage/presigned-url`
|
|
28
|
+
# to download the archive -- along with `filename`, `controlCount`,
|
|
29
|
+
# `evidenceCount` and `missingEvidenceCount`.
|
|
30
|
+
#
|
|
31
|
+
# @return [Object, nil]
|
|
32
|
+
optional :outputs, Openlayer::Internal::Type::Unknown, nil?: true
|
|
33
|
+
|
|
34
|
+
response_only do
|
|
35
|
+
# @!attribute id
|
|
36
|
+
# The background task id.
|
|
37
|
+
#
|
|
38
|
+
# @return [String]
|
|
39
|
+
required :id, String
|
|
40
|
+
|
|
41
|
+
# @!attribute date_created
|
|
42
|
+
# When the task was queued.
|
|
43
|
+
#
|
|
44
|
+
# @return [Time]
|
|
45
|
+
required :date_created, Time, api_name: :dateCreated
|
|
46
|
+
|
|
47
|
+
# @!attribute date_updated
|
|
48
|
+
# When the task last reported progress.
|
|
49
|
+
#
|
|
50
|
+
# @return [Time]
|
|
51
|
+
required :date_updated, Time, api_name: :dateUpdated
|
|
52
|
+
|
|
53
|
+
# @!attribute name
|
|
54
|
+
# The task's internal name, including the arguments it was queued with.
|
|
55
|
+
#
|
|
56
|
+
# @return [String]
|
|
57
|
+
required :name, String
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
# @!method initialize(id:, complete:, date_created:, date_updated:, name:, progress:, error: nil, outputs: nil)
|
|
61
|
+
# Some parameter documentations has been truncated, see
|
|
62
|
+
# {Openlayer::Models::BackgroundTaskRetrieveResponse} for more details.
|
|
63
|
+
#
|
|
64
|
+
# @param id [String] The background task id.
|
|
65
|
+
#
|
|
66
|
+
# @param complete [Boolean] Whether the task has finished. Check this before reading `outputs`.
|
|
67
|
+
#
|
|
68
|
+
# @param date_created [Time] When the task was queued.
|
|
69
|
+
#
|
|
70
|
+
# @param date_updated [Time] When the task last reported progress.
|
|
71
|
+
#
|
|
72
|
+
# @param name [String] The task's internal name, including the arguments it was queued with.
|
|
73
|
+
#
|
|
74
|
+
# @param progress [Float] How far along the task is, from 0 to 100.
|
|
75
|
+
#
|
|
76
|
+
# @param error [String, nil] Why the task failed, or `null` if it has not failed.
|
|
77
|
+
#
|
|
78
|
+
# @param outputs [Object, nil] Whatever the task produced, keyed by name. `null` until the task completes. A fr
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
end
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Openlayer
|
|
4
|
+
module Models
|
|
5
|
+
module Governance
|
|
6
|
+
# @see Openlayer::Resources::Governance::Frameworks#create
|
|
7
|
+
class FrameworkCreateParams < Openlayer::Internal::Type::BaseModel
|
|
8
|
+
extend Openlayer::Internal::Type::RequestParameters::Converter
|
|
9
|
+
include Openlayer::Internal::Type::RequestParameters
|
|
10
|
+
|
|
11
|
+
# @!attribute workspace_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :workspace_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute name
|
|
17
|
+
# The framework name.
|
|
18
|
+
#
|
|
19
|
+
# @return [String]
|
|
20
|
+
required :name, String
|
|
21
|
+
|
|
22
|
+
# @!attribute description
|
|
23
|
+
# A short description of the framework.
|
|
24
|
+
#
|
|
25
|
+
# @return [String, nil]
|
|
26
|
+
optional :description, String, nil?: true
|
|
27
|
+
|
|
28
|
+
# @!attribute enabled
|
|
29
|
+
# Whether the framework is active. Rules of a disabled framework are not evaluated
|
|
30
|
+
# and do not count towards compliance.
|
|
31
|
+
#
|
|
32
|
+
# @return [Boolean, nil]
|
|
33
|
+
optional :enabled, Openlayer::Internal::Type::Boolean
|
|
34
|
+
|
|
35
|
+
# @!attribute project_selector
|
|
36
|
+
# Determines which projects the framework applies to. An empty or `null` `match`
|
|
37
|
+
# array applies the framework to every project in the workspace.
|
|
38
|
+
#
|
|
39
|
+
# @return [Openlayer::Models::Governance::FrameworkCreateParams::ProjectSelector, nil]
|
|
40
|
+
optional :project_selector,
|
|
41
|
+
-> { Openlayer::Governance::FrameworkCreateParams::ProjectSelector },
|
|
42
|
+
api_name: :projectSelector,
|
|
43
|
+
nil?: true
|
|
44
|
+
|
|
45
|
+
# @!attribute tags
|
|
46
|
+
# Free-form labels on the framework.
|
|
47
|
+
#
|
|
48
|
+
# @return [Array<String>, nil]
|
|
49
|
+
optional :tags, Openlayer::Internal::Type::ArrayOf[String]
|
|
50
|
+
|
|
51
|
+
# @!method initialize(workspace_id:, name:, description: nil, enabled: nil, project_selector: nil, tags: nil, request_options: {})
|
|
52
|
+
# Some parameter documentations has been truncated, see
|
|
53
|
+
# {Openlayer::Models::Governance::FrameworkCreateParams} for more details.
|
|
54
|
+
#
|
|
55
|
+
# @param workspace_id [String]
|
|
56
|
+
#
|
|
57
|
+
# @param name [String] The framework name.
|
|
58
|
+
#
|
|
59
|
+
# @param description [String, nil] A short description of the framework.
|
|
60
|
+
#
|
|
61
|
+
# @param enabled [Boolean] Whether the framework is active. Rules of a disabled framework are not evaluated
|
|
62
|
+
#
|
|
63
|
+
# @param project_selector [Openlayer::Models::Governance::FrameworkCreateParams::ProjectSelector, nil] Determines which projects the framework applies to. An empty or `null` `match` a
|
|
64
|
+
#
|
|
65
|
+
# @param tags [Array<String>] Free-form labels on the framework.
|
|
66
|
+
#
|
|
67
|
+
# @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
|
|
68
|
+
|
|
69
|
+
class ProjectSelector < Openlayer::Internal::Type::BaseModel
|
|
70
|
+
# @!attribute match
|
|
71
|
+
# Match criteria, ANDed together.
|
|
72
|
+
#
|
|
73
|
+
# @return [Array<Openlayer::Models::Governance::FrameworkCreateParams::ProjectSelector::Match>, nil]
|
|
74
|
+
optional :match,
|
|
75
|
+
-> {
|
|
76
|
+
Openlayer::Internal::Type::ArrayOf[Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match]
|
|
77
|
+
},
|
|
78
|
+
nil?: true
|
|
79
|
+
|
|
80
|
+
# @!method initialize(match: nil)
|
|
81
|
+
# Determines which projects the framework applies to. An empty or `null` `match`
|
|
82
|
+
# array applies the framework to every project in the workspace.
|
|
83
|
+
#
|
|
84
|
+
# @param match [Array<Openlayer::Models::Governance::FrameworkCreateParams::ProjectSelector::Match>, nil] Match criteria, ANDed together.
|
|
85
|
+
|
|
86
|
+
class Match < Openlayer::Internal::Type::BaseModel
|
|
87
|
+
# @!attribute property
|
|
88
|
+
# The project property to match against.
|
|
89
|
+
#
|
|
90
|
+
# @return [Symbol, Openlayer::Models::Governance::FrameworkCreateParams::ProjectSelector::Match::Property]
|
|
91
|
+
required :property,
|
|
92
|
+
enum: -> { Openlayer::Governance::FrameworkCreateParams::ProjectSelector::Match::Property }
|
|
93
|
+
|
|
94
|
+
# @!attribute value
|
|
95
|
+
# The value to match against. Pass an array to match any of several values, or
|
|
96
|
+
# `null` to match projects where the property is unset. Omit it for `exists` and
|
|
97
|
+
# `notExists`.
|
|
98
|
+
#
|
|
99
|
+
# @return [Object]
|
|
100
|
+
required :value, Openlayer::Internal::Type::Unknown
|
|
101
|
+
|
|
102
|
+
# @!attribute operator
|
|
103
|
+
# How to compare the project property with `value`. One of `equals`, `notEquals`,
|
|
104
|
+
# `contains`, `notContains`, `startsWith`, `endsWith`, `in`, `notIn`,
|
|
105
|
+
# `greaterThan`, `greaterThanOrEqual`, `lessThan`, `lessThanOrEqual`,
|
|
106
|
+
# `equalsIgnoreCase`, `containsIgnoreCase`, `matches`, `exists`, or `notExists`.
|
|
107
|
+
#
|
|
108
|
+
# @return [String, nil]
|
|
109
|
+
optional :operator, String
|
|
110
|
+
|
|
111
|
+
# @!method initialize(property:, value:, operator: nil)
|
|
112
|
+
# Some parameter documentations has been truncated, see
|
|
113
|
+
# {Openlayer::Models::Governance::FrameworkCreateParams::ProjectSelector::Match}
|
|
114
|
+
# for more details.
|
|
115
|
+
#
|
|
116
|
+
# @param property [Symbol, Openlayer::Models::Governance::FrameworkCreateParams::ProjectSelector::Match::Property] The project property to match against.
|
|
117
|
+
#
|
|
118
|
+
# @param value [Object] The value to match against. Pass an array to match any of several values, or `nu
|
|
119
|
+
#
|
|
120
|
+
# @param operator [String] How to compare the project property with `value`. One of `equals`, `notEquals`,
|
|
121
|
+
|
|
122
|
+
# The project property to match against.
|
|
123
|
+
#
|
|
124
|
+
# @see Openlayer::Models::Governance::FrameworkCreateParams::ProjectSelector::Match#property
|
|
125
|
+
module Property
|
|
126
|
+
extend Openlayer::Internal::Type::Enum
|
|
127
|
+
|
|
128
|
+
TASK_TYPE = :taskType
|
|
129
|
+
RISK_LEVEL = :riskLevel
|
|
130
|
+
RISK_TOTAL_SCORE = :riskTotalScore
|
|
131
|
+
NAME = :name
|
|
132
|
+
OWNER_ID = :ownerId
|
|
133
|
+
MODEL_TYPES = :modelTypes
|
|
134
|
+
|
|
135
|
+
# @!method self.values
|
|
136
|
+
# @return [Array<Symbol>]
|
|
137
|
+
end
|
|
138
|
+
end
|
|
139
|
+
end
|
|
140
|
+
end
|
|
141
|
+
end
|
|
142
|
+
end
|
|
143
|
+
end
|