Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

APIs return incorrect information for pages with fields using the variable name "description" #28785

Closed
weiyiwang-dotcms opened this issue Jun 6, 2024 · 3 comments · Fixed by #28877 or #28979
Closed

APIs return incorrect information for pages with fields using the variable name "description" #28785

weiyiwang-dotcms opened this issue Jun 6, 2024 · 3 comments · Fixed by #28877 or #28979
Assignees
@gortiz-dotcms
Labels
OKR : Customer Success Owned by Arno OKR : Customer Support Owned by Scott Priority : 1 Show Stopper QA : Approved Release : 23.01.18 Included in LTS patch release 23.01.18 Release : 23.10.24 v11 Included in LTS patch release 23.10.24 v11 Release : 24.04.24 v3 Included in LTS patch release 24.04.24 v3 Release : 24.06.26 Bug Fixing Team : Bug Fixers Type : Defect

Comments

@weiyiwang-dotcms
Copy link

Parent Issue

No response

Problem Statement

When making an API request for data from a page, the "description" field of the page does not get populated with the correct information. This only applies to fields with the specific variable name "description".

This impacts any users who are trying to use APIs to query page information about the "description" field

Steps to Reproduce

  1. Add a field "description" to the page asset content type
  2. Create a new page, and populate the "description" field
  3. Call the page API for the newly created page
  4. The "description" returned in the API response will match the "title" field rather than the "description" field.

Acceptance Criteria

Have the "description" field resolve to the expected value in API responses.

dotCMS Version

Master branch, 23.10.24

Proposed Objective

Technical User Experience

Proposed Priority

Priority 2 - Important

External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

https://dotcms.zendesk.com/agent/tickets/116553
https://dotcms.slack.com/archives/CSHTYUR7H/p1717690580891459
https://dotcms.slack.com/archives/C074RCMMQE9/p1717686574484629?thread_ts=1717684361.114839&cid=C074RCMMQE9

Assumptions & Initiation Needs

No response

Quality Assurance Notes & Workarounds

No response

Sub-Tasks & Estimates

