Rest API response "page_size" missing in M2.4.4

anvanza commented 2 years ago

Preconditions (*)

Install a 2.4.3-p1

Steps to reproduce (*)

On 2.4.3-p1 create a GET request to rest/all/V1/orders/?searchCriteria[filterGroups][0][filters][0][field]=status&searchCriteria[filterGroups][0][filters][0][value]=processing&searchCriteria[filterGroups][0][filters][0][conditionType]=eq&searchCriteria[currentPage]=1

The response should return something like: Screenshot 2022-04-14 at 13 56 35

{
"items": [.....],
"search_criteria": {
    "filter_groups": [
        {
            "filters": [
                {
                    "field": "status",
                    "value": "processing",
                    "condition_type": "eq"
                }
            ]
        }
    ],
    "page_size": 20,
    "current_page": 1
},
"total_count": 20
}

Try the same request on 2.4.4

Expected result (*)

The metadata in the response should be the exact same on Magento 2.4.3-p1 and 2.4.4

Actual result (*)

The page_size is missing Screenshot 2022-04-14 at 13 56 49

{
"items": [.....],
"search_criteria": {
    "filter_groups": [
        {
            "filters": [
                {
                    "field": "status",
                    "value": "processing",
                    "condition_type": "eq"
                }
            ]
        }
    ],
    "current_page": 1
},
"total_count": 20
}

Please provide Severity assessment for the Issue as Reporter. This information will help during Confirmation and Issue triage processes.

[ ] Severity: S0 - Affects critical data or functionality and leaves users without workaround.
[x] Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
[ ] Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
[ ] Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
[ ] Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

m2-assistant[bot] commented 2 years ago

Hi @anvanza. Thank you for your report. To speed up processing of this issue, make sure that you provided the following information:

Summary of the issue
Information on your environment
Steps to reproduce
Expected and actual results

Make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

@magento give me 2.4-develop instance - upcoming 2.4.x release

For more details, review the Magento Contributor Assistant documentation.

Add a comment to assign the issue: @magento I am working on this

To learn more about issue processing workflow, refer to the Code Contributions.

Join Magento Community Engineering Slack and ask your questions in #github channel.

:warning: According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

:clock10: You can find the schedule on the Magento Community Calendar page.

:telephone_receiver: The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

:pencil2: Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

anvanza commented 2 years ago

@magento give me 2.4.3-p1 instance

magento-deployment-service[bot] commented 2 years ago

Hi @anvanza. Thank you for your request. I'm working on Magento instance for you.

anvanza commented 2 years ago

@magento give me 2.4.4 instance

magento-deployment-service[bot] commented 2 years ago

Hi @anvanza. Thank you for your request. I'm working on Magento instance for you.

magento-deployment-service[bot] commented 2 years ago

Hi @anvanza, unfortunately there is no ability to deploy Magento instance at the moment. Please try again later.

magento-deployment-service[bot] commented 2 years ago

Hi @anvanza, unfortunately there is no ability to deploy Magento instance at the moment. Please try again later.

mackieee commented 2 years ago

@anvanza Do you have a figure filled in the new Web API input limits? (Found in Configuration -> Services -> Magento Web API).

Could attempt again upon setting your own Page size default?

anvanza commented 2 years ago

@mackieee , I found the default page size config field. Added 20 in there but the result is still the same. The page_size is still missing in the response.

m2-assistant[bot] commented 2 years ago

Hi @engcom-November. Thank you for working on this issue. In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:

[ ] 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
Details
If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.
[ ] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.
[ ] 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.
[ ] 4. Verify that the issue is reproducible on 2.4-develop branch
Details
- Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
- If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
- If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
[ ] 5. Add label Issue: Confirmed once verification is complete.
[ ] 6. Make sure that automatic system confirms that report has been added to the backlog.

engcom-November commented 2 years ago

Hi @anvanza , Thank you for reporting and collaboration. Verified the behavior on Magento 2.4-develop branch and 2.4.4 version as well. and is reproducible. However, by setting searchCriteria[pageSize] in Params, issue is not reproducible. "page_size" retrieved in the response:

As per dev docs as well, page_size is not retrieved In the example response, if it is not set in request. page_size is not retrieved in the response.

Same behavior can be observed in 2.4.3-p1 instance for "current_page" field.

Kindly recheck the behavior on Magento 2.4-develop branch / 2.4.4 version by sending request with "page_size" param and let us know if you are still facing issue. Thank you.

anvanza commented 2 years ago

Hi @engcom-November ,

True, On 2.4.4 the page_size is returned when searchCriteria[pageSize] is set. While on 2.4.3-p1 it returned page_size even when searchCriteria[pageSize] is not set.

engcom-November commented 2 years ago

Hi @anvanza,

We are moving this ticket to "On Hold" as we are awaiting confirmation from PO for expected behavior. Thank you.

Viktorja1 commented 2 years ago

@magento give me 2.4.4 instance

magento-deployment-service[bot] commented 2 years ago

Hi @Viktorja1. Thank you for your request. I'm working on Magento instance for you.

magento-deployment-service[bot] commented 2 years ago

Hi @Viktorja1, unfortunately there is no ability to deploy Magento instance at the moment. Please try again later.

engcom-Hotel commented 1 year ago

Hello @anvanza,

We have got reply from the PO, and as per him this is an issue but the page size is a part of any GET rest request that is a multi-entity response.

Even if not passed, the page size should be present, because the rest should have a fixed payload/schema.

Of course, this is not a blocker because they could include a simple logic to check for the existence of the key in the logic and just assume a default of pagesize= 20.

Hence confirming this issue for further processing.

Thanks

github-jira-sync-bot commented 1 year ago

:white_check_mark: Jira issue https://jira.corp.adobe.com/browse/AC-7878 is successfully created for this GitHub issue.

m2-assistant[bot] commented 1 year ago

:white_check_mark: Confirmed by @engcom-Hotel. Thank you for verifying the issue.
Issue Available: @engcom-Hotel, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.