Skip to content

feat(api): improve API types #4292

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

Closed
tothandras wants to merge 1 commit into from
Closed

feat(api): improve API types #4292

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion api/spec/packages/aip/src/currencies/cost-bases/cost-basis.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ model CostBasis {
* An ISO-8601 timestamp representation of entity creation date.
*/
@visibility(Lifecycle.Read)
created_at?: Shared.DateTime;
created_at: Shared.DateTime;
}
2 changes: 1 addition & 1 deletion api/spec/packages/aip/src/currencies/currency.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,5 +114,5 @@ model CurrencyCustom {
* An ISO-8601 timestamp representation of the custom currency creation date.
*/
@visibility(Lifecycle.Read)
created_at?: Shared.DateTime;
created_at: Shared.DateTime;
}
5 changes: 4 additions & 1 deletion api/spec/packages/aip/src/customers/charges/operations.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,10 @@ interface CustomerChargesOperations {
filter?: ListCustomerChargesParamsFilter,

/**
* Expands
* Expand full objects for referenced entities.
*
* Supported values are:
* - `real_time_usage`: Expand the charge's real-time usage.
*/
@query(#{ name: "expand", explode: true })
expand?: ChargesExpand[],
Expand Down
31 changes: 8 additions & 23 deletions api/spec/packages/aip/src/customers/credits/operations.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,10 @@ namespace Customers;
*/
@friendlyName("ListCreditGrantsParamsFilter")
model ListCreditGrantsParamsFilter {
/**
* Filter credit grants by status.
*/
status?: CreditGrantStatus;

/**
* Filter credit grants by currency.
*/
currency?: Shared.CurrencyCode;
#suppress "@openmeter/api-spec-aip/doc-decorator" "shared model"
status?: Common.StringFieldFilterExact;
#suppress "@openmeter/api-spec-aip/doc-decorator" "shared model"
currency?: Common.StringFieldFilterExact;
}

interface CustomerCreditGrantsOperations {
Expand Down Expand Up @@ -141,11 +136,6 @@ model GetCreditBalanceParamsFilter {
* Filter credit balance by currency.
*/
currency?: Currencies.CurrencyCode;

/**
* Filter by specific feature.
*/
feature?: Shared.ResourceKey;
}

interface CustomerCreditBalancesOperations {
Expand All @@ -171,15 +161,10 @@ interface CustomerCreditBalancesOperations {
*/
@friendlyName("ListCreditTransactionsParamsFilter")
model ListCreditTransactionsParamsFilter {
/**
* Filter credit transactions by type.
*/
type?: CreditTransactionType;

/**
* Filter credit transactions by currency.
*/
currency?: Currencies.CurrencyCode;
#suppress "@openmeter/api-spec-aip/doc-decorator" "shared model"
type?: Common.StringFieldFilterExact;
#suppress "@openmeter/api-spec-aip/doc-decorator" "shared model"
currency?: Common.StringFieldFilterExact;

// TODO: add date filters for created_at and booked_at
}
Expand Down
4 changes: 2 additions & 2 deletions api/spec/packages/aip/src/llmcost/prices.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,11 @@ model Price {

/** Creation timestamp. */
@visibility(Lifecycle.Read)
created_at?: Shared.DateTime;
created_at: Shared.DateTime;

/** Last update timestamp. */
@visibility(Lifecycle.Read)
updated_at?: Shared.DateTime;
updated_at: Shared.DateTime;
}

/**
Expand Down
4 changes: 2 additions & 2 deletions api/spec/packages/aip/src/shared/resource.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@ model Resource {
* An ISO-8601 timestamp representation of entity creation date.
*/
@visibility(Lifecycle.Read)
created_at?: DateTime;
created_at: DateTime;

/**
* An ISO-8601 timestamp representation of entity last update date.
*/
@visibility(Lifecycle.Read)
updated_at?: DateTime;
updated_at: DateTime;

/**
* An ISO-8601 timestamp representation of entity deletion date.
Expand Down
Loading
Loading