Skip to content

docs(environmental_footprint): update fields descriptions #1288

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
merged 1 commit into from
Oct 2, 2025
Merged

docs(environmental_footprint): update fields descriptions #1288

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
12 changes: 6 additions & 6 deletions scaleway-async/scaleway_async/environmental_footprint/v1alpha1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ async def get_impact_report_availability(
Returns a list of dates of available impact reports.
:param organization_id: The UUID of the Organization for which you want to download a report.
:param start_date: Start date of the search period (ISO 8601 format, with time in UTC, `YYYY-MM-DDTHH:MM:SSZ`). The date is inclusive.
:param end_date: 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.
:param end_date: 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.
:return: :class:`ImpactReportAvailability <ImpactReportAvailability>`

Usage:
Expand Down Expand Up @@ -75,8 +75,8 @@ async def download_impact_report(
Download PDF impact report.
Download a Scaleway impact PDF report with detailed impact data for your Scaleway projects.
:param organization_id: The UUID of the Organization for which you want to download a report.
:param date: The start date of the period for which you want to download a report (ISO 8601 format, e.g., 2025-05-01T00:00:00Z).
:param type_: Type of report to download (e.g., monthly). Defaults to monthly.
:param date: The start date of the period for which you want to download a report (ISO 8601 format, e.g. 2025-05-01T00:00:00Z).
:param type_: Type of report to download (e.g. `monthly`).
:return: :class:`ScwFile <ScwFile>`

Usage:
Expand Down Expand Up @@ -117,10 +117,10 @@ async def get_impact_data(
Retrieve detailed impact data.
Retrieve detailed impact data for your Scaleway projects within a specified date range. Filter by project ID, region, zone, service category, and/or product category.
:param organization_id: The UUID of the Organization for which you want to download a report.
:param start_date: Start date (inclusive) of the period for which you want to retrieve impact data (ISO 8601 format, e.g., 2025-05-01T00:00:00Z).
:param start_date: Start date (inclusive) of the period for which you want to retrieve impact data (ISO 8601 format, e.g. 2025-05-01T00:00:00Z).
:param end_date: 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.
:param regions: List of regions to filter by (\"fr-par\"). Defaults to all regions.
:param zones: List of zones to filter by (\"fr-par-1\"). Defaults to all zones.
:param regions: List of regions to filter by (e.g. `fr-par`). Defaults to all regions.
:param zones: List of zones to filter by (e.g. `fr-par-1`). Defaults to all zones.
:param project_ids: List of Project IDs to filter by. Defaults to all Projects in the Organization.
:param service_categories: List of service categories to filter by. Defaults to all service categories.
:param product_categories: List of product categories to filter by. Defaults to all product categories.
Expand Down
12 changes: 6 additions & 6 deletions scaleway-async/scaleway_async/environmental_footprint/v1alpha1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,12 +178,12 @@ class UserApiDownloadImpactReportRequest:

date: Optional[datetime] = None
"""
The start date of the period for which you want to download a report (ISO 8601 format, e.g., 2025-05-01T00:00:00Z).
The start date of the period for which you want to download a report (ISO 8601 format, e.g. 2025-05-01T00:00:00Z).
"""

type_: Optional[ReportType] = ReportType.UNKNOWN_REPORT_TYPE
"""
Type of report to download (e.g., monthly). Defaults to monthly.
Type of report to download (e.g. `monthly`).
"""


Expand All @@ -196,7 +196,7 @@ class UserApiGetImpactDataRequest:

start_date: Optional[datetime] = None
"""
Start date (inclusive) of the period for which you want to retrieve impact data (ISO 8601 format, e.g., 2025-05-01T00:00:00Z).
Start date (inclusive) of the period for which you want to retrieve impact data (ISO 8601 format, e.g. 2025-05-01T00:00:00Z).
"""

end_date: Optional[datetime] = None
Expand All @@ -206,12 +206,12 @@ class UserApiGetImpactDataRequest:

regions: Optional[list[str]] = field(default_factory=list)
"""
List of regions to filter by (\"fr-par\"). Defaults to all regions.
List of regions to filter by (e.g. `fr-par`). Defaults to all regions.
"""

zones: Optional[list[str]] = field(default_factory=list)
"""
List of zones to filter by (\"fr-par-1\"). Defaults to all zones.
List of zones to filter by (e.g. `fr-par-1`). Defaults to all zones.
"""

project_ids: Optional[list[str]] = field(default_factory=list)
Expand Down Expand Up @@ -244,5 +244,5 @@ class UserApiGetImpactReportAvailabilityRequest:

end_date: Optional[datetime] = None
"""
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.
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.
"""
12 changes: 6 additions & 6 deletions scaleway/scaleway/environmental_footprint/v1alpha1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def get_impact_report_availability(
Returns a list of dates of available impact reports.
:param organization_id: The UUID of the Organization for which you want to download a report.
:param start_date: Start date of the search period (ISO 8601 format, with time in UTC, `YYYY-MM-DDTHH:MM:SSZ`). The date is inclusive.
:param end_date: 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.
:param end_date: 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.
:return: :class:`ImpactReportAvailability <ImpactReportAvailability>`

Usage:
Expand Down Expand Up @@ -75,8 +75,8 @@ def download_impact_report(
Download PDF impact report.
Download a Scaleway impact PDF report with detailed impact data for your Scaleway projects.
:param organization_id: The UUID of the Organization for which you want to download a report.
:param date: The start date of the period for which you want to download a report (ISO 8601 format, e.g., 2025-05-01T00:00:00Z).
:param type_: Type of report to download (e.g., monthly). Defaults to monthly.
:param date: The start date of the period for which you want to download a report (ISO 8601 format, e.g. 2025-05-01T00:00:00Z).
:param type_: Type of report to download (e.g. `monthly`).
:return: :class:`ScwFile <ScwFile>`

Usage:
Expand Down Expand Up @@ -117,10 +117,10 @@ def get_impact_data(
Retrieve detailed impact data.
Retrieve detailed impact data for your Scaleway projects within a specified date range. Filter by project ID, region, zone, service category, and/or product category.
:param organization_id: The UUID of the Organization for which you want to download a report.
:param start_date: Start date (inclusive) of the period for which you want to retrieve impact data (ISO 8601 format, e.g., 2025-05-01T00:00:00Z).
:param start_date: Start date (inclusive) of the period for which you want to retrieve impact data (ISO 8601 format, e.g. 2025-05-01T00:00:00Z).
:param end_date: 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.
:param regions: List of regions to filter by (\"fr-par\"). Defaults to all regions.
:param zones: List of zones to filter by (\"fr-par-1\"). Defaults to all zones.
:param regions: List of regions to filter by (e.g. `fr-par`). Defaults to all regions.
:param zones: List of zones to filter by (e.g. `fr-par-1`). Defaults to all zones.
:param project_ids: List of Project IDs to filter by. Defaults to all Projects in the Organization.
:param service_categories: List of service categories to filter by. Defaults to all service categories.
:param product_categories: List of product categories to filter by. Defaults to all product categories.
Expand Down
12 changes: 6 additions & 6 deletions scaleway/scaleway/environmental_footprint/v1alpha1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,12 +178,12 @@ class UserApiDownloadImpactReportRequest:

date: Optional[datetime] = None
"""
The start date of the period for which you want to download a report (ISO 8601 format, e.g., 2025-05-01T00:00:00Z).
The start date of the period for which you want to download a report (ISO 8601 format, e.g. 2025-05-01T00:00:00Z).
"""

type_: Optional[ReportType] = ReportType.UNKNOWN_REPORT_TYPE
"""
Type of report to download (e.g., monthly). Defaults to monthly.
Type of report to download (e.g. `monthly`).
"""


Expand All @@ -196,7 +196,7 @@ class UserApiGetImpactDataRequest:

start_date: Optional[datetime] = None
"""
Start date (inclusive) of the period for which you want to retrieve impact data (ISO 8601 format, e.g., 2025-05-01T00:00:00Z).
Start date (inclusive) of the period for which you want to retrieve impact data (ISO 8601 format, e.g. 2025-05-01T00:00:00Z).
"""

end_date: Optional[datetime] = None
Expand All @@ -206,12 +206,12 @@ class UserApiGetImpactDataRequest:

regions: Optional[list[str]] = field(default_factory=list)
"""
List of regions to filter by (\"fr-par\"). Defaults to all regions.
List of regions to filter by (e.g. `fr-par`). Defaults to all regions.
"""

zones: Optional[list[str]] = field(default_factory=list)
"""
List of zones to filter by (\"fr-par-1\"). Defaults to all zones.
List of zones to filter by (e.g. `fr-par-1`). Defaults to all zones.
"""

project_ids: Optional[list[str]] = field(default_factory=list)
Expand Down Expand Up @@ -244,5 +244,5 @@ class UserApiGetImpactReportAvailabilityRequest:

end_date: Optional[datetime] = None
"""
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.
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.
"""