[IN:7186] API limit 500 by miss525 · Pull Request #41 · Inflectra/spira-documentation

miss525 · 2026-03-10T13:27:47Z

Added a Info box about limitation row 203-207
Also, added an additional explanation in line 170

Added a Info box about limitation row 203-207 Also, added an additional explanation in line 170

simonhbor

Looks good in general - some typos and small corrections

simonhbor · 2026-03-10T13:29:23Z

docs/Developers/API-Overview.md


 - **start_row** : The record starting number. This parameter starts at 1.
- **number_of_rows** : The maximum number of records to return. The bigger the number, the more time it takes for the request to be processed. If you are seeing timeout errors, reduce this value and make more requests to retrieve the data.
+- **number_of_rows** : The maximum number of records to return. The bigger the number, the more time it takes for the request to be processed. If you are seeing timeout errors, reduce this value and make more requests to retrieve the data. Note, that currently there is a limiteation so the maximum allowed number of rows per single API call is 500.


Please fix the typo for "limiteation"

simonhbor · 2026-03-10T13:29:41Z

docs/Developers/API-Overview.md

        []
        ```

+!!! info Limitation 


Correct syntax should be !!! info "Limitation"

This needs to be exactly as I said it above. You need the " " around the word Limitation

simonhbor · 2026-03-10T13:31:00Z

docs/Developers/API-Overview.md


+!!! info Limitation 
+    Currently, there is a limitation for the allowed number of rows that can be retrieved per single API GET query at a time. That is a design limit to protect the system from a performance perspective, typical for web applications. The maximum number of rows you can get by a single GET request is 500, for general API endpoints.
+    Considering this, make multiple GET requests (use pagination options) so the number of rows does not exceed that limit.


You need to add an empty line between paragraphs (not required for bullets but is for paragraphs)

simonhbor · 2026-03-10T13:32:15Z

docs/Developers/API-Overview.md

        ```

+!!! info Limitation 
+    Currently, there is a limitation for the allowed number of rows that can be retrieved per single API GET query at a time. That is a design limit to protect the system from a performance perspective, typical for web applications. The maximum number of rows you can get by a single GET request is 500, for general API endpoints.


IN per single API GET query at a time remove the GET as I think the limit applies to POST too. Do the same later in the sentence and in the paragraph below

Done all three PRs.
Hope this time all of them correct.
Sorry for extra time.

Replaced incorrect Atlassian login with DevOps login on line 27

simonhbor

Something went wrong here - there are git lines included, and there are outstanding syntax fixes to do.

simonhbor · 2026-03-13T15:20:37Z

docs/Developers/API-Overview.md

        []
        ```

+!!! info Limitation 


This needs to be exactly as I said it above. You need the " " around the word Limitation

simonhbor · 2026-03-13T15:21:09Z

docs/Developers/API-Overview.md

 - **start_row** : The record starting number. This parameter starts at 1.
- **number_of_rows** : The maximum number of records to return. The bigger the number, the more time it takes for the request to be processed. If you are seeing timeout errors, reduce this value and make more requests to retrieve the data. Note, that currently there is a limiteation so the maximum allowed number of rows per single API call is 500.
+- **number_of_rows** : The maximum number of records to return. The bigger the number, the more time it takes for the request to be processed. If you are seeing timeout errors, reduce this value and make more requests to retrieve the data.
+ Note, that currently there is a limitation so the maximum allowed number of rows per single API call is 500.


You need to add an empty line here and outdent, or you need to include it as part of line 170

simonhbor · 2026-03-13T15:21:18Z

docs/Developers/API-Overview.md

        []
        ```

+<<<<<<< Updated upstream


Clean this up please

simonhbor · 2026-03-13T15:21:48Z

docs/Developers/API-Overview.md


+=======
+!!! info "Limitation"
+Currently, there is a limitation for the allowed number of rows that can be retrieved per single API query at a time. That is a design limit to protect the system from a performance perspective, typical for web applications. The maximum number of rows you can get by a single GET request is 500, for general API endpoints.


This needs to be indented

simonhbor · 2026-03-13T15:21:58Z

docs/Developers/API-Overview.md

+=======
+!!! info "Limitation"
+Currently, there is a limitation for the allowed number of rows that can be retrieved per single API query at a time. That is a design limit to protect the system from a performance perspective, typical for web applications. The maximum number of rows you can get by a single GET request is 500, for general API endpoints.
+    Considering this, make multiple GET requests (use pagination options) so the number of rows does not exceed that limit.


You need an empty line between paragraphs

simonhbor · 2026-03-13T15:22:03Z

docs/Developers/API-Overview.md

+Currently, there is a limitation for the allowed number of rows that can be retrieved per single API query at a time. That is a design limit to protect the system from a performance perspective, typical for web applications. The maximum number of rows you can get by a single GET request is 500, for general API endpoints.
+    Considering this, make multiple GET requests (use pagination options) so the number of rows does not exceed that limit.
+
+>>>>>>> Stashed changes


Clean this up please

[IN:7186] API limit 500

12ca5b2

Added a Info box about limitation row 203-207 Also, added an additional explanation in line 170

simonhbor requested changes Mar 10, 2026

View reviewed changes

simonhbor assigned miss525 Mar 10, 2026

miss525 assigned simonhbor and unassigned miss525 Mar 12, 2026

simonhbor assigned miss525 and unassigned simonhbor Mar 12, 2026

[IN:11730] Replaced incorrect Atlassian login

d584db1

Replaced incorrect Atlassian login with DevOps login on line 27

miss525 assigned simonhbor and unassigned miss525 Mar 13, 2026

simonhbor requested changes Mar 13, 2026

View reviewed changes

simonhbor assigned miss525 and unassigned simonhbor Mar 13, 2026

Conversation

miss525 commented Mar 10, 2026

Uh oh!

simonhbor left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

simonhbor left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants