Add Pagination to API Server

[Catharsis68]

Improved by adding pagination capabilities to api-server API

• The feature can be enabled via PAGINATION: "true"
• users SP
• users account
• users admin
• accounts
• accounts - api_keys
• accounts - applications
• accounts - voip carriers
• /:sid/Accounts/Availability
• applications
• service_providers
• service_providers - voip carriers
• service_providers - phone numbers
• service_providers - applications
• service_providers - accounts
• service_providers - api_keys
• LCR routes
• Added new swagger-pagination file

How to test

Please describe the individual steps on how a peer can test your change.

Precondition: Run api-server locally, set PAGINATION: "true"

1. Login via {{base_url}}/v1/login
2. Copy the token for all upcoming requests
3. Bearer

GET 

{{base_url}}/v1/Accounts?limit=25&page=1
{{base_url}}/v1/Accounts/:account_sid/ApiKeys?limit=25&page=1
{{base_url}}/v1/Accounts/:account_sid/Applications?limit=25&page=1
{{base_url}}/v1/Accounts/:account_sid/VoipCarriers?limit=2&page=1

{{base_url}}/v1/Applications?limit=25&page=1

{{base_url}}/v1/PhoneNumbers?limit=25&page=1

{{base_url}}/v1/lcrs?limit=25&page=1
{{base_url}}/v1/LcrRoutes?limit=25&page=1&lcr_sid=<lcr_sid>

{{base_url}}/v1/ServiceProviders?limit=25&page=1
{{base_url}}/v1/ServiceProviders/:serviceProviderSid/Accounts?limit=25&page=1
{{base_url}}/v1/ServiceProviders/:serviceProviderSid/ApiKeys?limit=25&page=1
{{base_url}}/v1/ServiceProviders/:serviceProviderSid/Applications?limit=25&page=1
{{base_url}}/v1/ServiceProviders/:serviceProviderSid/PhoneNumbers?limit=25&page=1
{{base_url}}/v1/ServiceProviders/:serviceProviderSid/VoipCarriers?limit=25&page=1

{{base_url}}/v1/Users?limit=25&page=1

{{base_url}}/v1/VoipCarriers?limit=25&page=1

{{base_url}}/swagger

[davehorton]

@Catharsis68 these changes are backwards-compatible?

[Catharsis68]

@davehorton what do you exatly mean by "backwards-compatible" ?
So the behavior in general is the following:

As soon as the environment variable PAGINATION: "true" and there is a query.limit + query.page - the result is in the paginated response structure

Otherwise the "actual" non-paginated response is sent

[davehorton]

right, just wanted to confirm that if the environment variable is not set then pre-existing apis remain the same

[EgleHelms]

@davehorton any news on this?

This feature was proposed as a solution to the pentest outcome. Requests with large amounts of data can cause longer response times and peak loads on the web and database server. This could be used for so-called low and slow-distributed denial of service attacks.