Speakeasy migrate workflows & Suppress diff for readonly fields in save file payload

Author: Nishu Goel

.github/workflows/speakeasy_sdk_generation.yml

@@ -1,28 +1,20 @@
 name: Generate
-
-on:
-  workflow_dispatch: # Allows manual triggering of the workflow to generate SDK
-    inputs:
-      force:
-        description: "Force generation of SDKs"
-        type: boolean
-        default: false
-  schedule:
-    - cron: 0 0 * * * # Runs every day at midnight
-
+"on":
+    workflow_dispatch:
+        inputs:
+            force:
+                description: Force generation of SDKs
+                type: boolean
+                default: false
+    schedule:
+        - cron: 0 0 * * *
 jobs:
-  generate:
-    uses: speakeasy-api/sdk-generation-action/.github/workflows/sdk-generation.yaml@v14
-    with:
-      speakeasy_version: latest
-      openapi_docs: |
-        - https://docs.api.epilot.io/file.yaml
-      overlay_docs: |
-        - ./overlay.yaml
-      languages: |
-        - terraform
-      mode: pr
-      force: ${{ github.event.inputs.force }}
-    secrets:
-      github_access_token: ${{ secrets.GITHUB_TOKEN }}
-      speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
+    generate:
+        uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
+        with:
+            force: ${{ github.event.inputs.force }}
+            mode: pr
+            speakeasy_version: latest
+        secrets:
+            github_access_token: ${{ secrets.GITHUB_TOKEN }}
+            speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}

.speakeasy/gen.lock

@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: 11c8545a-deb6-44f9-ba56-e71722af6a51
 management:
-  docChecksum: 1c56c7ca8bb88e9f3f0a7643ee3863a4
+  docChecksum: 0383a3b8b71da53f168ab4cd3da53caa
   docVersion: 0.2.0
-  speakeasyVersion: 1.396.7
-  generationVersion: 2.415.6
-  releaseVersion: 0.4.2
-  configChecksum: 122c582ae34924cbbbf36d5bcaf65981
+  speakeasyVersion: 1.422.1
+  generationVersion: 2.438.15
+  releaseVersion: 0.5.0
+  configChecksum: 166ca9b280afae98c5bf4536bf99033d
   repoURL: https://github.com/epilot-dev/terraform-provider-epilot-file.git
   repoSubDirectory: .
   published: true
@@ -15,10 +15,10 @@ features:
     additionalDependencies: 0.1.0
     additionalProperties: 0.1.2
     constsAndDefaults: 0.1.4
-    core: 3.24.11
+    core: 3.25.0
     deprecations: 2.81.1
     envVarSecurityUsage: 0.1.0
-    globalSecurity: 2.81.8
+    globalSecurity: 2.81.9
     globalServerURLs: 2.82.1
     inputOutputModels: 2.83.0
     nullables: 0.0.0
@@ -171,7 +171,7 @@ examples:
         application/json: {"filename": "document.pdf", "index_tag": "2f6a377c8e78", "metadata": {"color": "blue"}, "mime_type": "application/pdf"}
       responses:
         "201":
