sbecker59 / terraform-provider-statuspage

Terraform Statuspage provider
https://registry.terraform.io/providers/sbecker59/statuspage/
Mozilla Public License 2.0
8 stars 5 forks source link

Pagination parameters required #157

Closed sbecker59 closed 1 year ago

sbecker59 commented 1 year ago

Statuspage is making important performance-based changes to the authenticated REST API by enforcing pagination for a specific set of endpoints. If you have an existing integration with our REST API, you may need to make changes to your REST API calls to accommodate these changes, so please read on to understand the details.

Which endpoints are affected?

What's changing?

As of Aug 31, 2022, all GET requests made to the above endpoints accept the following pagination parameters, which are both initially optional:

These parameters will instruct the REST API to return a paginated set of results for a given endpoint, specifically returning up to per_page results that are offset by page. Previously, all GET requests to the above endpoints would have returned the full set of results without being paginated or truncated. Example request and response bodies for each endpoint can be viewed by referencing our API documentation.

As of Feb 28, 2023, all GET requests made to the above endpoints will have default values unless explicitly specified:

Requests that omit these parameters will return a truncated set equivalent of ?page=1&per_page=100 instead of the full set of results.

This PR was create by combining the following PRs:

156 build(deps): bump github.com/hashicorp/terraform-plugin-sdk/v2 from 2.24.1 to 2.25.0

156 build(deps): bump goreleaser/goreleaser-action from 3.2.0 to 4.2.0

155 build(deps): bump actions/cache from 3.0.11 to 3.2.5

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage: 27.27% and no project coverage change.

Comparison is base (d2cdd65) 80.53% compared to head (b8b67e8) 80.53%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #157 +/- ## ======================================= Coverage 80.53% 80.53% ======================================= Files 17 17 Lines 2004 2004 ======================================= Hits 1614 1614 Misses 316 316 Partials 74 74 ``` | [Impacted Files](https://app.codecov.io/gh/sbecker59/terraform-provider-statuspage/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=S%C3%A9bastien+BECKER) | Coverage Δ | | |---|---|---| | [statuspage/data\_source\_pages.go](https://app.codecov.io/gh/sbecker59/terraform-provider-statuspage/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=S%C3%A9bastien+BECKER#diff-c3RhdHVzcGFnZS9kYXRhX3NvdXJjZV9wYWdlcy5nbw==) | `90.90% <0.00%> (ø)` | | | [statuspage/resource\_component.go](https://app.codecov.io/gh/sbecker59/terraform-provider-statuspage/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=S%C3%A9bastien+BECKER#diff-c3RhdHVzcGFnZS9yZXNvdXJjZV9jb21wb25lbnQuZ28=) | `84.61% <0.00%> (ø)` | | | [statuspage/resource\_metric\_provider.go](https://app.codecov.io/gh/sbecker59/terraform-provider-statuspage/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=S%C3%A9bastien+BECKER#diff-c3RhdHVzcGFnZS9yZXNvdXJjZV9tZXRyaWNfcHJvdmlkZXIuZ28=) | `74.48% <0.00%> (ø)` | | | [statuspage/resource\_subsriber.go](https://app.codecov.io/gh/sbecker59/terraform-provider-statuspage/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=S%C3%A9bastien+BECKER#diff-c3RhdHVzcGFnZS9yZXNvdXJjZV9zdWJzcmliZXIuZ28=) | `83.80% <0.00%> (ø)` | | | [statuspage/resource\_incident.go](https://app.codecov.io/gh/sbecker59/terraform-provider-statuspage/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=S%C3%A9bastien+BECKER#diff-c3RhdHVzcGFnZS9yZXNvdXJjZV9pbmNpZGVudC5nbw==) | `89.15% <20.00%> (ø)` | | | [statuspage/resource\_page\_access\_user.go](https://app.codecov.io/gh/sbecker59/terraform-provider-statuspage/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=S%C3%A9bastien+BECKER#diff-c3RhdHVzcGFnZS9yZXNvdXJjZV9wYWdlX2FjY2Vzc191c2VyLmdv) | `71.42% <25.00%> (ø)` | | | [statuspage/resource\_component\_group.go](https://app.codecov.io/gh/sbecker59/terraform-provider-statuspage/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=S%C3%A9bastien+BECKER#diff-c3RhdHVzcGFnZS9yZXNvdXJjZV9jb21wb25lbnRfZ3JvdXAuZ28=) | `87.24% <28.57%> (ø)` | | | [statuspage/data\_source\_component\_groups.go](https://app.codecov.io/gh/sbecker59/terraform-provider-statuspage/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=S%C3%A9bastien+BECKER#diff-c3RhdHVzcGFnZS9kYXRhX3NvdXJjZV9jb21wb25lbnRfZ3JvdXBzLmdv) | `89.28% <33.33%> (ø)` | | | [statuspage/data\_source\_components.go](https://app.codecov.io/gh/sbecker59/terraform-provider-statuspage/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=S%C3%A9bastien+BECKER#diff-c3RhdHVzcGFnZS9kYXRhX3NvdXJjZV9jb21wb25lbnRzLmdv) | `89.65% <33.33%> (ø)` | | | [statuspage/resource\_page\_access\_group.go](https://app.codecov.io/gh/sbecker59/terraform-provider-statuspage/pull/157?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=S%C3%A9bastien+BECKER#diff-c3RhdHVzcGFnZS9yZXNvdXJjZV9wYWdlX2FjY2Vzc19ncm91cC5nbw==) | `80.98% <50.00%> (ø)` | | | ... and [2 more](https://app.codecov.io/gh/sbecker59/terraform-provider-statuspage/pull/157?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=S%C3%A9bastien+BECKER) | |

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.