Skip to content

Commit

Permalink
FOCUS #557: Normative requirements refinement - preview - 'the column…
Browse files Browse the repository at this point in the history
… adheres to...' -> 'the XY adheres to...'
  • Loading branch information
ijurica committed Dec 16, 2024
1 parent 0d2501e commit e202cbb
Show file tree
Hide file tree
Showing 21 changed files with 26 additions and 26 deletions.
2 changes: 1 addition & 1 deletion specification/columns/availabilityzone.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ An [*availability zone*](#glossary:availability-zone) is a provider-assigned ide
The AvailabilityZone column adheres to the following requirements:

* AvailabilityZone is RECOMMENDED to be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset) when the provider supports deploying resources or services within an *availability zone*.
* If present, the column adheres to the following additional requirements:
* If present, AvailabilityZone adheres to the following additional requirements:
* AvailabilityZone MUST be of type String.
* AvailabilityZone MUST conform to [String Handling](#stringhandling) requirements.
* AvailabilityZone MAY be null if a charge is not specific to an *availability zone*.
Expand Down
2 changes: 1 addition & 1 deletion specification/columns/capacityreservationid.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A Capacity Reservation ID is the identifier assigned to a [*capacity reservation
The CapacityReservationId column adheres to the following requirements:

* CapacityReservationId MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset) when the provider supports *capacity reservations*.
* If present, the column adheres to the following additional requirements:
* If present, CapacityReservationId adheres to the following additional requirements:
* CapacityReservationId MUST be of type String.
* CapacityReservationId MUST conform to [String Handling](#stringhandling) requirements.
* CapacityReservationId MUST be null when a charge is not related to a *capacity reservation*.
Expand Down
4 changes: 2 additions & 2 deletions specification/columns/capacityreservationstatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Capacity Reservation Status indicates whether the charge represents either the c
The CapacityReservationStatus column adheres to the following requirements:

* CapacityReservationStatus MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset) when the provider supports *capacity reservations*.
* If present, the column adheres to the following additional requirements:
* If present, CapacityReservationStatus adheres to the following additional requirements:
* CapacityReservationStatus MUST be of type String.
* CapacityReservationStatus MUST be null if CapacityReservationId is null.
* If CapacityReservationId is not null and [ChargeCategory](#chargecategory) is "Usage", the column adheres to the following additional requirements:
* If CapacityReservationId is not null and [ChargeCategory](#chargecategory) is "Usage", CapacityReservationStatus adheres to the following additional requirements:
* CapacityReservationStatus MUST NOT be null.
* CapacityReservationStatus MUST be one of the allowed values.
* CapacityReservationStatus MUST be "Unused" when the charge represents the unused portion of a *capacity reservation*.
Expand Down
2 changes: 1 addition & 1 deletion specification/columns/chargeclass.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The ChargeClass column adheres to the following requirements:
* ChargeClass MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset).
* ChargeClass MUST be of type String.
* ChargeClass MUST be null when the row does not represent a correction or when it represents a correction within the current *billing period*.
* When the row represents a correction to a previously invoiced *billing period*, the column adheres to the following additional requirements:
* When the row represents a correction to a previously invoiced *billing period*, ChargeClass adheres to the following additional requirements:
* ChargeClass MUST NOT be null.
* ChargeClass MUST be one of the allowed values.
* ChargeClass MUST be "Correction".
Expand Down
2 changes: 1 addition & 1 deletion specification/columns/chargefrequency.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Charge Frequency indicates how often a charge will occur. Along with the [charge
The ChargeFrequency column adheres to the following requirements:

* ChargeFrequency is RECOMMENDED to be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset).
* If present, the column adheres to the following additional requirements:
* If present, ChargeFrequency adheres to the following additional requirements:
* ChargeFrequency MUST be of type String.
* ChargeFrequency MUST NOT be null.
* ChargeFrequency MUST be one of the allowed values.
Expand Down
4 changes: 2 additions & 2 deletions specification/columns/commitmentdiscountcategory.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Commitment Discount Category indicates whether the [*commitment discount*](#glos
The CommitmentDiscountCategory column adheres to the following requirements:

* CommitmentDiscountCategory MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset) when the provider supports *commitment discounts*.
* If present, the column adheres to the following additional requirements:
* If present, CommitmentDiscountCategory adheres to the following additional requirements:
* CommitmentDiscountCategory MUST be of type String.
* CommitmentDiscountCategory MUST conform to [String Handling](#stringhandling) requirements.
* CommitmentDiscountCategory MUST be null if [CommitmentDiscountId](#commitmentdiscountid) is null.
* If CommitmentDiscountId is not null, the column adheres to the following additional requirements:
* If CommitmentDiscountId is not null, CommitmentDiscountCategory adheres to the following additional requirements:
* CommitmentDiscountCategory MUST NOT be null.
* CommitmentDiscountCategory MUST be one of the allowed values.

Expand Down
2 changes: 1 addition & 1 deletion specification/columns/commitmentdiscountid.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A Commitment Discount ID is the identifier assigned to a [*commitment discount*]
The CommitmentDiscountId column adheres to the following requirements:

* CommitmentDiscountId MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset) when the provider supports *commitment discounts*.
* If present, the column adheres to the following additional requirements:
* If present, CommitmentDiscountId adheres to the following additional requirements:
* CommitmentDiscountId MUST be of type String.
* CommitmentDiscountId MUST conform to [String Handling](#stringhandling) requirements.
* CommitmentDiscountId MUST be null when a charge is not related to a *commitment discount*.
Expand Down
4 changes: 2 additions & 2 deletions specification/columns/commitmentdiscountname.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ A Commitment Discount Name is the display name assigned to a [*commitment discou
The CommitmentDiscountName column adheres to the following requirements:

* CommitmentDiscountName MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset) when the provider supports *commitment discounts*.
* If present, the column adheres to the following additional requirements:
* If present, CommitmentDiscountName adheres to the following additional requirements:
* CommitmentDiscountName MUST be of type String.
* CommitmentDiscountName MUST conform to [String Handling](#stringhandling) requirements.
* CommitmentDiscountName MUST be null if [CommitmentDiscountId](#commitmentdiscountid) is null.
* If CommitmentDiscountId is not null, the column adheres to the following additional requirements:
* If CommitmentDiscountId is not null, CommitmentDiscountName adheres to the following additional requirements:
* CommitmentDiscountName MUST NOT be null when a display name can be assigned to a *commitment discount*.
* CommitmentDiscountName MAY be null when a display name cannot be assigned to a *commitment discount*.

Expand Down
4 changes: 2 additions & 2 deletions specification/columns/commitmentdiscountstatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Commitment Discount Status indicates whether the charge corresponds with the con
The CommitmentDiscountStatus column adheres to the following requirements:

* CommitmentDiscountStatus MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset) when the provider supports *commitment discounts*.
* If present, the column adheres to the following additional requirements:
* If present, CommitmentDiscountStatus adheres to the following additional requirements:
* CommitmentDiscountStatus MUST be of type String.
* CommitmentDiscountStatus MUST be null if [CommitmentDiscountId](#commitmentdiscountid) is null.
* If CommitmentDiscountId is not null and [Charge Category](#chargecategory) is "Usage", the column adheres to the following additional requirements:
* If CommitmentDiscountId is not null and [Charge Category](#chargecategory) is "Usage", CommitmentDiscountStatus adheres to the following additional requirements:
* CommitmentDiscountStatus MUST NOT be null.
* CommitmentDiscountStatus MUST be one of the allowed values.

Expand Down
2 changes: 1 addition & 1 deletion specification/columns/commitmentdiscounttype.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Commitment Discount Type is a provider-assigned name to identify the type of [*c
The CommitmentDiscountType column adheres to the following requirements:

* CommitmentDiscountType MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset) when the provider supports *commitment discounts*.
* If present, the column adheres to the following additional requirements:
* If present, CommitmentDiscountType adheres to the following additional requirements:
* CommitmentDiscountType MUST be of type String.
* CommitmentDiscountType MUST conform to [String Handling](#stringhandling) requirements.
* CommitmentDiscountType MUST be null if [CommitmentDiscountId](#commitmentdiscountid) is null.
Expand Down
4 changes: 2 additions & 2 deletions specification/columns/pricingcategory.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ Pricing Category describes the pricing model used for a charge at the time of us
The PricingCategory column adheres to the following requirements:

* PricingCategory MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset) when the provider supports more than one pricing category across all SKUs.
* If present, the column adheres to the following additional requirements:
* If present, PricingCategory adheres to the following additional requirements:
* PricingCategory MUST be of type String.
* PricingCategory MUST be null if [ChargeCategory](#chargecategory) is "Tax".
* PricingCategory MUST NOT be null if ChargeCategory is "Usage" or "Purchase" and [ChargeClass](#chargeclass) is not "Correction".
* PricingCategory MAY be null in all other cases.
* If PricingCategory is not null, the column adheres to the following additional requirements:
* If PricingCategory is not null, PricingCategory adheres to the following additional requirements:
* PricingCategory MUST be one of the allowed values.
* PricingCategory MUST be "Standard" when pricing is predetermined at the agreed upon rate for the [billing account](#glossary:billing-account).
* PricingCategory MUST be "Committed" when the charge is subject to an existing *commitment discount* and is not the purchase of the *commitment discount*.
Expand Down
2 changes: 1 addition & 1 deletion specification/columns/regionid.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A Region ID is a provider-assigned identifier for an isolated geographic area wh
The RegionId column adheres to the following requirements:

* RegionId MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset) when the provider supports deploying resources or services within a region.
* If present, the column adheres to the following additional requirements:
* If present, RegionId adheres to the following additional requirements:
* RegionId MUST be of type String.
* RegionId MUST conform to [String Handling](#stringhandling) requirements.
* RegionId MUST NOT be null when a *resource* or *service* is operated in or managed from a distinct region by the Provider.
Expand Down
2 changes: 1 addition & 1 deletion specification/columns/regionname.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Region Name is a provider-assigned display name for an isolated geographic area
The RegionName column adheres to the following requirements:

* RegionName MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset) when the provider supports deploying resources or services within a region.
* If present, the column adheres to the following additional requirements:
* If present, RegionName adheres to the following additional requirements:
* RegionName MUST be of type String.
* RegionName MUST conform to [String Handling](#stringhandling) requirements.
* RegionName MUST be null if [RegionId](#regionid) is null.
Expand Down
2 changes: 1 addition & 1 deletion specification/columns/resourceid.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A Resource ID is an identifier assigned to a [*resource*](#glossary:resource) by
The ResourceId column adheres to the following requirements:

* ResourceId MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset) when the provider supports billing based on provisioned resources.
* If present, the column adheres to the following additional requirements:
* If present, ResourceId adheres to the following additional requirements:
* ResourceId MUST be of type String.
* ResourceId MUST conform to [String Handling](#stringhandling) requirements.
* ResourceId MUST be null when a charge is not related to a *resource*.
Expand Down
2 changes: 1 addition & 1 deletion specification/columns/resourcename.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Resource Name is a display name assigned to a [*resource*](#glossary:resourc
The ResourceName column adheres to the following requirements:

* ResourceName MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset) when the provider supports billing based on provisioned resources.
* If present, the column adheres to the following additional requirements:
* If present, ResourceName adheres to the following additional requirements:
* ResourceName MUST be of type String.
* ResourceName MUST conform to [String Handling](#stringhandling) requirements.
* ResourceName MUST be null if [ResourceId](#resourceid) is null or when the *resource* only has a system-generated ResourceId without an assigned display name.
Expand Down
2 changes: 1 addition & 1 deletion specification/columns/resourcetype.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Resource Type describes the kind of [*resource*](#glossary:resource) the charge
The ResourceType column adheres to the following requirements:

* ResourceType MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset) when the provider supports billing based on provisioned resources and supports assigning types to resources.
* If present, the column adheres to the following additional requirements:
* If present, ResourceType adheres to the following additional requirements:
* ResourceType MUST be of type String.
* ResourceType MUST conform to [String Handling](#stringhandling) requirements.
* ResourceType MUST be null if [ResourceId](#resourceid) is null.
Expand Down
2 changes: 1 addition & 1 deletion specification/columns/servicesubcategory.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Service Subcategory is a secondary classification of the [Service Category](
The ServiceSubcategory column adheres to the following requirements:

* ServiceSubcategory is RECOMMENDED to be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset).
* If present, the column adheres to the following additional requirements:
* If present, ServiceSubcategory adheres to the following additional requirements:
* ServiceSubcategory MUST be of type String.
* ServiceSubcategory MUST NOT be null.
* ServiceSubcategory MUST be one of the allowed values.
Expand Down
2 changes: 1 addition & 1 deletion specification/columns/skuid.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A SKU ID is a unique identifier that defines a provider-supported construct for
The SkuId column adheres to the following requirements:

* SkuId MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset) when the provider publishes a SKU list.
* If present, the column adheres to the following additional requirements:
* If present, SkuId adheres to the following additional requirements:
* SkuId MUST be of type String.
* SkuId MUST conform to [String Handling](#stringhandling) requirements.
* SkuId MUST be null if [ChargeCategory](#chargecategory) is "Tax".
Expand Down
2 changes: 1 addition & 1 deletion specification/columns/skupriceid.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A SKU Price ID is a unique identifier that defines the unit price used to calcul
The SkuPriceId column adheres to the following requirements:

* SkuPriceId MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset) when the provider publishes a SKU price list.
* If present, the column adheres to the following additional requirements:
* If present, SkuPriceId adheres to the following additional requirements:
* SkuPriceId MUST be of type String.
* SkuPriceId MUST conform to [String Handling](#stringhandling) requirements.
* SkuPriceId MUST be null if [ChargeCategory](#chargecategory) is "Tax".
Expand Down
2 changes: 1 addition & 1 deletion specification/columns/subaccountid.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A Sub Account ID is a provider-assigned identifier assigned to a [*sub account*]
The SubAccountId column adheres to the following requirements:

* SubAccountId MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset) when the provider supports a *sub account* construct.
* If present, the column adheres to the following additional requirements:
* If present, SubAccountId adheres to the following additional requirements:
* SubAccountId MUST be of type String.
* SubAccountId MUST conform to [String Handling](#stringhandling) requirements.
* SubAccountId MUST be null when a charge is not related to a *sub account*.
Expand Down
2 changes: 1 addition & 1 deletion specification/columns/subaccountname.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A Sub Account Name is a display name assigned to a [*sub account*](#glossary:sub
The SubAccountName column adheres to the following requirements:

* SubAccountName MUST be present in a [*FOCUS dataset*](#glossary:FOCUS-dataset) when the provider supports a *sub account* construct.
* If present, the column adheres to the following additional requirements:
* If present, SubAccountName adheres to the following additional requirements:
* SubAccountName MUST be of type String.
* SubAccountName MUST conform to [String Handling](#stringhandling) requirements.
* SubAccountName MUST be null if [SubAccountId](#subaccountid) is null.
Expand Down

0 comments on commit e202cbb

Please sign in to comment.