diff --git a/generated/1.17/README.adoc b/generated/1.17/README.adoc index 2da1ff99..70c3317e 100644 --- a/generated/1.17/README.adoc +++ b/generated/1.17/README.adoc @@ -5,20 +5,10 @@ == API Reference .Packages -- xref:{anchor_prefix}-crd-pinniped-dev-crdpinniped[$$crd.pinniped.dev/crdpinniped$$] - xref:{anchor_prefix}-crd-pinniped-dev-v1alpha1[$$crd.pinniped.dev/v1alpha1$$] -- xref:{anchor_prefix}-pinniped-dev-pinniped[$$pinniped.dev/pinniped$$] - xref:{anchor_prefix}-pinniped-dev-v1alpha1[$$pinniped.dev/v1alpha1$$] -[id="{anchor_prefix}-crd-pinniped-dev-crdpinniped"] -=== crd.pinniped.dev/crdpinniped - -Package crdpinniped is the internal version of the API. - - - - [id="{anchor_prefix}-crd-pinniped-dev-v1alpha1"] === crd.pinniped.dev/v1alpha1 @@ -105,108 +95,6 @@ Package v1alpha1 is the v1alpha1 version of the API. -[id="{anchor_prefix}-pinniped-dev-pinniped"] -=== pinniped.dev/pinniped - -Package pinniped is the internal version of the API. - - - -[id="{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-17-apis-pinniped-credentialrequest"] -==== CredentialRequest - - - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-17-apis-pinniped-credentialrequestlist[$$CredentialRequestList$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`ObjectMeta`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.17/#objectmeta-v1-meta[$$ObjectMeta$$]__ | -| *`Spec`* __xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-17-apis-pinniped-credentialrequestspec[$$CredentialRequestSpec$$]__ | -| *`Status`* __xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-17-apis-pinniped-credentialrequeststatus[$$CredentialRequestStatus$$]__ | -|=== - - -[id="{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-17-apis-pinniped-credentialrequestcredential"] -==== CredentialRequestCredential - - - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-17-apis-pinniped-credentialrequeststatus[$$CredentialRequestStatus$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`ExpirationTimestamp`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.17/#time-v1-meta[$$Time$$]__ | ExpirationTimestamp indicates a time when the provided credentials expire. -| *`Token`* __string__ | Token is a bearer token used by the client for request authentication. -| *`ClientCertificateData`* __string__ | PEM-encoded client TLS certificates (including intermediates, if any). -| *`ClientKeyData`* __string__ | PEM-encoded private key for the above certificate. -|=== - - - - -[id="{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-17-apis-pinniped-credentialrequestspec"] -==== CredentialRequestSpec - - - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-17-apis-pinniped-credentialrequest[$$CredentialRequest$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`Type`* __CredentialType__ | Type of credential. -| *`Token`* __xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-17-apis-pinniped-credentialrequesttokencredential[$$CredentialRequestTokenCredential$$]__ | Token credential (when Type == TokenCredentialType). -|=== - - -[id="{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-17-apis-pinniped-credentialrequeststatus"] -==== CredentialRequestStatus - - - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-17-apis-pinniped-credentialrequest[$$CredentialRequest$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`Credential`* __xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-17-apis-pinniped-credentialrequestcredential[$$CredentialRequestCredential$$]__ | A Credential will be returned for a successful credential request. -| *`Message`* __string__ | An error message will be returned for an unsuccessful credential request. -|=== - - -[id="{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-17-apis-pinniped-credentialrequesttokencredential"] -==== CredentialRequestTokenCredential - - - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-17-apis-pinniped-credentialrequestspec[$$CredentialRequestSpec$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`Value`* __string__ | Value of the bearer token supplied with the credential request. -|=== - - - [id="{anchor_prefix}-pinniped-dev-v1alpha1"] === pinniped.dev/v1alpha1 diff --git a/generated/1.18/README.adoc b/generated/1.18/README.adoc index 31e15b78..23e90b60 100644 --- a/generated/1.18/README.adoc +++ b/generated/1.18/README.adoc @@ -5,20 +5,10 @@ == API Reference .Packages -- xref:{anchor_prefix}-crd-pinniped-dev-crdpinniped[$$crd.pinniped.dev/crdpinniped$$] - xref:{anchor_prefix}-crd-pinniped-dev-v1alpha1[$$crd.pinniped.dev/v1alpha1$$] -- xref:{anchor_prefix}-pinniped-dev-pinniped[$$pinniped.dev/pinniped$$] - xref:{anchor_prefix}-pinniped-dev-v1alpha1[$$pinniped.dev/v1alpha1$$] -[id="{anchor_prefix}-crd-pinniped-dev-crdpinniped"] -=== crd.pinniped.dev/crdpinniped - -Package crdpinniped is the internal version of the API. - - - - [id="{anchor_prefix}-crd-pinniped-dev-v1alpha1"] === crd.pinniped.dev/v1alpha1 @@ -105,108 +95,6 @@ Package v1alpha1 is the v1alpha1 version of the API. -[id="{anchor_prefix}-pinniped-dev-pinniped"] -=== pinniped.dev/pinniped - -Package pinniped is the internal version of the API. - - - -[id="{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-18-apis-pinniped-credentialrequest"] -==== CredentialRequest - - - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-18-apis-pinniped-credentialrequestlist[$$CredentialRequestList$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`ObjectMeta`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta[$$ObjectMeta$$]__ | -| *`Spec`* __xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-18-apis-pinniped-credentialrequestspec[$$CredentialRequestSpec$$]__ | -| *`Status`* __xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-18-apis-pinniped-credentialrequeststatus[$$CredentialRequestStatus$$]__ | -|=== - - -[id="{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-18-apis-pinniped-credentialrequestcredential"] -==== CredentialRequestCredential - - - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-18-apis-pinniped-credentialrequeststatus[$$CredentialRequestStatus$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`ExpirationTimestamp`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#time-v1-meta[$$Time$$]__ | ExpirationTimestamp indicates a time when the provided credentials expire. -| *`Token`* __string__ | Token is a bearer token used by the client for request authentication. -| *`ClientCertificateData`* __string__ | PEM-encoded client TLS certificates (including intermediates, if any). -| *`ClientKeyData`* __string__ | PEM-encoded private key for the above certificate. -|=== - - - - -[id="{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-18-apis-pinniped-credentialrequestspec"] -==== CredentialRequestSpec - - - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-18-apis-pinniped-credentialrequest[$$CredentialRequest$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`Type`* __CredentialType__ | Type of credential. -| *`Token`* __xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-18-apis-pinniped-credentialrequesttokencredential[$$CredentialRequestTokenCredential$$]__ | Token credential (when Type == TokenCredentialType). -|=== - - -[id="{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-18-apis-pinniped-credentialrequeststatus"] -==== CredentialRequestStatus - - - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-18-apis-pinniped-credentialrequest[$$CredentialRequest$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`Credential`* __xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-18-apis-pinniped-credentialrequestcredential[$$CredentialRequestCredential$$]__ | A Credential will be returned for a successful credential request. -| *`Message`* __string__ | An error message will be returned for an unsuccessful credential request. -|=== - - -[id="{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-18-apis-pinniped-credentialrequesttokencredential"] -==== CredentialRequestTokenCredential - - - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-18-apis-pinniped-credentialrequestspec[$$CredentialRequestSpec$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`Value`* __string__ | Value of the bearer token supplied with the credential request. -|=== - - - [id="{anchor_prefix}-pinniped-dev-v1alpha1"] === pinniped.dev/v1alpha1 diff --git a/generated/1.19/README.adoc b/generated/1.19/README.adoc index cef14a7e..dd0c7471 100644 --- a/generated/1.19/README.adoc +++ b/generated/1.19/README.adoc @@ -5,20 +5,10 @@ == API Reference .Packages -- xref:{anchor_prefix}-crd-pinniped-dev-crdpinniped[$$crd.pinniped.dev/crdpinniped$$] - xref:{anchor_prefix}-crd-pinniped-dev-v1alpha1[$$crd.pinniped.dev/v1alpha1$$] -- xref:{anchor_prefix}-pinniped-dev-pinniped[$$pinniped.dev/pinniped$$] - xref:{anchor_prefix}-pinniped-dev-v1alpha1[$$pinniped.dev/v1alpha1$$] -[id="{anchor_prefix}-crd-pinniped-dev-crdpinniped"] -=== crd.pinniped.dev/crdpinniped - -Package crdpinniped is the internal version of the API. - - - - [id="{anchor_prefix}-crd-pinniped-dev-v1alpha1"] === crd.pinniped.dev/v1alpha1 @@ -105,108 +95,6 @@ Package v1alpha1 is the v1alpha1 version of the API. -[id="{anchor_prefix}-pinniped-dev-pinniped"] -=== pinniped.dev/pinniped - -Package pinniped is the internal version of the API. - - - -[id="{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-19-apis-pinniped-credentialrequest"] -==== CredentialRequest - - - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-19-apis-pinniped-credentialrequestlist[$$CredentialRequestList$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`ObjectMeta`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#objectmeta-v1-meta[$$ObjectMeta$$]__ | -| *`Spec`* __xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-19-apis-pinniped-credentialrequestspec[$$CredentialRequestSpec$$]__ | -| *`Status`* __xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-19-apis-pinniped-credentialrequeststatus[$$CredentialRequestStatus$$]__ | -|=== - - -[id="{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-19-apis-pinniped-credentialrequestcredential"] -==== CredentialRequestCredential - - - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-19-apis-pinniped-credentialrequeststatus[$$CredentialRequestStatus$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`ExpirationTimestamp`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#time-v1-meta[$$Time$$]__ | ExpirationTimestamp indicates a time when the provided credentials expire. -| *`Token`* __string__ | Token is a bearer token used by the client for request authentication. -| *`ClientCertificateData`* __string__ | PEM-encoded client TLS certificates (including intermediates, if any). -| *`ClientKeyData`* __string__ | PEM-encoded private key for the above certificate. -|=== - - - - -[id="{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-19-apis-pinniped-credentialrequestspec"] -==== CredentialRequestSpec - - - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-19-apis-pinniped-credentialrequest[$$CredentialRequest$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`Type`* __CredentialType__ | Type of credential. -| *`Token`* __xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-19-apis-pinniped-credentialrequesttokencredential[$$CredentialRequestTokenCredential$$]__ | Token credential (when Type == TokenCredentialType). -|=== - - -[id="{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-19-apis-pinniped-credentialrequeststatus"] -==== CredentialRequestStatus - - - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-19-apis-pinniped-credentialrequest[$$CredentialRequest$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`Credential`* __xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-19-apis-pinniped-credentialrequestcredential[$$CredentialRequestCredential$$]__ | A Credential will be returned for a successful credential request. -| *`Message`* __string__ | An error message will be returned for an unsuccessful credential request. -|=== - - -[id="{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-19-apis-pinniped-credentialrequesttokencredential"] -==== CredentialRequestTokenCredential - - - -.Appears In: -**** -- xref:{anchor_prefix}-github-com-suzerain-io-pinniped-generated-1-19-apis-pinniped-credentialrequestspec[$$CredentialRequestSpec$$] -**** - -[cols="25a,75a", options="header"] -|=== -| Field | Description -| *`Value`* __string__ | Value of the bearer token supplied with the credential request. -|=== - - - [id="{anchor_prefix}-pinniped-dev-v1alpha1"] === pinniped.dev/v1alpha1 diff --git a/hack/lib/docs/config.yaml b/hack/lib/docs/config.yaml index aaa4bc6e..9ecc75a2 100644 --- a/hack/lib/docs/config.yaml +++ b/hack/lib/docs/config.yaml @@ -1,6 +1,10 @@ # Configuration file for https://github.com/elastic/crd-ref-docs processor: - ignoreTypes: [] + + # Ignore internal API versions + ignoreGroupVersions: + - "crd.pinniped.dev/crdpinniped" + - "pinniped.dev/pinniped" ignoreFields: - "TypeMeta$"