Skip to content

Commit 73f1de0

Browse files
scaleway-botyfodil
andauthored
docs(environmental_footprint): update fields descriptions (#2454)
Co-authored-by: Yacine Fodil <[email protected]>
1 parent 66f2ab2 commit 73f1de0

File tree

1 file changed

+6
-6
lines changed
  • packages_generated/environmental_footprint/src/v1alpha1

1 file changed

+6
-6
lines changed

packages_generated/environmental_footprint/src/v1alpha1/types.gen.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -126,11 +126,11 @@ export type UserApiDownloadImpactReportRequest = {
126126
*/
127127
organizationId?: string
128128
/**
129-
* The start date of the period for which you want to download a report (ISO 8601 format, e.g., 2025-05-01T00:00:00Z).
129+
* The start date of the period for which you want to download a report (ISO 8601 format, e.g. 2025-05-01T00:00:00Z).
130130
*/
131131
date?: Date
132132
/**
133-
* Type of report to download (e.g., monthly). Defaults to monthly.
133+
* Type of report to download (e.g. `monthly`).
134134
*/
135135
type?: ReportType
136136
}
@@ -141,19 +141,19 @@ export type UserApiGetImpactDataRequest = {
141141
*/
142142
organizationId?: string
143143
/**
144-
* Start date (inclusive) of the period for which you want to retrieve impact data (ISO 8601 format, e.g., 2025-05-01T00:00:00Z).
144+
* Start date (inclusive) of the period for which you want to retrieve impact data (ISO 8601 format, e.g. 2025-05-01T00:00:00Z).
145145
*/
146146
startDate?: Date
147147
/**
148148
* End date (exclusive) of the period for which you want to retrieve impact data (ISO 8601 format, with time in UTC, `YYYY-MM-DDTHH:MM:SSZ`). Defaults to today's date.
149149
*/
150150
endDate?: Date
151151
/**
152-
* List of regions to filter by (\"fr-par\"). Defaults to all regions.
152+
* List of regions to filter by (e.g. `fr-par`). Defaults to all regions.
153153
*/
154154
regions?: string[]
155155
/**
156-
* List of zones to filter by (\"fr-par-1\"). Defaults to all zones.
156+
* List of zones to filter by (e.g. `fr-par-1`). Defaults to all zones.
157157
*/
158158
zones?: string[]
159159
/**
@@ -180,7 +180,7 @@ export type UserApiGetImpactReportAvailabilityRequest = {
180180
*/
181181
startDate?: Date
182182
/**
183-
* End date of the search period (ISO 8601 format, with time in UTC, `YYYY-MM-DDTHH:MM:SSZ`). The date is exclusive. Defaults to today's date.
183+
* End date of the search period (ISO 8601 format, with time in UTC, `YYYY-MM-DDTHH:MM:SSZ`). The date is inclusive. Defaults to today's date.
184184
*/
185185
endDate?: Date
186186
}

0 commit comments

Comments
 (0)