Skip to content

Commit

Permalink
Merge pull request #148 from ekristen/docs
Browse files Browse the repository at this point in the history
docs: auto-generated resource docs
  • Loading branch information
ekristen authored Dec 4, 2024
2 parents e374a88 + 96c4fd1 commit 988c0dc
Show file tree
Hide file tree
Showing 83 changed files with 869 additions and 411 deletions.
12 changes: 12 additions & 0 deletions docs/resources/big-query-dataset.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Big Query Dataset

## Details

- **Type:** `BigQueryDataset`
- **Scope:** project

## Properties

- **`Name`**: The name of the dataset
- **`Location`**: The location of the dataset
- **`Labels`**: No description provided
14 changes: 14 additions & 0 deletions docs/resources/cloud-function-2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Cloud Function 2

## Details

- **Type:** `CloudFunction2`
- **Scope:** project

## Properties

- **`Project`**: No description provided
- **`Region`**: No description provided
- **`Name`**: No description provided
- **`Labels`**: No description provided
- **`State`**: No description provided
12 changes: 12 additions & 0 deletions docs/resources/cloud-function.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Cloud Function

## Details

- **Type:** `CloudFunction`
- **Scope:** project

## Properties

- **`Name`**: No description provided
- **`Status`**: No description provided
- **`Labels`**: No description provided
14 changes: 14 additions & 0 deletions docs/resources/cloud-run.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Cloud Run

## Details

- **Type:** `CloudRun`
- **Scope:** project

## Properties

- **`Name`**: The name of the cloud run
- **`Labels`**: The labels associated with the cloud run
- **`Project`**: No description provided
- **`Region`**: No description provided
- **`FullName`**: No description provided
17 changes: 17 additions & 0 deletions docs/resources/cloud-sql-instance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Cloud SQL Instance

## Details

- **Type:** `CloudSQLInstance`
- **Scope:** project

## Properties

- **`State`**: The current serving state of the Cloud SQL instance
- **`Labels`**: The user-defined labels associated with this Cloud SQL instance
- **`CreationDate`**: The time when the instance was created
- **`DatabaseVersion`**: The database engine type and version
- **`Name`**: Name of the Cloud SQL instance
## Settings

- `DisableDeletionProtection`
10 changes: 10 additions & 0 deletions docs/resources/compute-backend-service.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Compute Backend Service

## Details

- **Type:** `ComputeBackendService`
- **Scope:** project

## Properties

- **`Name`**: No description provided
11 changes: 11 additions & 0 deletions docs/resources/compute-common-instance-metadata.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Compute Common Instance Metadata

## Details

- **Type:** `ComputeCommonInstanceMetadata`
- **Scope:** project

## Properties

- **`Fingerprint`**: No description provided
- **`Items`**: No description provided
15 changes: 15 additions & 0 deletions docs/resources/compute-disk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Compute Disk

## Details

- **Type:** `ComputeDisk`
- **Scope:** project

## Properties

- **`Labels`**: No description provided
- **`Name`**: No description provided
- **`Zone`**: No description provided
- **`Arch`**: No description provided
- **`Size`**: No description provided
- **`Type`**: No description provided
12 changes: 12 additions & 0 deletions docs/resources/compute-firewall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Compute Firewall

## Details

- **Type:** `ComputeFirewall`
- **Scope:** project

## Properties

- **`Name`**: No description provided
- **`Project`**: No description provided
- **`Region`**: No description provided
12 changes: 12 additions & 0 deletions docs/resources/compute-forwarding-rule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Compute Forwarding Rule

## Details

- **Type:** `ComputeForwardingRule`
- **Scope:** project

## Properties

- **`Name`**: No description provided
- **`CreatedAt`**: No description provided
- **`Labels`**: No description provided
15 changes: 15 additions & 0 deletions docs/resources/compute-instance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Compute Instance

## Details

- **Type:** `ComputeInstance`
- **Scope:** project

## Properties

- **`Labels`**: No description provided
- **`Project`**: No description provided
- **`Region`**: No description provided
- **`Name`**: No description provided
- **`Zone`**: No description provided
- **`CreationTimestamp`**: No description provided
10 changes: 10 additions & 0 deletions docs/resources/compute-packet-mirroring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Compute Packet Mirroring

## Details

- **Type:** `ComputePacketMirroring`
- **Scope:** project

## Properties

- **`Name`**: Name of the packet mirroring configuration.
12 changes: 12 additions & 0 deletions docs/resources/compute-security-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Compute Security Policy

## Details

- **Type:** `ComputeSecurityPolicy`
- **Scope:** project

## Properties

- **`Name`**: No description provided
- **`CreatedAt`**: No description provided
- **`Labels`**: No description provided
13 changes: 13 additions & 0 deletions docs/resources/compute-ssl-certificate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Compute SSL Certificate

## Details

- **Type:** `ComputeSSLCertificate`
- **Scope:** project

## Properties

