pulumi-kubernetes 4.17.0a1723576835__py3-none-any.whl → 4.26.0a1769215986__py3-none-any.whl

pulumi_kubernetes/kustomize/v2/Directory.py

@@ -2,7 +2,7 @@
 # *** WARNING: this file was generated by pulumigen. ***
 # *** Do not edit by hand unless you're certain you know what you are doing! ***
 
-import copy
+import builtins as _builtins
 import warnings
 import sys
 import pulumi
@@ -19,19 +19,19 @@ __all__ = ['DirectoryArgs', 'Directory']
 @pulumi.input_type
 class DirectoryArgs:
     def __init__(__self__, *,
-                 directory: pulumi.Input[str],
-                 namespace: Optional[pulumi.Input[str]] = None,
-                 resource_prefix: Optional[pulumi.Input[str]] = None,
-                 skip_await: Optional[pulumi.Input[bool]] = None):
+                 directory: pulumi.Input[_builtins.str],
+                 namespace: Optional[pulumi.Input[_builtins.str]] = None,
+                 resource_prefix: Optional[pulumi.Input[_builtins.str]] = None,
+                 skip_await: Optional[pulumi.Input[_builtins.bool]] = None):
         """
         The set of arguments for constructing a Directory resource.
-        :param pulumi.Input[str] directory: The directory containing the kustomization to apply. The value can be a local directory or a folder in a
+        :param pulumi.Input[_builtins.str] directory: The directory containing the kustomization to apply. The value can be a local directory or a folder in a
                git repository.
                Example: ./helloWorld
                Example: https://github.com/kubernetes-sigs/kustomize/tree/master/examples/helloWorld
-        :param pulumi.Input[str] namespace: The default namespace to apply to the resources. Defaults to the provider's namespace.
-        :param pulumi.Input[str] resource_prefix: A prefix for the auto-generated resource names. Defaults to the name of the Directory resource. Example: A resource created with resourcePrefix="foo" would produce a resource named "foo:resourceName".
-        :param pulumi.Input[bool] skip_await: Indicates that child resources should skip the await logic.
+        :param pulumi.Input[_builtins.str] namespace: The default namespace to apply to the resources. Defaults to the provider's namespace.
+        :param pulumi.Input[_builtins.str] resource_prefix: A prefix for the auto-generated resource names. Defaults to the name of the Directory resource. Example: A resource created with resourcePrefix="foo" would produce a resource named "foo:resourceName".
+        :param pulumi.Input[_builtins.bool] skip_await: Indicates that child resources should skip the await logic.
         """
         pulumi.set(__self__, "directory", directory)
         if namespace is not None:
@@ -41,9 +41,9 @@ class DirectoryArgs:
         if skip_await is not None:
             pulumi.set(__self__, "skip_await", skip_await)
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def directory(self) -> pulumi.Input[str]:
+    def directory(self) -> pulumi.Input[_builtins.str]:
         """
         The directory containing the kustomization to apply. The value can be a local directory or a folder in a
         git repository.
@@ -53,55 +53,56 @@ class DirectoryArgs:
         return pulumi.get(self, "directory")
 
     @directory.setter
-    def directory(self, value: pulumi.Input[str]):
+    def directory(self, value: pulumi.Input[_builtins.str]):
         pulumi.set(self, "directory", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def namespace(self) -> Optional[pulumi.Input[str]]:
+    def namespace(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         The default namespace to apply to the resources. Defaults to the provider's namespace.
         """
         return pulumi.get(self, "namespace")
 
     @namespace.setter
-    def namespace(self, value: Optional[pulumi.Input[str]]):
+    def namespace(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "namespace", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="resourcePrefix")
-    def resource_prefix(self) -> Optional[pulumi.Input[str]]:
+    def resource_prefix(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         A prefix for the auto-generated resource names. Defaults to the name of the Directory resource. Example: A resource created with resourcePrefix="foo" would produce a resource named "foo:resourceName".
         """
         return pulumi.get(self, "resource_prefix")
 
     @resource_prefix.setter
-    def resource_prefix(self, value: Optional[pulumi.Input[str]]):
+    def resource_prefix(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "resource_prefix", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="skipAwait")
-    def skip_await(self) -> Optional[pulumi.Input[bool]]:
+    def skip_await(self) -> Optional[pulumi.Input[_builtins.bool]]:
         """
         Indicates that child resources should skip the await logic.
         """
         return pulumi.get(self, "skip_await")
 
     @skip_await.setter
-    def skip_await(self, value: Optional[pulumi.Input[bool]]):
+    def skip_await(self, value: Optional[pulumi.Input[_builtins.bool]]):
         pulumi.set(self, "skip_await", value)
 
 
+@pulumi.type_token("kubernetes:kustomize/v2:Directory")
 class Directory(pulumi.ComponentResource):
     @overload
     def __init__(__self__,
                  resource_name: str,
                  opts: Optional[pulumi.ResourceOptions] = None,
-                 directory: Optional[pulumi.Input[str]] = None,
-                 namespace: Optional[pulumi.Input[str]] = None,
-                 resource_prefix: Optional[pulumi.Input[str]] = None,
-                 skip_await: Optional[pulumi.Input[bool]] = None,
+                 directory: Optional[pulumi.Input[_builtins.str]] = None,
+                 namespace: Optional[pulumi.Input[_builtins.str]] = None,
+                 resource_prefix: Optional[pulumi.Input[_builtins.str]] = None,
+                 skip_await: Optional[pulumi.Input[_builtins.bool]] = None,
                  __props__=None):
         """
         Directory is a component representing a collection of resources described by a kustomize directory (kustomization).
@@ -128,13 +129,13 @@ class Directory(pulumi.ComponentResource):
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
-        :param pulumi.Input[str] directory: The directory containing the kustomization to apply. The value can be a local directory or a folder in a
+        :param pulumi.Input[_builtins.str] directory: The directory containing the kustomization to apply. The value can be a local directory or a folder in a
                git repository.
                Example: ./helloWorld
                Example: https://github.com/kubernetes-sigs/kustomize/tree/master/examples/helloWorld
-        :param pulumi.Input[str] namespace: The default namespace to apply to the resources. Defaults to the provider's namespace.
-        :param pulumi.Input[str] resource_prefix: A prefix for the auto-generated resource names. Defaults to the name of the Directory resource. Example: A resource created with resourcePrefix="foo" would produce a resource named "foo:resourceName".
-        :param pulumi.Input[bool] skip_await: Indicates that child resources should skip the await logic.
+        :param pulumi.Input[_builtins.str] namespace: The default namespace to apply to the resources. Defaults to the provider's namespace.
+        :param pulumi.Input[_builtins.str] resource_prefix: A prefix for the auto-generated resource names. Defaults to the name of the Directory resource. Example: A resource created with resourcePrefix="foo" would produce a resource named "foo:resourceName".
+        :param pulumi.Input[_builtins.bool] skip_await: Indicates that child resources should skip the await logic.
         """
         ...
     @overload
@@ -180,10 +181,10 @@ class Directory(pulumi.ComponentResource):
     def _internal_init(__self__,
                  resource_name: str,
                  opts: Optional[pulumi.ResourceOptions] = None,
-                 directory: Optional[pulumi.Input[str]] = None,
-                 namespace: Optional[pulumi.Input[str]] = None,
-                 resource_prefix: Optional[pulumi.Input[str]] = None,
-                 skip_await: Optional[pulumi.Input[bool]] = None,
+                 directory: Optional[pulumi.Input[_builtins.str]] = None,
+                 namespace: Optional[pulumi.Input[_builtins.str]] = None,
+                 resource_prefix: Optional[pulumi.Input[_builtins.str]] = None,
+                 skip_await: Optional[pulumi.Input[_builtins.bool]] = None,
                  __props__=None):
         opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
         if not isinstance(opts, pulumi.ResourceOptions):
@@ -209,9 +210,9 @@ class Directory(pulumi.ComponentResource):
             opts,
             remote=True)
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def resources(self) -> pulumi.Output[Optional[str]]:
+    def resources(self) -> pulumi.Output[Optional[_builtins.str]]:
         """
         Resources created by the Directory resource.
         """

pulumi_kubernetes/kustomize/v2/__init__.py

@@ -2,6 +2,7 @@
 # *** WARNING: this file was generated by pulumigen. ***
 # *** Do not edit by hand unless you're certain you know what you are doing! ***
 
+import builtins as _builtins
 from ... import _utilities
 import typing
 # Export this package's modules as members:

pulumi_kubernetes/meta/__init__.py

@@ -2,6 +2,7 @@
 # *** WARNING: this file was generated by pulumigen. ***
 # *** Do not edit by hand unless you're certain you know what you are doing! ***
 
+import builtins as _builtins
 from .. import _utilities
 import typing
 

pulumi_kubernetes/meta/v1/Status.py

@@ -2,7 +2,7 @@
 # *** WARNING: this file was generated by pulumigen. ***
 # *** Do not edit by hand unless you're certain you know what you are doing! ***
 
-import copy
+import builtins as _builtins
 import warnings
 import sys
 import pulumi
@@ -21,22 +21,22 @@ __all__ = ['StatusArgs', 'Status']
 @pulumi.input_type
 class StatusArgs:
     def __init__(__self__, *,
-                 api_version: Optional[pulumi.Input[str]] = None,
-                 code: Optional[pulumi.Input[int]] = None,
+                 api_version: Optional[pulumi.Input[_builtins.str]] = None,
+                 code: Optional[pulumi.Input[_builtins.int]] = None,
                  details: Optional[pulumi.Input['StatusDetailsArgs']] = None,
-                 kind: Optional[pulumi.Input[str]] = None,
-                 message: Optional[pulumi.Input[str]] = None,
+                 kind: Optional[pulumi.Input[_builtins.str]] = None,
+                 message: Optional[pulumi.Input[_builtins.str]] = None,
                  metadata: Optional[pulumi.Input['ListMetaArgs']] = None,
-                 reason: Optional[pulumi.Input[str]] = None):
+                 reason: Optional[pulumi.Input[_builtins.str]] = None):
         """
         The set of arguments for constructing a Status resource.
-        :param pulumi.Input[str] api_version: APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
-        :param pulumi.Input[int] code: Suggested HTTP return code for this status, 0 if not set.
+        :param pulumi.Input[_builtins.str] api_version: APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+        :param pulumi.Input[_builtins.int] code: Suggested HTTP return code for this status, 0 if not set.
         :param pulumi.Input['StatusDetailsArgs'] details: Extended data associated with the reason.  Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
-        :param pulumi.Input[str] kind: Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
-        :param pulumi.Input[str] message: A human-readable description of the status of this operation.
+        :param pulumi.Input[_builtins.str] kind: Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+        :param pulumi.Input[_builtins.str] message: A human-readable description of the status of this operation.
         :param pulumi.Input['ListMetaArgs'] metadata: Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
-        :param pulumi.Input[str] reason: A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
+        :param pulumi.Input[_builtins.str] reason: A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
         """
         if api_version is not None:
             pulumi.set(__self__, "api_version", 'v1')
@@ -53,31 +53,31 @@ class StatusArgs:
         if reason is not None:
             pulumi.set(__self__, "reason", reason)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="apiVersion")
-    def api_version(self) -> Optional[pulumi.Input[str]]:
+    def api_version(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
         """
         return pulumi.get(self, "api_version")
 
     @api_version.setter
-    def api_version(self, value: Optional[pulumi.Input[str]]):
+    def api_version(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "api_version", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def code(self) -> Optional[pulumi.Input[int]]:
+    def code(self) -> Optional[pulumi.Input[_builtins.int]]:
         """
         Suggested HTTP return code for this status, 0 if not set.
         """
         return pulumi.get(self, "code")
 
     @code.setter
-    def code(self, value: Optional[pulumi.Input[int]]):
+    def code(self, value: Optional[pulumi.Input[_builtins.int]]):
         pulumi.set(self, "code", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter
     def details(self) -> Optional[pulumi.Input['StatusDetailsArgs']]:
         """
@@ -89,31 +89,31 @@ class StatusArgs:
     def details(self, value: Optional[pulumi.Input['StatusDetailsArgs']]):
         pulumi.set(self, "details", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def kind(self) -> Optional[pulumi.Input[str]]:
+    def kind(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
         """
         return pulumi.get(self, "kind")
 
     @kind.setter
-    def kind(self, value: Optional[pulumi.Input[str]]):
+    def kind(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "kind", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def message(self) -> Optional[pulumi.Input[str]]:
+    def message(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         A human-readable description of the status of this operation.
         """
         return pulumi.get(self, "message")
 
     @message.setter
-    def message(self, value: Optional[pulumi.Input[str]]):
+    def message(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "message", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter
     def metadata(self) -> Optional[pulumi.Input['ListMetaArgs']]:
         """
@@ -125,44 +125,45 @@ class StatusArgs:
     def metadata(self, value: Optional[pulumi.Input['ListMetaArgs']]):
         pulumi.set(self, "metadata", value)
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def reason(self) -> Optional[pulumi.Input[str]]:
+    def reason(self) -> Optional[pulumi.Input[_builtins.str]]:
         """
         A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
         """
         return pulumi.get(self, "reason")
 
     @reason.setter
-    def reason(self, value: Optional[pulumi.Input[str]]):
+    def reason(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "reason", value)
 
 
+@pulumi.type_token("kubernetes:meta/v1:Status")
 class Status(pulumi.CustomResource):
     @overload
     def __init__(__self__,
                  resource_name: str,
                  opts: Optional[pulumi.ResourceOptions] = None,
-                 api_version: Optional[pulumi.Input[str]] = None,
-                 code: Optional[pulumi.Input[int]] = None,
+                 api_version: Optional[pulumi.Input[_builtins.str]] = None,
+                 code: Optional[pulumi.Input[_builtins.int]] = None,
                  details: Optional[pulumi.Input[Union['StatusDetailsArgs', 'StatusDetailsArgsDict']]] = None,
-                 kind: Optional[pulumi.Input[str]] = None,
-                 message: Optional[pulumi.Input[str]] = None,
+                 kind: Optional[pulumi.Input[_builtins.str]] = None,
+                 message: Optional[pulumi.Input[_builtins.str]] = None,
                  metadata: Optional[pulumi.Input[Union['ListMetaArgs', 'ListMetaArgsDict']]] = None,
-                 reason: Optional[pulumi.Input[str]] = None,
+                 reason: Optional[pulumi.Input[_builtins.str]] = None,
                  __props__=None):
         """
         Status is a return value for calls that don't return other objects.
 
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
-        :param pulumi.Input[str] api_version: APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
-        :param pulumi.Input[int] code: Suggested HTTP return code for this status, 0 if not set.
+        :param pulumi.Input[_builtins.str] api_version: APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+        :param pulumi.Input[_builtins.int] code: Suggested HTTP return code for this status, 0 if not set.
         :param pulumi.Input[Union['StatusDetailsArgs', 'StatusDetailsArgsDict']] details: Extended data associated with the reason.  Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
-        :param pulumi.Input[str] kind: Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
-        :param pulumi.Input[str] message: A human-readable description of the status of this operation.
+        :param pulumi.Input[_builtins.str] kind: Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+        :param pulumi.Input[_builtins.str] message: A human-readable description of the status of this operation.
         :param pulumi.Input[Union['ListMetaArgs', 'ListMetaArgsDict']] metadata: Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
-        :param pulumi.Input[str] reason: A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
+        :param pulumi.Input[_builtins.str] reason: A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
         """
         ...
     @overload
@@ -188,13 +189,13 @@ class Status(pulumi.CustomResource):
     def _internal_init(__self__,
                  resource_name: str,
                  opts: Optional[pulumi.ResourceOptions] = None,
-                 api_version: Optional[pulumi.Input[str]] = None,
-                 code: Optional[pulumi.Input[int]] = None,
+                 api_version: Optional[pulumi.Input[_builtins.str]] = None,
+                 code: Optional[pulumi.Input[_builtins.int]] = None,
                  details: Optional[pulumi.Input[Union['StatusDetailsArgs', 'StatusDetailsArgsDict']]] = None,
-                 kind: Optional[pulumi.Input[str]] = None,
-                 message: Optional[pulumi.Input[str]] = None,
+                 kind: Optional[pulumi.Input[_builtins.str]] = None,
+                 message: Optional[pulumi.Input[_builtins.str]] = None,
                  metadata: Optional[pulumi.Input[Union['ListMetaArgs', 'ListMetaArgsDict']]] = None,
-                 reason: Optional[pulumi.Input[str]] = None,
+                 reason: Optional[pulumi.Input[_builtins.str]] = None,
                  __props__=None):
         opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
         if not isinstance(opts, pulumi.ResourceOptions):
@@ -244,23 +245,23 @@ class Status(pulumi.CustomResource):
         __props__.__dict__["status"] = None
         return Status(resource_name, opts=opts, __props__=__props__)
 
-    @property
+    @_builtins.property
     @pulumi.getter(name="apiVersion")
-    def api_version(self) -> pulumi.Output[str]:
+    def api_version(self) -> pulumi.Output[_builtins.str]:
         """
         APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
         """
         return pulumi.get(self, "api_version")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def code(self) -> pulumi.Output[int]:
+    def code(self) -> pulumi.Output[_builtins.int]:
         """
         Suggested HTTP return code for this status, 0 if not set.
         """
         return pulumi.get(self, "code")
 
-    @property
+    @_builtins.property
     @pulumi.getter
     def details(self) -> pulumi.Output['outputs.StatusDetails']:
         """
@@ -268,23 +269,23 @@ class Status(pulumi.CustomResource):
         """
         return pulumi.get(self, "details")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def kind(self) -> pulumi.Output[str]:
+    def kind(self) -> pulumi.Output[_builtins.str]:
         """
         Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
         """
         return pulumi.get(self, "kind")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def message(self) -> pulumi.Output[str]:
+    def message(self) -> pulumi.Output[_builtins.str]:
         """
         A human-readable description of the status of this operation.
         """
         return pulumi.get(self, "message")
 
-    @property
+    @_builtins.property
     @pulumi.getter
     def metadata(self) -> pulumi.Output['outputs.ListMeta']:
         """
@@ -292,17 +293,17 @@ class Status(pulumi.CustomResource):
         """
         return pulumi.get(self, "metadata")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def reason(self) -> pulumi.Output[str]:
+    def reason(self) -> pulumi.Output[_builtins.str]:
         """
         A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
         """
         return pulumi.get(self, "reason")
 
-    @property
+    @_builtins.property
     @pulumi.getter
-    def status(self) -> pulumi.Output[Optional[str]]:
+    def status(self) -> pulumi.Output[Optional[_builtins.str]]:
         """
         Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
         """