Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove List types from API reference #637

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Remove List types from API reference #637

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
160 changes: 8 additions & 152 deletions docs/api/api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,13 @@ Package v1beta1 contains API Schema definitions for the secrets v1beta1 API grou

### Resource Types
- [HCPAuth](#hcpauth)
- [HCPAuthList](#hcpauthlist)
- [HCPVaultSecretsApp](#hcpvaultsecretsapp)
- [HCPVaultSecretsAppList](#hcpvaultsecretsapplist)
- [SecretTransformation](#secrettransformation)
- [SecretTransformationList](#secrettransformationlist)
- [VaultAuth](#vaultauth)
- [VaultAuthList](#vaultauthlist)
- [VaultConnection](#vaultconnection)
- [VaultConnectionList](#vaultconnectionlist)
- [VaultDynamicSecret](#vaultdynamicsecret)
- [VaultDynamicSecretList](#vaultdynamicsecretlist)
- [VaultPKISecret](#vaultpkisecret)
- [VaultPKISecretList](#vaultpkisecretlist)
- [VaultStaticSecret](#vaultstaticsecret)
- [VaultStaticSecretList](#vaultstaticsecretlist)



Expand Down Expand Up @@ -57,8 +49,7 @@ _Appears in:_

HCPAuth is the Schema for the hcpauths API

_Appears in:_
- [HCPAuthList](#hcpauthlist)


| Field | Description |
| --- | --- |
Expand All @@ -68,22 +59,6 @@ _Appears in:_
| `spec` _[HCPAuthSpec](#hcpauthspec)_ | |


#### HCPAuthList



HCPAuthList contains a list of HCPAuth



| Field | Description |
| --- | --- |
| `apiVersion` _string_ | `secrets.hashicorp.com/v1beta1`
| `kind` _string_ | `HCPAuthList`
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` _[HCPAuth](#hcpauth) array_ | |


#### HCPAuthServicePrincipal


Expand Down Expand Up @@ -124,8 +99,7 @@ _Appears in:_

HCPVaultSecretsApp is the Schema for the hcpvaultsecretsapps API

_Appears in:_
- [HCPVaultSecretsAppList](#hcpvaultsecretsapplist)


| Field | Description |
| --- | --- |
Expand All @@ -135,22 +109,6 @@ _Appears in:_
| `spec` _[HCPVaultSecretsAppSpec](#hcpvaultsecretsappspec)_ | |


#### HCPVaultSecretsAppList



HCPVaultSecretsAppList contains a list of HCPVaultSecretsApp



| Field | Description |
| --- | --- |
| `apiVersion` _string_ | `secrets.hashicorp.com/v1beta1`
| `kind` _string_ | `HCPVaultSecretsAppList`
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` _[HCPVaultSecretsApp](#hcpvaultsecretsapp) array_ | |


#### HCPVaultSecretsAppSpec


Expand Down Expand Up @@ -196,8 +154,7 @@ _Appears in:_

SecretTransformation is the Schema for the secrettransformations API

_Appears in:_
- [SecretTransformationList](#secrettransformationlist)


| Field | Description |
| --- | --- |
Expand All @@ -207,22 +164,6 @@ _Appears in:_
| `spec` _[SecretTransformationSpec](#secrettransformationspec)_ | |


#### SecretTransformationList



SecretTransformationList contains a list of SecretTransformation



| Field | Description |
| --- | --- |
| `apiVersion` _string_ | `secrets.hashicorp.com/v1beta1`
| `kind` _string_ | `SecretTransformationList`
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` _[SecretTransformation](#secrettransformation) array_ | |


#### SecretTransformationSpec


Expand Down Expand Up @@ -345,8 +286,7 @@ _Appears in:_

VaultAuth is the Schema for the vaultauths API

_Appears in:_
- [VaultAuthList](#vaultauthlist)


| Field | Description |
| --- | --- |
Expand Down Expand Up @@ -445,22 +385,6 @@ _Appears in:_
| `tokenExpirationSeconds` _integer_ | TokenExpirationSeconds to set the ServiceAccount token. |


#### VaultAuthList



VaultAuthList contains a list of VaultAuth



| Field | Description |
| --- | --- |
| `apiVersion` _string_ | `secrets.hashicorp.com/v1beta1`
| `kind` _string_ | `VaultAuthList`
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` _[VaultAuth](#vaultauth) array_ | |


#### VaultAuthSpec


Expand Down Expand Up @@ -495,8 +419,7 @@ _Appears in:_

VaultConnection is the Schema for the vaultconnections API

_Appears in:_
- [VaultConnectionList](#vaultconnectionlist)


| Field | Description |
| --- | --- |
Expand All @@ -506,22 +429,6 @@ _Appears in:_
| `spec` _[VaultConnectionSpec](#vaultconnectionspec)_ | |


#### VaultConnectionList



VaultConnectionList contains a list of VaultConnection



| Field | Description |
| --- | --- |
| `apiVersion` _string_ | `secrets.hashicorp.com/v1beta1`
| `kind` _string_ | `VaultConnectionList`
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` _[VaultConnection](#vaultconnection) array_ | |


#### VaultConnectionSpec


Expand All @@ -548,8 +455,7 @@ _Appears in:_

VaultDynamicSecret is the Schema for the vaultdynamicsecrets API

_Appears in:_
- [VaultDynamicSecretList](#vaultdynamicsecretlist)


| Field | Description |
| --- | --- |
Expand All @@ -559,22 +465,6 @@ _Appears in:_
| `spec` _[VaultDynamicSecretSpec](#vaultdynamicsecretspec)_ | |


#### VaultDynamicSecretList



VaultDynamicSecretList contains a list of VaultDynamicSecret



| Field | Description |
| --- | --- |
| `apiVersion` _string_ | `secrets.hashicorp.com/v1beta1`
| `kind` _string_ | `VaultDynamicSecretList`
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` _[VaultDynamicSecret](#vaultdynamicsecret) array_ | |


#### VaultDynamicSecretSpec


Expand Down Expand Up @@ -607,8 +497,7 @@ _Appears in:_

VaultPKISecret is the Schema for the vaultpkisecrets API

_Appears in:_
- [VaultPKISecretList](#vaultpkisecretlist)


| Field | Description |
| --- | --- |
Expand All @@ -618,22 +507,6 @@ _Appears in:_
| `spec` _[VaultPKISecretSpec](#vaultpkisecretspec)_ | |


#### VaultPKISecretList



VaultPKISecretList contains a list of VaultPKISecret



| Field | Description |
| --- | --- |
| `apiVersion` _string_ | `secrets.hashicorp.com/v1beta1`
| `kind` _string_ | `VaultPKISecretList`
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` _[VaultPKISecret](#vaultpkisecret) array_ | |


#### VaultPKISecretSpec


Expand Down Expand Up @@ -710,8 +583,7 @@ _Appears in:_

VaultStaticSecret is the Schema for the vaultstaticsecrets API

_Appears in:_
- [VaultStaticSecretList](#vaultstaticsecretlist)


| Field | Description |
| --- | --- |
Expand All @@ -721,22 +593,6 @@ _Appears in:_
| `spec` _[VaultStaticSecretSpec](#vaultstaticsecretspec)_ | |


#### VaultStaticSecretList



VaultStaticSecretList contains a list of VaultStaticSecret



| Field | Description |
| --- | --- |
| `apiVersion` _string_ | `secrets.hashicorp.com/v1beta1`
| `kind` _string_ | `VaultStaticSecretList`
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
| `items` _[VaultStaticSecret](#vaultstaticsecret) array_ | |


#### VaultStaticSecretSpec


Expand Down
2 changes: 1 addition & 1 deletion docs/api/config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

processor:
# RE2 regular expressions describing types that should be excluded from the generated documentation.
ignoreTypes: []
ignoreTypes: [".*List$"]
# RE2 regular expressions describing type fields that should be excluded from the generated documentation.
ignoreFields:
- "status$"
Expand Down
Loading