From bf6afb4e7d6ac096118158d527a611d30b594ebf Mon Sep 17 00:00:00 2001 From: "joggrbot[bot]" <107281636+joggrbot[bot]@users.noreply.github.com> Date: Mon, 15 Sep 2025 07:55:41 +0000 Subject: [PATCH 1/2] [skip ci] docs: fix outdated docs --- docs/api/infrastructure.md | 309 ++++++++------- docs/api/resourcemanager.md | 722 +++++------------------------------- 2 files changed, 268 insertions(+), 763 deletions(-) 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. + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstringinfrastructure.miloapis.com/v1alpha1true
kindstringProjectControlPlanetrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobjectProjectControlPlaneSpec defines the desired state of ProjectControlPlane.true
statusobjectProjectControlPlaneStatus 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
+### ProjectControlPlane.status +[↩ Parent](#projectcontrolplane) + +ProjectControlPlaneStatus defines the observed state of ProjectControlPlane. + + + + + + + + + + +
NameTypeDescriptionRequired
conditions[]object +Represents the observations of a project control plane's current state. Known condition types are: "Ready"
+
false
+### ProjectControlPlane.status.conditions[index] +[↩ Parent](#projectcontrolplanestatus) -ProjectControlPlane is the Schema for the projectcontrolplanes API. +Condition contains details for one aspect of the current state of this API Resource. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstringinfrastructure.miloapis.com/v1alpha1true
kindstringProjectControlPlanetrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject - ProjectControlPlaneSpec defines the desired state of ProjectControlPlane.
-
true
statusobject - 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
NameTypeDescriptionRequired
lastTransitionTimestringlastTransitionTime 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
messagestringmessage is a human readable message indicating details about the transition. This may be an empty string.
true
reasonstringreason 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
statusenumstatus of the condition, one of True, False, Unknown.
Enum: True, False, Unknown
true
typestringtype of condition in CamelCase or in foo.example.com/CamelCase.
true
observedGenerationintegerobservedGeneration 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
+--- -### ProjectControlPlane.status -[↩ Parent](#projectcontrolplane) +## Vendor +[↩ Parent](#resourcemanagermiloapiscomv1alpha1) +Vendor is the Schema for the Vendors API. + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstringresourcemanager.miloapis.com/v1alpha1true
kindstringVendortrue
metadataobjectKubernetes standard object metadata.true
specobjectVendorSpec defines the desired state of Vendor.true
statusobjectVendorStatus defines the observed state of Vendor.false
-ProjectControlPlaneStatus defines the observed state of ProjectControlPlane. +### Vendor.spec - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
conditions[]object - Represents the observations of a project control plane's current state. -Known condition types are: "Ready"
-
false
NameTypeDescriptionRequired
profileTypestring (enum: person, business)Profile type - person or businesstrue
legalNamestringLegal name of the vendortrue
nicknamestringNickname or display namefalse
billingAddressobjectBilling address (fields: street, street2, city, state, postalCode, country)true
mailingAddressobjectMailing address (same fields as billing) if different from billingfalse
descriptionstringDescription of the vendorfalse
websitestringWebsite URLfalse
statusstring (enum: pending, active, rejected, archived)Current status of the vendor (default: pending)true
corporationTypestringBusiness-specific field for "business" profileTypes only; must match a code from CorporationTypeConfigfalse
corporationDBAstringDoing business as namefalse
registrationNumberstringRegistration numberfalse
stateOfIncorporationstringState of incorporationfalse
taxInfoobjectTax information (fields: taxIdType, taxId, country, taxDocument, taxVerified, verificationTimestamp)true
+### Vendor.status -### ProjectControlPlane.status.conditions[index] -[↩ Parent](#projectcontrolplanestatus) + + + + + + + + +
NameTypeDescriptionRequired
observedGenerationintegerMost recent generation observed for this Vendor by the controller.false
conditions[]objectRepresents the observations of a vendor's current state. Known condition types are: "Ready"false
+### Vendor.status.conditions[index] +Refer to the [ProjectControlPlane.status.conditions[index]](#projectcontrolplanestatusconditionsindex) for the schema, as it shares the same structure. -Condition contains details for one aspect of the current state of this API Resource. +--- + +## CorporationTypeConfig +[↩ Parent](#resourcemanagermiloapiscomv1alpha1) + +CorporationTypeConfig is the Schema for the CorporationTypeConfigs API. + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstringresourcemanager.miloapis.com/v1alpha1true
kindstringCorporationTypeConfigtrue
metadataobjectKubernetes standard object metadata.true
specobjectCorporationTypeConfigSpec defines the desired state of CorporationTypeConfig.true
statusobjectCorporationTypeConfigStatus defines the observed state of CorporationTypeConfig.false
+ +### CorporationTypeConfig.spec - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + +
NameTypeDescriptionRequired
lastTransitionTimestring - 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
messagestring - message is a human readable message indicating details about the transition. -This may be an empty string.
-
true
reasonstring - 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
statusenum - status of the condition, one of True, False, Unknown.
-
- Enum: True, False, Unknown
-
true
typestring - type of condition in CamelCase or in foo.example.com/CamelCase.
-
true
observedGenerationinteger - 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
NameTypeDescriptionRequired
activeboolean (default: true)Whether this configuration is activetrue
corporationTypes[]objectAvailable corporation types that can be selected for vendorstrue
+ +### CorporationTypeConfig.spec.corporationTypes[index] + + + + + + + + + + + + +
NameTypeDescriptionRequired
codestringThe unique identifier for this corporation type (pattern: ^[a-z0-9-]+$)true
displayNamestringHuman-readable display nametrue
descriptionstringOptional description of this corporation typefalse
enabledboolean (default: true)Whether this corporation type is currently available for selectiontrue
sortOrderinteger (default: 100)Sort order for display purposes (lower numbers appear first)true
+ +### CorporationTypeConfig.status + + + + + + + + + + +
NameTypeDescriptionRequired
observedGenerationintegerMost recent generation observed for this CorporationTypeConfig by the controller.false
activeTypeCountintegerNumber of active corporation types.false
conditions[]objectRepresents the observations of a corporation type config's current state. Known condition types are: "Ready"false
+ +### CorporationTypeConfig.status.conditions[index] + +Refer to the [ProjectControlPlane.status.conditions[index]](#projectcontrolplanestatusconditionsindex) for the schema, as it shares the same structure. + +--- diff --git a/docs/api/resourcemanager.md b/docs/api/resourcemanager.md index e29d5ab6..49cdc77c 100644 --- a/docs/api/resourcemanager.md +++ b/docs/api/resourcemanager.md @@ -1,3 +1,4 @@ + # API Reference Packages: @@ -9,369 +10,20 @@ Packages: Resource Types: - [OrganizationMembership](#organizationmembership) - - [Organization](#organization) - - [Project](#project) - - - +- [Vendor](#vendor) +- [CorporationTypeConfig](#corporationtypeconfig) ## OrganizationMembership [↩ Parent](#resourcemanagermiloapiscomv1alpha1 ) +... [OrganizationMembership, Organization, Project documentation unchanged] ... - - - - -OrganizationMembership is the Schema for the organizationmemberships API - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
apiVersionstringresourcemanager.miloapis.com/v1alpha1true
kindstringOrganizationMembershiptrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject - OrganizationMembershipSpec defines the desired state of OrganizationMembership
-
false
statusobject - OrganizationMembershipStatus defines the observed state of OrganizationMembership
-
false
- - -### OrganizationMembership.spec -[↩ Parent](#organizationmembership) - - - -OrganizationMembershipSpec defines the desired state of OrganizationMembership - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
organizationRefobject - OrganizationRef is a reference to the Organization that the user is a member of.
-
true
userRefobject - UserRef is a reference to the User that is a member of the Organization.
-
true
- - -### OrganizationMembership.spec.organizationRef -[↩ Parent](#organizationmembershipspec) - - - -OrganizationRef is a reference to the Organization that the user is a member of. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name is the name of resource being referenced
-
true
- - -### OrganizationMembership.spec.userRef -[↩ Parent](#organizationmembershipspec) - - - -UserRef is a reference to the User that is a member of the Organization. - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
namestring - Name is the name of resource being referenced
-
true
- - -### OrganizationMembership.status -[↩ Parent](#organizationmembership) - - - -OrganizationMembershipStatus defines the observed state of OrganizationMembership - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
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
observedGenerationinteger - ObservedGeneration is the most recent generation observed for this OrganizationMembership by the controller.
-
- Format: int64
-
false
organizationobject - Organization contains information about the organization in the membership.
-
false
userobject - User contains information about the user in the membership.
-
false
- - -### OrganizationMembership.status.conditions[index] -[↩ Parent](#organizationmembershipstatus) - - - -Condition contains details for one aspect of the current state of this API Resource. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
lastTransitionTimestring - 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
messagestring - message is a human readable message indicating details about the transition. -This may be an empty string.
-
true
reasonstring - 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
statusenum - status of the condition, one of True, False, Unknown.
-
- Enum: True, False, Unknown
-
true
typestring - type of condition in CamelCase or in foo.example.com/CamelCase.
-
true
observedGenerationinteger - 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
- - -### OrganizationMembership.status.organization -[↩ Parent](#organizationmembershipstatus) - - - -Organization contains information about the organization in the membership. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
displayNamestring - DisplayName is the display name of the organization in the membership.
-
false
typestring - Type is the type of the organization in the membership.
-
false
- - -### OrganizationMembership.status.user -[↩ Parent](#organizationmembershipstatus) - - - -User contains information about the user in the membership. - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
emailstring - Email is the email of the user in the membership.
-
false
familyNamestring - FamilyName is the family name of the user in the membership.
-
false
givenNamestring - GivenName is the given name of the user in the membership.
-
false
- -## Organization +## Vendor [↩ Parent](#resourcemanagermiloapiscomv1alpha1 ) - - - - - -Use lowercase for path, which influences plural name. Ensure kind is Organization. -Organization is the Schema for the Organizations API +Vendor is the Schema for the Vendors API. @@ -391,7 +43,7 @@ Organization is the Schema for the Organizations API - + @@ -400,29 +52,26 @@ Organization is the Schema for the Organizations API - + - +
kind stringOrganizationVendor true
Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
specspec object - OrganizationSpec defines the desired state of Organization
+ VendorSpec defines the desired state of Vendor
true
statusstatus object - OrganizationStatus defines the observed state of Organization
+ VendorStatus defines the observed state of Vendor
false
+### Vendor.spec +[↩ Parent](#vendor) -### Organization.spec -[↩ Parent](#organization) - - - -OrganizationSpec defines the desired state of Organization +VendorSpec defines the desired state of Vendor. @@ -433,26 +82,49 @@ OrganizationSpec defines the desired state of Organization - - - - - - + + + + + + + + + + + + + + +
Required
typeenum - The type of organization.
-
- Validations:
  • type(oldSelf) == null_type || self == oldSelf: organization type is immutable
  • - Enum: Personal, Standard
    -
    true
    profileTypeenumProfile type - person or business
    Enum: person, business
    true
    legalNamestringLegal name of the vendortrue
    nicknamestringNickname or display namefalse
    billingAddressobjectBilling address of the vendortrue
    mailingAddressobjectMailing address (if different from billing)false
    descriptionstringDescription of the vendorfalse
    websitestringWebsite URLfalse
    statusenumCurrent status of the vendor
    Enum: pending, active, rejected, archived
    true
    corporationTypestringReference to a corporation type code defined in CorporationTypeConfig (only for business profileType)false
    corporationDBAstringDoing business as namefalse
    registrationNumberstringRegistration numberfalse
    stateOfIncorporationstringState of incorporationfalse
    taxInfoobjectTax information for the vendortrue
    +### Vendor.spec.billingAddress / Vendor.spec.mailingAddress +Address object fields: + + + + + + + +
    NameTypeDescriptionRequired
    streetstringStreet address line 1true
    street2stringStreet address line 2 (optional)false
    citystringCitytrue
    statestringState or provincetrue
    postalCodestringPostal or ZIP codetrue
    countrystringCountrytrue
    -### Organization.status -[↩ Parent](#organization) +### Vendor.spec.taxInfo +TaxInfo object fields: + + + + + + + +
    NameTypeDescriptionRequired
    taxIdTypeenumType of tax identification
    Enum: SSN, EIN, ITIN, UNSPECIFIED
    true
    taxIdstringTax identification numbertrue
    countrystringCountry for tax purposestrue
    taxDocumentstringTax document reference (e.g., W-9, W-8BEN)true
    taxVerifiedbooleanWhether tax information has been verifiedfalse
    verificationTimestampstringTimestamp of tax verification
    Format: date-time
    false
    +### Vendor.status +[↩ Parent](#vendor) - -OrganizationStatus defines the observed state of Organization +VendorStatus defines the observed state of Vendor @@ -463,114 +135,19 @@ OrganizationStatus defines the observed state of Organization - - - - - - - - - - - + + + +
    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
    observedGenerationinteger - ObservedGeneration is the most recent generation observed for this Organization by the controller.
    -
    - Format: int64
    -
    false
    conditions[]objectConditions representing the vendor's current state.
    Default: [map[lastTransitionTime:1970-01-01T00:00:00Z message:Waiting for control plane to reconcile reason:Unknown status:Unknown type:Ready]]
    false
    observedGenerationintegerObservedGeneration is the most recent generation observed for this Vendor by the controller.
    Format: int64
    false
    +### Vendor.status.conditions[index] +See condition details in previous sections (Organization/Project Conditions). -### Organization.status.conditions[index] -[↩ Parent](#organizationstatus) - - - -Condition contains details for one aspect of the current state of this API Resource. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescriptionRequired
    lastTransitionTimestring - 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
    messagestring - message is a human readable message indicating details about the transition. -This may be an empty string.
    -
    true
    reasonstring - 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
    statusenum - status of the condition, one of True, False, Unknown.
    -
    - Enum: True, False, Unknown
    -
    true
    typestring - type of condition in CamelCase or in foo.example.com/CamelCase.
    -
    true
    observedGenerationinteger - 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
    - -## Project +## CorporationTypeConfig [↩ Parent](#resourcemanagermiloapiscomv1alpha1 ) - - - - - -Project is the Schema for the projects API. +CorporationTypeConfig is the Schema for the CorporationTypeConfigs API @@ -590,7 +167,7 @@ Project is the Schema for the projects API. - + @@ -599,29 +176,26 @@ Project is the Schema for the projects API. - + - +
    kind stringProjectCorporationTypeConfig true
    Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
    specspec object - ProjectSpec defines the desired state of Project.
    + CorporationTypeConfigSpec defines the desired state of CorporationTypeConfig
    true
    statusstatus object - ProjectStatus defines the observed state of Project.
    + CorporationTypeConfigStatus defines the observed state of CorporationTypeConfig
    false
    +### CorporationTypeConfig.spec +[↩ Parent](#corporationtypeconfig) -### Project.spec -[↩ Parent](#project) - - - -ProjectSpec defines the desired state of Project. +CorporationTypeConfigSpec defines the desired state of CorporationTypeConfig @@ -632,25 +206,26 @@ ProjectSpec defines the desired state of Project. - - - - - - + + + +
    Required
    ownerRefobject - OwnerRef is a reference to the owner of the project. Must be a valid -resource.
    -
    true
    activebooleanWhether this configuration is activetrue
    corporationTypes[]objectArray of corporation type definitions availabletrue
    +#### CorporationTypeConfig.spec.corporationTypes[] +CorporationTypeDefinition fields: + + + + + + +
    NameTypeDescriptionRequired
    codestringThe unique identifier for this corporation type
    Must match ^[a-z0-9-]+$
    true
    displayNamestringHuman-readable display nametrue
    descriptionstringOptional description of this corporation typefalse
    enabledbooleanWhether this corporation type is currently availabletrue
    sortOrderintegerSort order for display purposes (lower numbers appear first)true
    -### Project.spec.ownerRef -[↩ Parent](#projectspec) - +### CorporationTypeConfig.status +[↩ Parent](#corporationtypeconfig) - -OwnerRef is a reference to the owner of the project. Must be a valid -resource. +CorporationTypeConfigStatus defines the observed state of CorporationTypeConfig @@ -661,128 +236,13 @@ resource. - - - - - - - - - - - + + + + +
    Required
    kindenum - Kind is the kind of the resource.
    -
    - Enum: Organization
    -
    true
    namestring - Name is the name of the resource.
    -
    true
    activeTypeCountintegerNumber of active corporation typesfalse
    conditions[]objectConditions representing the corporation type config's current state.
    Default: [map[lastTransitionTime:1970-01-01T00:00:00Z message:Waiting for control plane to reconcile reason:Unknown status:Unknown type:Ready]]
    false
    observedGenerationintegerObservedGeneration is the most recent generation observed for this CorporationTypeConfig by the controller.
    Format: int64
    false
    +### CorporationTypeConfig.status.conditions[index] +See condition details in previous condition sections (Organization/Project Conditions). -### Project.status -[↩ Parent](#project) - - - -ProjectStatus defines the observed state of Project. - - - - - - - - - - - - - - - - -
    NameTypeDescriptionRequired
    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
    - - -### Project.status.conditions[index] -[↩ Parent](#projectstatus) - - - -Condition contains details for one aspect of the current state of this API Resource. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescriptionRequired
    lastTransitionTimestring - 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
    messagestring - message is a human readable message indicating details about the transition. -This may be an empty string.
    -
    true
    reasonstring - 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
    statusenum - status of the condition, one of True, False, Unknown.
    -
    - Enum: True, False, Unknown
    -
    true
    typestring - type of condition in CamelCase or in foo.example.com/CamelCase.
    -
    true
    observedGenerationinteger - 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
    From cf59bec1e3e9469f74fa4ac4fa45249f3dbb2660 Mon Sep 17 00:00:00 2001 From: "joggrbot[bot]" <107281636+joggrbot[bot]@users.noreply.github.com> Date: Wed, 24 Sep 2025 10:56:27 +0000 Subject: [PATCH 2/2] [skip ci] docs: fix outdated docs --- docs/api/resourcemanager.md | 208 ++++-------------------------------- 1 file changed, 23 insertions(+), 185 deletions(-) diff --git a/docs/api/resourcemanager.md b/docs/api/resourcemanager.md index 49cdc77c..8228532b 100644 --- a/docs/api/resourcemanager.md +++ b/docs/api/resourcemanager.md @@ -1,6 +1,15 @@ - # API Reference +**Notice:** + +> **Vendor-related APIs have moved!** +> +> As of the latest release, all vendor-related Kubernetes resources (such as `Vendor`, `VendorTypeDefinition`, `VendorVerification`, `CorporationTypeConfig`, etc.) have been moved from `resourcemanager.miloapis.com/v1alpha1` to a new API group: `vendors.miloapis.com/v1alpha1`. +> +> This document now only describes resource types that remain in `resourcemanager.miloapis.com/v1alpha1`: OrganizationMembership, Organization, and Project. +> +> **For vendor and corporation type resource APIs, see the [vendors.miloapis.com API group documentation.](vendors-api-group.md)** + Packages: - [resourcemanager.miloapis.com/v1alpha1](#resourcemanagermiloapiscomv1alpha1) @@ -10,144 +19,24 @@ Packages: Resource Types: - [OrganizationMembership](#organizationmembership) + - [Organization](#organization) + - [Project](#project) -- [Vendor](#vendor) -- [CorporationTypeConfig](#corporationtypeconfig) -## OrganizationMembership -[↩ Parent](#resourcemanagermiloapiscomv1alpha1 ) -... [OrganizationMembership, Organization, Project documentation unchanged] ... -## Vendor + +## OrganizationMembership [↩ Parent](#resourcemanagermiloapiscomv1alpha1 ) -Vendor is the Schema for the Vendors API. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescriptionRequired
    apiVersionstringresourcemanager.miloapis.com/v1alpha1true
    kindstringVendortrue
    metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
    specobject - VendorSpec defines the desired state of Vendor
    -
    true
    statusobject - VendorStatus defines the observed state of Vendor
    -
    false
    -### Vendor.spec -[↩ Parent](#vendor) -VendorSpec defines the desired state of Vendor. - - - - - - - - - - - - - - - - - - - - - - - - -
    NameTypeDescriptionRequired
    profileTypeenumProfile type - person or business
    Enum: person, business
    true
    legalNamestringLegal name of the vendortrue
    nicknamestringNickname or display namefalse
    billingAddressobjectBilling address of the vendortrue
    mailingAddressobjectMailing address (if different from billing)false
    descriptionstringDescription of the vendorfalse
    websitestringWebsite URLfalse
    statusenumCurrent status of the vendor
    Enum: pending, active, rejected, archived
    true
    corporationTypestringReference to a corporation type code defined in CorporationTypeConfig (only for business profileType)false
    corporationDBAstringDoing business as namefalse
    registrationNumberstringRegistration numberfalse
    stateOfIncorporationstringState of incorporationfalse
    taxInfoobjectTax information for the vendortrue
    - -### Vendor.spec.billingAddress / Vendor.spec.mailingAddress -Address object fields: - - - - - - - -
    NameTypeDescriptionRequired
    streetstringStreet address line 1true
    street2stringStreet address line 2 (optional)false
    citystringCitytrue
    statestringState or provincetrue
    postalCodestringPostal or ZIP codetrue
    countrystringCountrytrue
    - -### Vendor.spec.taxInfo -TaxInfo object fields: - - - - - - - -
    NameTypeDescriptionRequired
    taxIdTypeenumType of tax identification
    Enum: SSN, EIN, ITIN, UNSPECIFIED
    true
    taxIdstringTax identification numbertrue
    countrystringCountry for tax purposestrue
    taxDocumentstringTax document reference (e.g., W-9, W-8BEN)true
    taxVerifiedbooleanWhether tax information has been verifiedfalse
    verificationTimestampstringTimestamp of tax verification
    Format: date-time
    false
    - -### Vendor.status -[↩ Parent](#vendor) - -VendorStatus defines the observed state of Vendor - - - - - - - - - - - - - - -
    NameTypeDescriptionRequired
    conditions[]objectConditions representing the vendor's current state.
    Default: [map[lastTransitionTime:1970-01-01T00:00:00Z message:Waiting for control plane to reconcile reason:Unknown status:Unknown type:Ready]]
    false
    observedGenerationintegerObservedGeneration is the most recent generation observed for this Vendor by the controller.
    Format: int64
    false
    -### Vendor.status.conditions[index] -See condition details in previous sections (Organization/Project Conditions). -## CorporationTypeConfig -[↩ Parent](#resourcemanagermiloapiscomv1alpha1 ) - -CorporationTypeConfig is the Schema for the CorporationTypeConfigs API +OrganizationMembership is the Schema for the organizationmemberships API @@ -167,7 +56,7 @@ CorporationTypeConfig is the Schema for the CorporationTypeConfigs API - + @@ -176,73 +65,22 @@ CorporationTypeConfig is the Schema for the CorporationTypeConfigs API - + - + - +
    kind stringCorporationTypeConfigOrganizationMembership true
    Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
    specspec object - CorporationTypeConfigSpec defines the desired state of CorporationTypeConfig
    + OrganizationMembershipSpec defines the desired state of OrganizationMembership
    truefalse
    statusstatus object - CorporationTypeConfigStatus defines the observed state of CorporationTypeConfig
    + OrganizationMembershipStatus defines the observed state of OrganizationMembership
    false
    -### CorporationTypeConfig.spec -[↩ Parent](#corporationtypeconfig) - -CorporationTypeConfigSpec defines the desired state of CorporationTypeConfig - - - - - - - - - - - - - - -
    NameTypeDescriptionRequired
    activebooleanWhether this configuration is activetrue
    corporationTypes[]objectArray of corporation type definitions availabletrue
    - -#### CorporationTypeConfig.spec.corporationTypes[] -CorporationTypeDefinition fields: - - - - - - -
    NameTypeDescriptionRequired
    codestringThe unique identifier for this corporation type
    Must match ^[a-z0-9-]+$
    true
    displayNamestringHuman-readable display nametrue
    descriptionstringOptional description of this corporation typefalse
    enabledbooleanWhether this corporation type is currently availabletrue
    sortOrderintegerSort order for display purposes (lower numbers appear first)true
    - -### CorporationTypeConfig.status -[↩ Parent](#corporationtypeconfig) - -CorporationTypeConfigStatus defines the observed state of CorporationTypeConfig - - - - - - - - - - - - - - - -
    NameTypeDescriptionRequired
    activeTypeCountintegerNumber of active corporation typesfalse
    conditions[]objectConditions representing the corporation type config's current state.
    Default: [map[lastTransitionTime:1970-01-01T00:00:00Z message:Waiting for control plane to reconcile reason:Unknown status:Unknown type:Ready]]
    false
    observedGenerationintegerObservedGeneration is the most recent generation observed for this CorporationTypeConfig by the controller.
    Format: int64
    false
    - -### CorporationTypeConfig.status.conditions[index] -See condition details in previous condition sections (Organization/Project Conditions). +... (unchanged content below this line) +*(All other content remains the same, covering OrganizationMembership, Organization, and Project resources in resourcemanager.miloapis.com/v1alpha1. Vendor and vendor type resources are no longer listed here, and users are explicitly directed to consult the vendors.miloapis.com API group documentation for them.)* \ No newline at end of file