From f916f33fe965dde111070fa7e7656254b15a60c4 Mon Sep 17 00:00:00 2001 From: Victor Moraes Date: Tue, 26 Sep 2023 17:47:03 -0300 Subject: [PATCH] Add docs --- cyral/data_source_cyral_system_info.go | 8 ++++---- docs/data-sources/system_info.md | 22 ++++++++++++++++++++++ 2 files changed, 26 insertions(+), 4 deletions(-) create mode 100644 docs/data-sources/system_info.md diff --git a/cyral/data_source_cyral_system_info.go b/cyral/data_source_cyral_system_info.go index 5464e0a2..873e6090 100644 --- a/cyral/data_source_cyral_system_info.go +++ b/cyral/data_source_cyral_system_info.go @@ -30,7 +30,7 @@ func (systemInfo *SystemInfo) WriteToSchema(d *schema.ResourceData) error { func dataSourceSystemInfo() *schema.Resource { return &schema.Resource{ - Description: "Retrieve information from Cyral systems.", + Description: "Retrieve information from Cyral system.", ReadContext: ReadResource(ResourceOperationConfig{ Name: "SystemInfoDataSourceRead", HttpMethod: http.MethodGet, @@ -43,17 +43,17 @@ func dataSourceSystemInfo() *schema.Resource { }), Schema: map[string]*schema.Schema{ IDKey: { - Description: "The data source identifier.", + Description: "Data source identifier.", Type: schema.TypeString, Computed: true, }, ControlPlaneVersionKey: { - Description: "The Control Plane version.", + Description: "Control Plane version.", Type: schema.TypeString, Computed: true, }, SidecarLatestVersionKey: { - Description: "The latest Sidecar version available to this Control Plane.", + Description: "Latest Sidecar version available to this Control Plane.", Type: schema.TypeString, Computed: true, }, diff --git a/docs/data-sources/system_info.md b/docs/data-sources/system_info.md new file mode 100644 index 00000000..576cbf77 --- /dev/null +++ b/docs/data-sources/system_info.md @@ -0,0 +1,22 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "cyral_system_info Data Source - terraform-provider-cyral" +subcategory: "" +description: |- + Retrieve information from Cyral system. +--- + +# cyral_system_info (Data Source) + +Retrieve information from Cyral system. + + + + +## Schema + +### Read-Only + +- `control_plane_version` (String) Control Plane version. +- `id` (String) Data source identifier. +- `sidecar_latest_version` (String) Latest Sidecar version available to this Control Plane.