- **`Name`**: No description provided
- **`Type`**: No description provided
- **`Domain`**: No description provided
- **`ExpiresAt`**: No description provided
11 changes: 11 additions & 0 deletions docs/resources/compute-target-http-proxy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Compute Target HTTP Proxy

## Details

- **Type:** `ComputeTargetHTTPProxy`
- **Scope:** project

## Properties

- **`Name`**: No description provided
- **`CreatedAt`**: No description provided
13 changes: 13 additions & 0 deletions docs/resources/compute-target-https-proxy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Compute Target HTTPS Proxy

## Details

- **Type:** `ComputeTargetHTTPSProxy`
- **Scope:** project

## Properties

- **`Name`**: No description provided
- **`Type`**: No description provided
- **`Domain`**: No description provided
- **`ExpiresAt`**: No description provided
11 changes: 11 additions & 0 deletions docs/resources/compute-url-map.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Compute URL Map

## Details

- **Type:** `ComputeURLMap`
- **Scope:** project

## Properties

- **`Name`**: No description provided
- **`CreatedAt`**: No description provided
14 changes: 14 additions & 0 deletions docs/resources/dns-managed-zone.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# DNS Managed Zone

## Details

- **Type:** `DNSManagedZone`
- **Scope:** project

## Properties

- **`Name`**: Name of the managed zone
- **`DNSName`**: DNS name of the managed zone
- **`CreationTime`**: Creation time of the managed zone
- **`Visibility`**: No description provided
- **`Labels`**: Labels of the managed zone
10 changes: 10 additions & 0 deletions docs/resources/firebase-auth-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Firebase Auth Provider

## Details

- **Type:** `FirebaseAuthProvider`
- **Scope:** project

## Properties

- **`Name`**: No description provided
11 changes: 11 additions & 0 deletions docs/resources/firebase-o-auth-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Firebase O Auth Provider

## Details

- **Type:** `FirebaseOAuthProvider`
- **Scope:** project

## Properties

- **`Name`**: The name of the OAuth provider
- **`Type`**: The type of the OAuth provider, either builtin or custom
11 changes: 11 additions & 0 deletions docs/resources/firebase-oauth-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Firebase O Auth Provider

## Details

- **Type:** `FirebaseOAuthProvider`
- **Scope:** project

## Properties

- **`Name`**: The name of the OAuth provider
- **`Type`**: The type of the OAuth provider, either builtin or custom
18 changes: 18 additions & 0 deletions docs/resources/firebase-realtime-database.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Firebase Realtime Database

## Details

- **Type:** `FirebaseRealtimeDatabase`
- **Scope:** project

## Properties

- **`URL`**: No description provided
- **`Project`**: No description provided
- **`Region`**: No description provided
- **`Name`**: No description provided
- **`Type`**: No description provided
- **`State`**: No description provided
## Settings

- `EmptyDefaultDatabase`
12 changes: 12 additions & 0 deletions docs/resources/firebase-web-app.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Firebase Web App

## Details

- **Type:** `FirebaseWebApp`
- **Scope:** project

## Properties

- **`DisplayName`**: No description provided
- **`AppID`**: No description provided
- **`State`**: No description provided
11 changes: 11 additions & 0 deletions docs/resources/firestore-database.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Firestore Database

## Details

- **Type:** `FirestoreDatabase`
- **Scope:** project

## Properties

- **`Name`**: No description provided
- **`Location`**: No description provided
14 changes: 14 additions & 0 deletions docs/resources/gke-cluster.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# GKE Cluster

## Details

- **Type:** `GKECluster`
- **Scope:** project

## Properties

- **`Zone`**: No description provided
- **`Status`**: No description provided
- **`Project`**: No description provided
- **`Region`**: No description provided
- **`Name`**: No description provided
17 changes: 17 additions & 0 deletions docs/resources/iam-policy-binding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# IAM Policy Binding

## Details

- **Type:** `IAMPolicyBinding`
- **Scope:** project

## Properties

- **`Role`**: No description provided
- **`Member`**: No description provided
- **`MemberType`**: No description provided
- **`IsDeleted`**: No description provided
- **`GoogleManaged`**: No description provided
## Settings

- `DeleteGoogleManaged`
13 changes: 13 additions & 0 deletions docs/resources/iam-role.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# IAM Role

## Details

- **Type:** `IAMRole`
- **Scope:** project

## Properties

- **`Stage`**: No description provided
- **`Etag`**: No description provided
- **`Deleted`**: No description provided
- **`Name`**: No description provided
16 changes: 16 additions & 0 deletions docs/resources/iam-service-account-key.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# IAM Service Account Key

## Details

- **Type:** `IAMServiceAccountKey`
- **Scope:** project

## Properties

- **`Algorithm`**: No description provided
- **`ManagedType`**: No description provided
- **`ServiceAccount`**: No description provided
- **`ServiceAccountID`**: No description provided
- **`ServiceAccountEmail`**: No description provided
- **`Disabled`**: No description provided
- **`ID`**: No description provided
Loading

0 comments on commit 988c0dc

Please sign in to comment.