-          application/json: {"public_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf", "s3ref": {"bucket": "epilot-prod-user-content", "key": "123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"}, "upload_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123"}
+          application/json: {"public_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf", "s3ref": {"bucket": "epilot-prod-user-content", "key": "123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"}, "upload_url": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123"}
   deleteFile:
     speakeasy-default-delete-file:
       parameters:

.speakeasy/workflow.yaml

@@ -0,0 +1,9 @@
+workflowVersion: 1.0.0
+sources:
+    my-source:
+        inputs:
+            - location: https://docs.api.epilot.io/file.yaml
+targets:
+    terraform:
+        target: terraform
+        source: my-source

Makefile

@@ -2,8 +2,8 @@
 all: speakeasy docs
 
 original.yaml:
-	curl https://docs.api.epilot.io/file.yaml > original.yaml
-# cp openapi.yml original.yaml
+#curl https://docs.api.epilot.io/file.yaml > original.yaml
+	cp openapi.yml original.yaml
 
 original_modified.yaml: original.yaml overlay.yaml
 	speakeasy overlay apply -s original.yaml -o overlay.yaml > original_modified.yaml
@@ -13,8 +13,8 @@ overlay.yaml:
 
 speakeasy:
 	$(eval TMP := $(shell mktemp -d))
-	curl https://docs.api.epilot.io/file.yaml > $(TMP)/openapi.yaml
-# cp openapi.yml $(TMP)/openapi.yaml
+#curl https://docs.api.epilot.io/file.yaml > $(TMP)/openapi.yaml
+	cp openapi.yml $(TMP)/openapi.yaml
 	speakeasy overlay apply -s $(TMP)/openapi.yaml -o overlay.yaml > $(TMP)/final.yaml
 	speakeasy generate sdk --lang terraform -o . -s $(TMP)/final.yaml
 

README.md

@@ -59,7 +59,7 @@ terraform {
   required_providers {
     epilot-file = {
       source  = "epilot-dev/epilot-file"
-      version = "0.4.2"
+      version = "0.5.0"
     }
   }
 }

docs/data-sources/file.md

@@ -14,8 +14,9 @@ File DataSource
 
 ```terraform
 data "epilot-file_file" "my_file" {
+  async  = true
   id     = "ef7d985c-2385-44f4-9c71-ae06a52264f8"
-  strict = true
+  strict = false
 }
 ```
 
@@ -24,6 +25,7 @@ data "epilot-file_file" "my_file" {
 
 ### Optional
 
+- `async` (Boolean) Don't wait for updated entity to become available in Search API. Useful for large migrations
 - `strict` (Boolean) When passed true, the response will contain only fields that match the schema, with non-matching fields included in `__additional`
 
 ### Read-Only

docs/index.md

@@ -17,7 +17,7 @@ terraform {
   required_providers {
     epilot-file = {
       source  = "epilot-dev/epilot-file"
-      version = "0.4.2"
+      version = "0.5.0"
     }
   }
 }

docs/resources/file.md

@@ -30,6 +30,7 @@ resource "epilot-file_file" "my_file" {
   additional = {
     "see" : jsonencode("documentation"),
   }
+  async               = true
   custom_download_url = "https://some-api-url.com/download?file_id=123"
   filename            = "document.pdf"
   fill_activity       = true
@@ -46,7 +47,7 @@ resource "epilot-file_file" "my_file" {
     key    = "123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
   }
   source_url = "https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf"
-  strict     = true
+  strict     = false
   tags = [
     "..."
   ]
@@ -64,6 +65,7 @@ resource "epilot-file_file" "my_file" {
 - `acl` (Attributes) Access control list (ACL) for an entity. Defines sharing access to external orgs or users. (see [below for nested schema](#nestedatt--acl))
 - `activity_id` (String) Activity to include in event feed
 - `additional` (Map of String) Additional fields that are not part of the schema
+- `async` (Boolean) Don't wait for updated entity to become available in Search API. Useful for large migrations. Default: false
 - `custom_download_url` (String) Custom external download url used for the file
 - `filename` (String)
 - `fill_activity` (Boolean) Update the diff and entity for the custom activity included in the query.

examples/data-sources/epilot-file_file/data-source.tf

@@ -1,4 +1,5 @@
 data "epilot-file_file" "my_file" {
+  async  = true
   id     = "ef7d985c-2385-44f4-9c71-ae06a52264f8"
-  strict = true
+  strict = false
 }

examples/provider/provider.tf

@@ -2,7 +2,7 @@ terraform {
   required_providers {
     epilot-file = {
       source  = "epilot-dev/epilot-file"
-      version = "0.4.2"
+      version = "0.5.0"
     }
   }
 }