diff --git a/docs/api/infrastructure.md b/docs/api/infrastructure.md index bd4594ed..a7e6e792 100644 --- a/docs/api/infrastructure.md +++ b/docs/api/infrastructure.md @@ -15,10 +15,6 @@ Resource Types: Resource Types: -- [Vendor](#vendor) -- [CorporationTypeConfig](#corporationtypeconfig) - - --- @@ -95,125 +91,4 @@ Condition contains details for one aspect of the current state of this API Resou --- -## Vendor -[↩ Parent](#resourcemanagermiloapiscomv1alpha1) - -Vendor is the Schema for the Vendors API. - -
| 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 |
|---|---|---|---|
| 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 |
|---|---|---|---|
| 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 |