Mercurial > p > roundup > code
comparison doc/upgrading.txt @ 8566:e4191aa7b402 default tip
doc: issue2551415 correct doc for change input->input_payload
in 2.5 the rest interface changed a variable name from input to
input_payload. An earlier commit changed the rest docs. This commit
adds an item for it to the upgrading 2.4.0->2.5.0 section. Also cross
reference added to the rest docs with the updated examples.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Thu, 09 Apr 2026 00:19:06 -0400 |
| parents | e738377b4ffe |
| children |
comparison
equal
deleted
inserted
replaced
| 8565:792eb77554fb | 8566:e4191aa7b402 |
|---|---|
| 581 Open question: why does there have to be an error generated by the | 581 Open question: why does there have to be an error generated by the |
| 582 url @sort=1. Without invalid sort param, the exploit url doesn't | 582 url @sort=1. Without invalid sort param, the exploit url doesn't |
| 583 work and the context appears to use the database's title not the one | 583 work and the context appears to use the database's title not the one |
| 584 in the url. Also its not positional @sort=1 can appear anywhere in | 584 in the url. Also its not positional @sort=1 can appear anywhere in |
| 585 the url. | 585 the url. |
| 586 | |
| 587 Modify Custom Rest Endpoints (required) | |
| 588 --------------------------------------- | |
| 589 | |
| 590 As part of code maintenance and cleanup, the ``input`` variable used | |
| 591 when defining new REST endpoints was renamed to ``input_payload``. The | |
| 592 ``input`` variable was shadowing the ``input`` built-in function and | |
| 593 was renamed. | |
| 594 | |
| 595 So if you defined a custom REST endpoint in interfaces.py and it looks | |
| 596 like:: | |
| 597 | |
| 598 def summary2(self, input): | |
| 599 | |
| 600 you should change it to read:: | |
| 601 | |
| 602 def summary2(self, input_payload): | |
| 603 | |
| 604 and change any references to input inside the function to | |
| 605 ``input_payload``. The section :ref:`adding_new_rest_endpoints` has | |
| 606 been updated if you need additional examples. | |
| 586 | 607 |
| 587 Deprecation Notices (required) | 608 Deprecation Notices (required) |
| 588 ------------------------------ | 609 ------------------------------ |
| 589 | 610 |
| 590 * Support for SQLite version 2 has been removed in 2.5.0. | 611 * Support for SQLite version 2 has been removed in 2.5.0. |