Skip to content

Commit

Permalink
fix: add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
uanid committed Jan 5, 2024
1 parent afd85b8 commit e85e766
Show file tree
Hide file tree
Showing 4 changed files with 138 additions and 0 deletions.
65 changes: 65 additions & 0 deletions docs/data-sources/account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "bluechip_account Data Source - terraform-provider-bluechip"
subcategory: ""
description: |-
---

# bluechip_account (Data Source)





<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- `metadata` (Block List) (see [below for nested schema](#nestedblock--metadata))
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- `id` (String) The ID of this resource.
- `spec` (List of Object) (see [below for nested schema](#nestedatt--spec))

<a id="nestedblock--metadata"></a>
### Nested Schema for `metadata`

Required:

- `name` (String) Name is the name of the resource.
- `namespace` (String) Namespace is the namespace of the resource.

Optional:

- `annotations` (Map of String) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
- `labels` (Map of String) Labels are key value pairs that may be used to scope and select individual resources. They are not queryable and should be preserved when modifying objects.

Read-Only:

- `creation_timestamp` (String) CreationTimestamp is a timestamp representing the server time when this object was created.
- `update_timestamp` (String) UpdateTimestamp is a timestamp representing the server time when this object was last updated.


<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- `default` (String)


<a id="nestedatt--spec"></a>
### Nested Schema for `spec`

Read-Only:

- `account_id` (String)
- `alias` (String)
- `description` (String)
- `display_name` (String)
- `regions` (Set of String)
- `vendor` (String)
1 change: 1 addition & 0 deletions docs/data-sources/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,5 +56,6 @@ Optional:

Read-Only:

- `attributes` (Map of String)
- `groups` (Set of String)
- `password` (String)
68 changes: 68 additions & 0 deletions docs/resources/account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "bluechip_account Resource - terraform-provider-bluechip"
subcategory: ""
description: |-
---

# bluechip_account (Resource)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `metadata` (Block List, Min: 1) (see [below for nested schema](#nestedblock--metadata))
- `spec` (Block List, Min: 1) (see [below for nested schema](#nestedblock--spec))

### Optional

- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

- `id` (String) The ID of this resource.

<a id="nestedblock--metadata"></a>
### Nested Schema for `metadata`

Required:

- `name` (String) Name is the name of the resource.
- `namespace` (String) Namespace is the namespace of the resource.

Optional:

- `annotations` (Map of String) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.
- `labels` (Map of String) Labels are key value pairs that may be used to scope and select individual resources. They are not queryable and should be preserved when modifying objects.

Read-Only:

- `creation_timestamp` (String) CreationTimestamp is a timestamp representing the server time when this object was created.
- `update_timestamp` (String) UpdateTimestamp is a timestamp representing the server time when this object was last updated.


<a id="nestedblock--spec"></a>
### Nested Schema for `spec`

Required:

- `account_id` (String)
- `alias` (String)
- `description` (String)
- `display_name` (String)
- `regions` (Set of String)
- `vendor` (String)


<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- `default` (String)
4 changes: 4 additions & 0 deletions docs/resources/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@ Required:
- `groups` (Set of String)
- `password` (String)

Optional:

- `attributes` (Map of String)


<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`
Expand Down

0 comments on commit e85e766

Please sign in to comment.