Skip to content

docs: for pull #275, fixed 1 outdated doc(s) #300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mustela merged 1 commit into from
Sep 30, 2025
Merged

docs: for pull #275, fixed 1 outdated doc(s) #300

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 1 addition & 126 deletions docs/api/infrastructure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@ Resource Types:

Resource Types:

- [Vendor](#vendor)
- [CorporationTypeConfig](#corporationtypeconfig)



---

Expand Down Expand Up @@ -95,125 +91,4 @@ Condition contains details for one aspect of the current state of this API Resou

---

## Vendor
<sup><sup>[↩ Parent](#resourcemanagermiloapiscomv1alpha1)</sup></sup>

Vendor is the Schema for the Vendors API.

<table>
<thead>
<tr><th>Name</th><th>Type</th><th>Description</th><th>Required</th></tr>
</thead>
<tbody>
<tr><td><b>apiVersion</b></td><td>string</td><td>resourcemanager.miloapis.com/v1alpha1</td><td>true</td></tr>
<tr><td><b>kind</b></td><td>string</td><td>Vendor</td><td>true</td></tr>
<tr><td><b>metadata</b></td><td>object</td><td>Kubernetes standard object metadata.</td><td>true</td></tr>
<tr><td><b>spec</b></td><td>object</td><td>VendorSpec defines the desired state of Vendor.</td><td>true</td></tr>
<tr><td><b>status</b></td><td>object</td><td>VendorStatus defines the observed state of Vendor.</td><td>false</td></tr>
</tbody>
</table>

### Vendor.spec

<table>
<thead>
<tr><th>Name</th><th>Type</th><th>Description</th><th>Required</th></tr>
</thead>
<tbody>
<tr><td><b>profileType</b></td><td>string (enum: person, business)</td><td>Profile type - person or business</td><td>true</td></tr>
<tr><td><b>legalName</b></td><td>string</td><td>Legal name of the vendor</td><td>true</td></tr>
<tr><td><b>nickname</b></td><td>string</td><td>Nickname or display name</td><td>false</td></tr>
<tr><td><b>billingAddress</b></td><td>object</td><td>Billing address (fields: street, street2, city, state, postalCode, country)</td><td>true</td></tr>
<tr><td><b>mailingAddress</b></td><td>object</td><td>Mailing address (same fields as billing) if different from billing</td><td>false</td></tr>
<tr><td><b>description</b></td><td>string</td><td>Description of the vendor</td><td>false</td></tr>
<tr><td><b>website</b></td><td>string</td><td>Website URL</td><td>false</td></tr>
<tr><td><b>status</b></td><td>string (enum: pending, active, rejected, archived)</td><td>Current status of the vendor (default: pending)</td><td>true</td></tr>
<tr><td><b>corporationType</b></td><td>string</td><td>Business-specific field for "business" profileTypes only; must match a code from CorporationTypeConfig</td><td>false</td></tr>
<tr><td><b>corporationDBA</b></td><td>string</td><td>Doing business as name</td><td>false</td></tr>
<tr><td><b>registrationNumber</b></td><td>string</td><td>Registration number</td><td>false</td></tr>
<tr><td><b>stateOfIncorporation</b></td><td>string</td><td>State of incorporation</td><td>false</td></tr>
<tr><td><b>taxInfo</b></td><td>object</td><td>Tax information (fields: taxIdType, taxId, country, taxDocument, taxVerified, verificationTimestamp)</td><td>true</td></tr>
</tbody>
</table>

### Vendor.status

<table>
<thead>
<tr><th>Name</th><th>Type</th><th>Description</th><th>Required</th></tr>
</thead>
<tbody>
<tr><td><b>observedGeneration</b></td><td>integer</td><td>Most recent generation observed for this Vendor by the controller.</td><td>false</td></tr>
<tr><td><b>conditions</b></td><td>[]object</td><td>Represents the observations of a vendor's current state. Known condition types are: "Ready"</td><td>false</td></tr>
</tbody>
</table>

### Vendor.status.conditions[index]

Refer to the [ProjectControlPlane.status.conditions[index]](#projectcontrolplanestatusconditionsindex) for the schema, as it shares the same structure.

---

## CorporationTypeConfig
<sup><sup>[↩ Parent](#resourcemanagermiloapiscomv1alpha1)</sup></sup>

CorporationTypeConfig is the Schema for the CorporationTypeConfigs API.

<table>
<thead>
<tr><th>Name</th><th>Type</th><th>Description</th><th>Required</th></tr>
</thead>
<tbody>
<tr><td><b>apiVersion</b></td><td>string</td><td>resourcemanager.miloapis.com/v1alpha1</td><td>true</td></tr>
<tr><td><b>kind</b></td><td>string</td><td>CorporationTypeConfig</td><td>true</td></tr>
<tr><td><b>metadata</b></td><td>object</td><td>Kubernetes standard object metadata.</td><td>true</td></tr>
<tr><td><b>spec</b></td><td>object</td><td>CorporationTypeConfigSpec defines the desired state of CorporationTypeConfig.</td><td>true</td></tr>
<tr><td><b>status</b></td><td>object</td><td>CorporationTypeConfigStatus defines the observed state of CorporationTypeConfig.</td><td>false</td></tr>
</tbody>
</table>

### CorporationTypeConfig.spec

<table>
<thead>
<tr><th>Name</th><th>Type</th><th>Description</th><th>Required</th></tr>
</thead>
<tbody>
<tr><td><b>active</b></td><td>boolean (default: true)</td><td>Whether this configuration is active</td><td>true</td></tr>
<tr><td><b>corporationTypes</b></td><td>[]object</td><td>Available corporation types that can be selected for vendors</td><td>true</td></tr>
</tbody>
</table>

### CorporationTypeConfig.spec.corporationTypes[index]

<table>
<thead>
<tr><th>Name</th><th>Type</th><th>Description</th><th>Required</th></tr>
</thead>
<tbody>
<tr><td><b>code</b></td><td>string</td><td>The unique identifier for this corporation type (pattern: ^[a-z0-9-]+$)</td><td>true</td></tr>
<tr><td><b>displayName</b></td><td>string</td><td>Human-readable display name</td><td>true</td></tr>
<tr><td><b>description</b></td><td>string</td><td>Optional description of this corporation type</td><td>false</td></tr>
<tr><td><b>enabled</b></td><td>boolean (default: true)</td><td>Whether this corporation type is currently available for selection</td><td>true</td></tr>
<tr><td><b>sortOrder</b></td><td>integer (default: 100)</td><td>Sort order for display purposes (lower numbers appear first)</td><td>true</td></tr>
</tbody>
</table>

### CorporationTypeConfig.status

<table>
<thead>
<tr><th>Name</th><th>Type</th><th>Description</th><th>Required</th></tr>
</thead>
<tbody>
<tr><td><b>observedGeneration</b></td><td>integer</td><td>Most recent generation observed for this CorporationTypeConfig by the controller.</td><td>false</td></tr>
<tr><td><b>activeTypeCount</b></td><td>integer</td><td>Number of active corporation types.</td><td>false</td></tr>
<tr><td><b>conditions</b></td><td>[]object</td><td>Represents the observations of a corporation type config's current state. Known condition types are: "Ready"</td><td>false</td></tr>
</tbody>
</table>

### CorporationTypeConfig.status.conditions[index]

Refer to the [ProjectControlPlane.status.conditions[index]](#projectcontrolplanestatusconditionsindex) for the schema, as it shares the same structure.

---