diff --git a/docs/api/infrastructure.md b/docs/api/infrastructure.md index 2fb6b100..bd4594ed 100644 --- a/docs/api/infrastructure.md +++ b/docs/api/infrastructure.md @@ -3,6 +3,7 @@ Packages: - [infrastructure.miloapis.com/v1alpha1](#infrastructuremiloapiscomv1alpha1) +- [resourcemanager.miloapis.com/v1alpha1](#resourcemanagermiloapiscomv1alpha1) # infrastructure.miloapis.com/v1alpha1 @@ -10,165 +11,209 @@ Resource Types: - [ProjectControlPlane](#projectcontrolplane) +# resourcemanager.miloapis.com/v1alpha1 + +Resource Types: + +- [Vendor](#vendor) +- [CorporationTypeConfig](#corporationtypeconfig) +--- + ## ProjectControlPlane [↩ Parent](#infrastructuremiloapiscomv1alpha1 ) +ProjectControlPlane is the Schema for the projectcontrolplanes API. +
| Name | Type | Description | Required |
|---|---|---|---|
| apiVersion | string | infrastructure.miloapis.com/v1alpha1 | true |
| kind | string | ProjectControlPlane | true |
| metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
| spec | object | ProjectControlPlaneSpec defines the desired state of ProjectControlPlane. | true |
| status | object | ProjectControlPlaneStatus defines the observed state of ProjectControlPlane. Default: map[conditions:[map[lastTransitionTime:1970-01-01T00:00:00Z message:Creating a new control plane for the project reason:Creating status:False type:ControlPlaneReady]]] | false |
| Name | Type | Description | Required |
|---|---|---|---|
| conditions | +[]object | +
+Represents the observations of a project control plane's current state. Known condition types are: "Ready" + |
+false | +
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| apiVersion | -string | -infrastructure.miloapis.com/v1alpha1 | -true | -
| kind | -string | -ProjectControlPlane | -true | -
| metadata | -object | -Refer to the Kubernetes API documentation for the fields of the `metadata` field. | -true | -
| spec | -object | -
- ProjectControlPlaneSpec defines the desired state of ProjectControlPlane. - |
- true | -
| status | -object | -
- ProjectControlPlaneStatus defines the observed state of ProjectControlPlane. - - Default: map[conditions:[map[lastTransitionTime:1970-01-01T00:00:00Z message:Creating a new control plane for the project reason:Creating status:False type:ControlPlaneReady]]] - |
- false | -
| Name | Type | Description | Required |
| lastTransitionTime | +string | +lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time |
+true | +
| message | +string | +message is a human readable message indicating details about the transition. This may be an empty string. |
+true | +
| reason | +string | +reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. |
+true | +
| status | enum | status of the condition, one of True, False, Unknown. Enum: True, False, Unknown | true | +
| type | string | type of condition in CamelCase or in foo.example.com/CamelCase. | true | +
| observedGeneration | integer | observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0 | false | +
| Name | Type | Description | Required |
|---|---|---|---|
| apiVersion | string | resourcemanager.miloapis.com/v1alpha1 | true |
| kind | string | Vendor | true |
| metadata | object | Kubernetes standard object metadata. | true |
| spec | object | VendorSpec defines the desired state of Vendor. | true |
| status | object | VendorStatus defines the observed state of Vendor. | false |
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| conditions | -[]object | -
- Represents the observations of a project control plane's current state.
-Known condition types are: "Ready" - |
- false | -
| Name | Type | Description | Required |
| profileType | string (enum: person, business) | Profile type - person or business | true |
| legalName | string | Legal name of the vendor | true |
| nickname | string | Nickname or display name | false |
| billingAddress | object | Billing address (fields: street, street2, city, state, postalCode, country) | true |
| mailingAddress | object | Mailing address (same fields as billing) if different from billing | false |
| description | string | Description of the vendor | false |
| website | string | Website URL | false |
| status | string (enum: pending, active, rejected, archived) | Current status of the vendor (default: pending) | true |
| corporationType | string | Business-specific field for "business" profileTypes only; must match a code from CorporationTypeConfig | false |
| corporationDBA | string | Doing business as name | false |
| registrationNumber | string | Registration number | false |
| stateOfIncorporation | string | State of incorporation | false |
| taxInfo | object | Tax information (fields: taxIdType, taxId, country, taxDocument, taxVerified, verificationTimestamp) | true |
| Name | Type | Description | Required |
|---|---|---|---|
| observedGeneration | integer | Most recent generation observed for this Vendor by the controller. | false |
| conditions | []object | Represents the observations of a vendor's current state. Known condition types are: "Ready" | false |
| Name | Type | Description | Required |
|---|---|---|---|
| apiVersion | string | resourcemanager.miloapis.com/v1alpha1 | true |
| kind | string | CorporationTypeConfig | true |
| metadata | object | Kubernetes standard object metadata. | true |
| spec | object | CorporationTypeConfigSpec defines the desired state of CorporationTypeConfig. | true |
| status | object | CorporationTypeConfigStatus defines the observed state of CorporationTypeConfig. | false |
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| lastTransitionTime | -string | -
- lastTransitionTime is the last time the condition transitioned from one status to another.
-This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. - - Format: date-time - |
- true | -
| message | -string | -
- message is a human readable message indicating details about the transition.
-This may be an empty string. - |
- true | -
| reason | -string | -
- reason contains a programmatic identifier indicating the reason for the condition's last transition.
-Producers of specific condition types may define expected values and meanings for this field,
-and whether the values are considered a guaranteed API.
-The value should be a CamelCase string.
-This field may not be empty. - |
- true | -
| status | -enum | -
- status of the condition, one of True, False, Unknown. - - Enum: True, False, Unknown - |
- true | -
| type | -string | -
- type of condition in CamelCase or in foo.example.com/CamelCase. - |
- true | -
| observedGeneration | -integer | -
- observedGeneration represents the .metadata.generation that the condition was set based upon.
-For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
-with respect to the current state of the instance. - - Format: int64 - Minimum: 0 - |
- false | -
| Name | Type | Description | Required |
| active | boolean (default: true) | Whether this configuration is active | true |
| corporationTypes | []object | Available corporation types that can be selected for vendors | true |
| Name | Type | Description | Required |
|---|---|---|---|
| code | string | The unique identifier for this corporation type (pattern: ^[a-z0-9-]+$) | true |
| displayName | string | Human-readable display name | true |
| description | string | Optional description of this corporation type | false |
| enabled | boolean (default: true) | Whether this corporation type is currently available for selection | true |
| sortOrder | integer (default: 100) | Sort order for display purposes (lower numbers appear first) | true |
| Name | Type | Description | Required |
|---|---|---|---|
| observedGeneration | integer | Most recent generation observed for this CorporationTypeConfig by the controller. | false |
| activeTypeCount | integer | Number of active corporation types. | false |
| conditions | []object | Represents the observations of a corporation type config's current state. Known condition types are: "Ready" | false |
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| organizationRef | -object | -
- OrganizationRef is a reference to the Organization that the user is a member of. - |
- true | -
| userRef | -object | -
- UserRef is a reference to the User that is a member of the Organization. - |
- true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -
- Name is the name of resource being referenced - |
- true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| name | -string | -
- Name is the name of resource being referenced - |
- true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| conditions | -[]object | -
- Conditions provide conditions that represent the current status of the OrganizationMembership. - - Default: [map[lastTransitionTime:1970-01-01T00:00:00Z message:Waiting for control plane to reconcile reason:Unknown status:Unknown type:Ready]] - |
- false | -
| observedGeneration | -integer | -
- ObservedGeneration is the most recent generation observed for this OrganizationMembership by the controller. - - Format: int64 - |
- false | -
| organization | -object | -
- Organization contains information about the organization in the membership. - |
- false | -
| user | -object | -
- User contains information about the user in the membership. - |
- false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| lastTransitionTime | -string | -
- lastTransitionTime is the last time the condition transitioned from one status to another.
-This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. - - Format: date-time - |
- true | -
| message | -string | -
- message is a human readable message indicating details about the transition.
-This may be an empty string. - |
- true | -
| reason | -string | -
- reason contains a programmatic identifier indicating the reason for the condition's last transition.
-Producers of specific condition types may define expected values and meanings for this field,
-and whether the values are considered a guaranteed API.
-The value should be a CamelCase string.
-This field may not be empty. - |
- true | -
| status | -enum | -
- status of the condition, one of True, False, Unknown. - - Enum: True, False, Unknown - |
- true | -
| type | -string | -
- type of condition in CamelCase or in foo.example.com/CamelCase. - |
- true | -
| observedGeneration | -integer | -
- observedGeneration represents the .metadata.generation that the condition was set based upon.
-For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
-with respect to the current state of the instance. - - Format: int64 - Minimum: 0 - |
- false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| displayName | -string | -
- DisplayName is the display name of the organization in the membership. - |
- false | -
| type | -string | -
- Type is the type of the organization in the membership. - |
- false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| string | -
- Email is the email of the user in the membership. - |
- false | -|
| familyName | -string | -
- FamilyName is the family name of the user in the membership. - |
- false | -
| givenName | -string | -
- GivenName is the given name of the user in the membership. - |
- false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| apiVersion | -string | -resourcemanager.miloapis.com/v1alpha1 | -true | -
| kind | -string | -Organization | -true | -
| metadata | -object | -Refer to the Kubernetes API documentation for the fields of the `metadata` field. | -true | -
| spec | -object | -
- OrganizationSpec defines the desired state of Organization - |
- true | -
| status | -object | -
- OrganizationStatus defines the observed state of Organization - |
- false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| type | -enum | -
- The type of organization. - - Validations: - |
- true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| conditions | -[]object | -
- Conditions represents the observations of an organization's current state.
-Known condition types are: "Ready" - - Default: [map[lastTransitionTime:1970-01-01T00:00:00Z message:Waiting for control plane to reconcile reason:Unknown status:Unknown type:Ready]] - |
- false | -
| observedGeneration | -integer | -
- ObservedGeneration is the most recent generation observed for this Organization by the controller. - - Format: int64 - |
- false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| lastTransitionTime | -string | -
- lastTransitionTime is the last time the condition transitioned from one status to another.
-This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. - - Format: date-time - |
- true | -
| message | -string | -
- message is a human readable message indicating details about the transition.
-This may be an empty string. - |
- true | -
| reason | -string | -
- reason contains a programmatic identifier indicating the reason for the condition's last transition.
-Producers of specific condition types may define expected values and meanings for this field,
-and whether the values are considered a guaranteed API.
-The value should be a CamelCase string.
-This field may not be empty. - |
- true | -
| status | -enum | -
- status of the condition, one of True, False, Unknown. - - Enum: True, False, Unknown - |
- true | -
| type | -string | -
- type of condition in CamelCase or in foo.example.com/CamelCase. - |
- true | -
| observedGeneration | -integer | -
- observedGeneration represents the .metadata.generation that the condition was set based upon.
-For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
-with respect to the current state of the instance. - - Format: int64 - Minimum: 0 - |
- false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| apiVersion | -string | -resourcemanager.miloapis.com/v1alpha1 | -true | -
| kind | -string | -Project | -true | -
| metadata | -object | -Refer to the Kubernetes API documentation for the fields of the `metadata` field. | -true | -
| spec | -object | -
- ProjectSpec defines the desired state of Project. - |
- true | -
| status | -object | -
- ProjectStatus defines the observed state of Project. - |
- false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| ownerRef | -object | -
- OwnerRef is a reference to the owner of the project. Must be a valid
-resource. - |
- true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| kind | -enum | -
- Kind is the kind of the resource. - - Enum: Organization - |
- true | -
| name | -string | -
- Name is the name of the resource. - |
- true | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| conditions | -[]object | -
- Represents the observations of a project's current state.
-Known condition types are: "Ready" - - Default: [map[lastTransitionTime:1970-01-01T00:00:00Z message:Waiting for control plane to reconcile reason:Unknown status:Unknown type:Ready]] - |
- false | -
| Name | -Type | -Description | -Required | -
|---|---|---|---|
| lastTransitionTime | -string | -
- lastTransitionTime is the last time the condition transitioned from one status to another.
-This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. - - Format: date-time - |
- true | -
| message | -string | -
- message is a human readable message indicating details about the transition.
-This may be an empty string. - |
- true | -
| reason | -string | -
- reason contains a programmatic identifier indicating the reason for the condition's last transition.
-Producers of specific condition types may define expected values and meanings for this field,
-and whether the values are considered a guaranteed API.
-The value should be a CamelCase string.
-This field may not be empty. - |
- true | -
| status | -enum | -
- status of the condition, one of True, False, Unknown. - - Enum: True, False, Unknown - |
- true | -
| type | -string | -
- type of condition in CamelCase or in foo.example.com/CamelCase. - |
- true | -
| observedGeneration | -integer | -
- observedGeneration represents the .metadata.generation that the condition was set based upon.
-For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
-with respect to the current state of the instance. - - Format: int64 - Minimum: 0 - |
- false | -