Update README description + bump version

teamlumos · Jul 25, 2024 · 4b87443 · 4b87443
1 parent f76a911
commit 4b87443
Show file tree

Hide file tree

Showing 11 changed files with 31 additions and 89 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: c7830d5c-39eb-428e-bde1-daaba29fa325
 management:
- docChecksum: b23cc0b4d3e94a7da0550bf603db9f93
+ docChecksum: 8c43483effe5dc326d375dcc864b71eb
  docVersion: 0.1.0
  speakeasyVersion: 1.346.0
  generationVersion: 2.379.3
- releaseVersion: 0.2.8
- configChecksum: 752f612f28d4f91d283f6c1869ec3155
+ releaseVersion: 0.2.9
+ configChecksum: 8e248002101d47174f87f59ee681715d
 features:
  terraform:
  additionalDependencies: 0.1.0

diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -12,7 +12,7 @@ generation:
  auth:
  oAuth2ClientCredentialsEnabled: true
 terraform:
- version: 0.2.9
+ version: 0.3.0
  additionalDataSources: []
  additionalDependencies: {}
  additionalResources: []

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -2,16 +2,16 @@ speakeasyVersion: 1.346.0
 sources:
  FastAPI:
  sourceNamespace: fast-api
- sourceRevisionDigest: sha256:2e19e7afd58189dbd92f226533dc317054ec7dd397b683789763c7e9d9145b9c
- sourceBlobDigest: sha256:eb8fa2d5641aae62ece949de8b50009890f1291f3ede5cc363e21255ee3b59bb
+ sourceRevisionDigest: sha256:95f1a9d4214aff72dbd9f4c975675e3e5073456608c100949d7609bcb6605612
+ sourceBlobDigest: sha256:93164701c3f09f91baa3c6e12d6d1f635931336515976d784dffd662e91c91d1
  tags:
  - latest
 targets:
  lumos-terraform-provider-target:
  source: FastAPI
  sourceNamespace: fast-api
- sourceRevisionDigest: sha256:2e19e7afd58189dbd92f226533dc317054ec7dd397b683789763c7e9d9145b9c
- sourceBlobDigest: sha256:eb8fa2d5641aae62ece949de8b50009890f1291f3ede5cc363e21255ee3b59bb
+ sourceRevisionDigest: sha256:95f1a9d4214aff72dbd9f4c975675e3e5073456608c100949d7609bcb6605612
+ sourceBlobDigest: sha256:93164701c3f09f91baa3c6e12d6d1f635931336515976d784dffd662e91c91d1
  outLocation: /Users/ethanzh/terraform-provider-lumos
 workflow:
  workflowVersion: 1.0.0

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# lumos
+# Lumos
 
 <div align="left">
  <a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
@@ -16,7 +16,7 @@ terraform {
  required_providers {
  lumos = {
  source = "teamlumos/lumos"
- version = "0.2.8"
+ version = "0.2.9"
  }
  }
 }

diff --git a/docs/index.md b/docs/index.md
@@ -3,20 +3,12 @@
 page_title: "lumos Provider"
 subcategory: ""
 description: |-
- Lumos:
- The Lumos API gives you the building blocks to administer and extend Lumos programmatically.
- Our REST API provides a management interface for the AppStore and a read interface
- for the Lumos Core.
- Go to https://developers.lumos.com to see our complete documentation.
+ Lumos: The Lumos provider allows you to manage resources such as Apps, Permissions, and Pre-Approval Rules
 ---
 
 # lumos Provider
 
-Lumos: 
- The Lumos API gives you the building blocks to administer and extend Lumos programmatically.
- Our REST API provides a management interface for the AppStore and a read interface
- for the Lumos Core.
- Go to https://developers.lumos.com to see our complete documentation.
+Lumos: The Lumos provider allows you to manage resources such as Apps, Permissions, and Pre-Approval Rules
 
 ## Example Usage
 
@@ -25,7 +17,7 @@ terraform {
  required_providers {
  lumos = {
  source = "teamlumos/lumos"
- version = "0.2.8"
+ version = "0.2.9"
  }
  }
 }