No response
@erickgonzalez erickgonzalez moved this from New to Current Sprint Backlog in dotCMS - Product Planning Jun 7, 2024
@erickgonzalez erickgonzalez added the OKR : Customer Success Owned by Arno label Jun 7, 2024
@erickgonzalez erickgonzalez moved this from Current Sprint Backlog to In Progress in dotCMS - Product Planning Jun 10, 2024
gortiz-dotcms added a commit that referenced this issue Jun 10, 2024
@gortiz-dotcms
chore: added logger to check values (#28785)
2345416
gortiz-dotcms added a commit that referenced this issue Jun 11, 2024
@gortiz-dotcms
fix: modified base setter in page fields and added logger to check va…
595aa10 
…lues (#28785)
gortiz-dotcms added a commit that referenced this issue Jun 13, 2024
@gortiz-dotcms
fix: modified default page field from description to friendlyName and…
f599572 
… removed loggers (#28785)
@erickgonzalez erickgonzalez added the Next LTS Release Shortlisted of issues that will be included in the upcoming LTS label Jun 13, 2024
erickgonzalez added a commit that referenced this issue Jun 13, 2024
@erickgonzalez
#28785 include in 23.01.18 LTS
9c63cce
gortiz-dotcms added a commit that referenced this issue Jun 13, 2024
@gortiz-dotcms
test: new test (#28785)
2705a62
@gortiz-dotcms gortiz-dotcms mentioned this issue Jun 13, 2024
Merged
@erickgonzalez erickgonzalez moved this from In Progress to In Review in dotCMS - Product Planning Jun 14, 2024
gortiz-dotcms added a commit that referenced this issue Jun 14, 2024
@gortiz-dotcms
fix: fix tests (#28785)
5613ef1
gortiz-dotcms added a commit that referenced this issue Jun 14, 2024
@gortiz-dotcms
fix: fix name of test file (#28785)
fa786f3
gortiz-dotcms added a commit that referenced this issue Jun 14, 2024
@gortiz-dotcms
fix: fix pre-request scripts and documentation of postman tests to go…
c913453 
…od practices (#28785)
erickgonzalez added a commit that referenced this issue Jun 17, 2024
@erickgonzalez
#28785 include in 23.10.24 LTS
e1d2b27
github-merge-queue bot pushed a commit that referenced this issue Jun 18, 2024
@gortiz-dotcms @erickgonzalez
Issue 28785 wrong field value api (#28877)
4366e40 
Fix: #28785 

Changed default field when returning content (page) from _description_
to _friendlyName_ and creation of postman test

---------

Co-authored-by: erickgonzalez <erick.gonzalez@dotcms.com>
@github-project-automation github-project-automation bot moved this from In Review to Internal QA in dotCMS - Product Planning Jun 18, 2024
erickgonzalez added a commit that referenced this issue Jun 18, 2024
@erickgonzalez
#28785 include in 24.04.24 LTS
267346c
@erickgonzalez
Copy link
Contributor

Screenshot 2024-06-18 at 4 01 26 PM

Working as it should now, the Description shows its value.

@erickgonzalez erickgonzalez moved this from Internal QA to QA - Backlog in dotCMS - Product Planning Jun 18, 2024
@erickgonzalez erickgonzalez added Release : 24.04.24 v3 Included in LTS patch release 24.04.24 v3 Release : 23.10.24 v11 Included in LTS patch release 23.10.24 v11 Release : 23.01.18 Included in LTS patch release 23.01.18 and removed Next LTS Release Shortlisted of issues that will be included in the upcoming LTS labels Jun 19, 2024
@bryanboza
Copy link
Member

We need some work here:

  • We have double status code validation in almost all the requests. We are validating it at the folder level and again at the HTTP request level. Remember, every request is inheriting everything from the parent.

Image

  • In the create page request, we need to validate something in the response, not just the 200 status code.

@bryanboza bryanboza moved this from QA - Backlog to QA - Rejected in dotCMS - Product Planning Jun 19, 2024
gortiz-dotcms added a commit that referenced this issue Jun 21, 2024
@gortiz-dotcms
test: refactor tests, removed redundant validations and added new ones (
3041e26 
#28785)
@gortiz-dotcms gortiz-dotcms mentioned this issue Jun 21, 2024
Merged
@bryanboza bryanboza added Release : 24.06.26 Bug Fixing and removed Release : 24.06.21 Bug Fixing Release : 24.06.26 Bug Fixing labels Jun 21, 2024
github-merge-queue bot pushed a commit that referenced this issue Jun 25, 2024
@gortiz-dotcms
Issue 28785 new validations in tests (#28979)
d04bdd9 
test: #28785 

Added new scripts on tests and removed redundant ones

From feedback:
#28785 (comment)
@bryanboza
Copy link
Member

Fixed, tested on trunk // Docker // Postman

@bryanboza bryanboza moved this from QA - Rejected to Done in dotCMS - Product Planning Jun 26, 2024
oidacra pushed a commit that referenced this issue Jun 26, 2024
@gortiz-dotcms @erickgonzalez @oidacra
Issue 28785 wrong field value api (#28877)
37edd5f 
Fix: #28785 

Changed default field when returning content (page) from _description_
to _friendlyName_ and creation of postman test

---------

Co-authored-by: erickgonzalez <erick.gonzalez@dotcms.com>
oidacra pushed a commit that referenced this issue Jun 26, 2024
@gortiz-dotcms @oidacra
Issue 28785 new validations in tests (#28979)
1fa23d9 
test: #28785 

Added new scripts on tests and removed redundant ones

From feedback:
#28785 (comment)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gortiz-dotcms gortiz-dotcms

Labels
OKR : Customer Success Owned by Arno OKR : Customer Support Owned by Scott Priority : 1 Show Stopper QA : Approved Release : 23.01.18 Included in LTS patch release 23.01.18 Release : 23.10.24 v11 Included in LTS patch release 23.10.24 v11 Release : 24.04.24 v3 Included in LTS patch release 24.04.24 v3 Release : 24.06.26 Bug Fixing Team : Bug Fixers Type : Defect
Projects
dotCMS - Product Planning
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Issue 28785 wrong field value api dotCMS/core
Issue 28785 new validations in tests dotCMS/core
4 participants
@bryanboza @erickgonzalez @weiyiwang-dotcms @gortiz-dotcms