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

Edit Content: Expose Date and User Information in Content API Response #28183

Closed
5 tasks done
Tracked by #25445
fmontes opened this issue Apr 10, 2024 · 3 comments · Fixed by #28603
Closed
5 tasks done
Tracked by #25445

Edit Content: Expose Date and User Information in Content API Response #28183

fmontes opened this issue Apr 10, 2024 · 3 comments · Fixed by #28603
Assignees
@jcastro-dotcms @zJaaal
Labels
OKR : Core Features Owned by Will Priority : 3 Average QA : Approved Release : 24.05.31 Bug Fixing Team : Lunik Team : Scout Type : New Functionality

Comments

@fmontes
Copy link
Member

fmontes commented Apr 10, 2024 •
edited by jcastro-dotcms
Loading

Parent

#25445

User Story

As a developer, I want to be able to access the creation, update, and publish date and user information of a contentlet in the content API response, so I can track the history of the content.

Currently, we have:

  • modUser: user id
  • modUserName: Full name
  • owner: creator user id
  • modDate: not sure what date this is
  • publishDate: publish date

Acceptance Criteria

We need to add
Preview Give feedback

Proposed Objective

Core Features

Proposed Priority

Priority 2 - High

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

N/A

Assumptions & Initiation Needs

  • The backend system should be able to capture and store the date and user information for contentlet actions.
  • API documentation should be updated to reflect the new properties in the response.

Quality Assurance Notes & Workarounds

  • QA should verify that the date and user information displayed in the API response matches the actual history of
@fmontes fmontes mentioned this issue Apr 10, 2024
Open
@fmontes fmontes moved this from New to Current Sprint Backlog in dotCMS - Product Planning Apr 10, 2024
@jcastro-dotcms jcastro-dotcms self-assigned this May 13, 2024
@jcastro-dotcms jcastro-dotcms moved this from Current Sprint Backlog to In Progress in dotCMS - Product Planning May 13, 2024
jcastro-dotcms added a commit that referenced this issue May 17, 2024
@jcastro-dotcms
chore(content) #28183 : Edit Content: Expose Date and User Informatio…
3aadb14 
…n in Content API Response
@jcastro-dotcms jcastro-dotcms linked a pull request May 17, 2024 that will close this issue
chore(content) #28183 : Edit Content: Expose Date and User Information in Content API Response #28603
Merged
@jcastro-dotcms jcastro-dotcms moved this from In Progress to In Review in dotCMS - Product Planning May 17, 2024
@jcastro-dotcms
Copy link
Contributor

jcastro-dotcms commented May 17, 2024 •
edited
Loading

Postman Tests are available in the following locations:

  • Content_Resource.postman_collection.json : Content Resource / Checking JSON Attributes
  • ContentResourceV1.postman_collection.json : ContentResourceV1 / Checking JSON Attributes
  • GraphQLTests.json : GraphQL / Page API / Checking Content Audit Attributes
  • PagesResourceTests.json : Page API - [api/v1/page] / Checking JSON Attributes

github-merge-queue bot pushed a commit that referenced this issue May 20, 2024
@jcastro-dotcms
chore(content) #28183 : Edit Content: Expose Date and User Informatio…
4c3a898 
…n in Content API Response (#28603)

### Proposed Changes
* Exposes audit information to all Contentlets in dotCMS.

Here's the list of audit properties that are being exposed, and how they
can be accessed by the different consumers:

| Attribute | REST Endpoint | Elasticsearch | GraphQL |
| -------- | ------- | ------- | ------- |
| `creationDate` | `creationDate` | `creationDate` | `creationDate` |
| `owner` | `owner` | `owner` | `owner` |
| `ownerName` | `ownerName` | Only the User ID is available | Reachable
inside the "owner" object |
| `modDate` | `modDate` | `modDate` | `modDate` |
| `modUser` | `modUser` | `modUser` | `modUser` |
| `modUserName` | `modUserName` | Only the User ID is available |
Reachable inside the "modUser" object |
| `publishDate` | `publishDate` | `sysPublishDate` | `publishDate` |
| `publishUser` | `publishUser` | `sysPublishUser` | `publishUser` |
| `publishUserName` | `publishUserName` | Only the User ID is available
| Reachable inside the "publishUser" object |
@github-project-automation github-project-automation bot moved this from In Review to Internal QA in dotCMS - Product Planning May 20, 2024
@github-project-automation github-project-automation bot moved this from Internal QA to Current Sprint Backlog in dotCMS - Product Planning May 21, 2024
@jcastro-dotcms jcastro-dotcms moved this from Current Sprint Backlog to Internal QA in dotCMS - Product Planning May 21, 2024
@zJaaal zJaaal self-assigned this May 21, 2024
@zJaaal
Copy link
Contributor

zJaaal commented May 21, 2024 •
edited
Loading

IQA Passed

Tested on the Postman tests indicated by @jcastro-dotcms and also Lucene Query from the Content Search and all cases include the requested properties.

Docker Image: [dotcms/dotcms:trunk_a481a77]

@zJaaal zJaaal moved this from Internal QA to QA - Backlog in dotCMS - Product Planning May 21, 2024
@bryanboza
Copy link
Member

Fixed, refactoring for the postman test in all the related resources applied here:

@bryanboza bryanboza moved this from QA - Backlog to Done in dotCMS - Product Planning May 28, 2024
@fmontes fmontes closed this as completed Jun 19, 2024
@github-project-automation github-project-automation bot moved this from Done to Internal QA in dotCMS - Product Planning Jun 19, 2024
@fmontes fmontes mentioned this issue Sep 17, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jcastro-dotcms jcastro-dotcms

@zJaaal zJaaal

Labels
OKR : Core Features Owned by Will Priority : 3 Average QA : Approved Release : 24.05.31 Bug Fixing Team : Lunik Team : Scout Type : New Functionality
Projects
dotCMS - Product Planning
Archived in project
Milestone
No milestone
4 participants
@fmontes @bryanboza @jcastro-dotcms @zJaaal