diff --git a/docs/resources/requestable_permission.md b/docs/resources/requestable_permission.md
@@ -13,35 +13,11 @@ RequestablePermission Resource
 ## Example Usage
 
 ```terraform
-resource "lumos_requestable_permission" "test_provisioning_group" {
- app_id = "b4bb7f9c-e287-4cda-878d-8638a85206f9"
- label = "test_provisioning_group"
- request_config = {
- appstore_visibility = "VISIBLE"
- request_approval_config = {
- manager_approval = "INITIAL_APPROVAL"
- request_approval_config_override = true
- approvers = {
- groups = []
- users = [{ id = data.lumos_users.albus.items[0].id }]
- }
- approvers_stage_2 = {
- groups = []
- users = [{ id = data.lumos_users.bella.items[0].id }]
- }
-
- custom_approval_message = "Test"
- custom_approval_message_override = true
- }
- request_fulfillment_config = {
- time_based_access_options = ["4 hours"]
- time_based_access_override = true
- provisioning_group = {
- app_id = "dd68df37-55b1-ccfd-d82c-f5fd5af8c676"
- integration_specific_id = "00gh1qldohd1QYpF3697"
- }
- }
- }
+resource "lumos_requestable_permission" "my_requestablepermission" {
+ app_class_id = "...my_app_class_id..."
+ app_id = "...my_app_id..."
+ app_instance_id = "...my_app_instance_id..."
+ label = "...my_label..."
 }
 ```
 

diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf
@@ -2,7 +2,7 @@ terraform {
  required_providers {
  lumos = {
  source = "teamlumos/lumos"
- version = "0.2.8"
+ version = "0.2.9"
  }
  }
 }

diff --git a/examples/resources/lumos_requestable_permission/resource.tf b/examples/resources/lumos_requestable_permission/resource.tf
@@ -1,26 +1,6 @@
-resource "lumos_requestable_permission" "example_permission" {
- app_id = "b4bb3f9c-e287-4cda-878d-8638a85206f9"
- label = "Permission Name"
- request_config = {
- appstore_visibility = "VISIBLE"
- request_approval_config = {
- manager_approval = "INITIAL_APPROVAL"
- request_approval_config_override = true
- approvers = {
- groups = []
- users = [{ id = data.lumos_users.example_users.items[0].id }]
- }
-
- custom_approval_message = "Custom Approval Message"
- custom_approval_message_override = true
- }
- request_fulfillment_config = {
- time_based_access_options = ["4 hours", "12 hours"]
- time_based_access_override = true
- provisioning_group = {
- app_id = "dd68df37-55b1-ccfd-d82c-f53d1af1c676"
- integration_specific_id = "00gn10ldkhddQYp03647"
- }
- }
- }
-}
+resource "lumos_requestable_permission" "my_requestablepermission" {
+ app_class_id = "...my_app_class_id..."
+ app_id = "...my_app_id..."
+ app_instance_id = "...my_app_instance_id..."
+ label = "...my_label..."
+}
diff --git a/internal/provider/provider.go b/internal/provider/provider.go
@@ -37,12 +37,7 @@ func (p *LumosProvider) Metadata(ctx context.Context, req provider.MetadataReque
 
 func (p *LumosProvider) Schema(ctx context.Context, req provider.SchemaRequest, resp *provider.SchemaResponse) {
  resp.Schema = schema.Schema{
- MarkdownDescription: `Lumos: ` + "\n" +
- ` The Lumos API gives you the building blocks to administer and extend Lumos programmatically.` + "\n" +
- ` Our REST API provides a management interface for the AppStore and a read interface` + "\n" +
- ` for the Lumos Core.` + "\n" +
- ` Go to https://developers.lumos.com to see our complete documentation.` + "\n" +
- ``,
+ Description: `Lumos: The Lumos provider allows you to manage resources such as Apps, Permissions, and Pre-Approval Rules`,
  Attributes: map[string]schema.Attribute{
  "server_url": schema.StringAttribute{
  MarkdownDescription: "Server URL (defaults to https://api.lumos.com)",

diff --git a/internal/sdk/lumos.go b/internal/sdk/lumos.go
@@ -64,12 +64,7 @@ func (c *sdkConfiguration) GetServerDetails() (string, map[string]string) {
  return ServerList[c.ServerIndex], nil
 }
 
-// Lumos - Lumos:
-//
-// The Lumos API gives you the building blocks to administer and extend Lumos programmatically.
-// Our REST API provides a management interface for the AppStore and a read interface
-// for the Lumos Core.
-// Go to https://developers.lumos.com to see our complete documentation.
+// Lumos - Lumos: The Lumos provider allows you to manage resources such as Apps, Permissions, and Pre-Approval Rules
 type Lumos struct {
  Core *Core
  AppStore *AppStore

diff --git a/overlay.yaml b/overlay.yaml
@@ -3,6 +3,10 @@ info:
  title: Overlay original-openapi.json => openapi.json
  version: 0.0.0
 actions:
+ # Update README description
+ - target: $["info"]["description"]
+ update: "The Lumos provider allows you to manage resources such as Apps, Permissions, and Pre-Approval Rules"
+
  # HTTP exponential backoff retries
  - target: $
  update: