Skip to content

Expose the summary for each ChangeDiff in the REST API #4

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.

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

Closed
jeremystretch opened this issue Jul 19, 2024 · 0 comments
Closed

Expose the summary for each ChangeDiff in the REST API #4

jeremystretch opened this issue Jul 19, 2024 · 0 comments
Assignees
Labels
type: feature A new feature or functionality

Comments

@jeremystretch
Copy link
Contributor

Plugin Version

v0.2.0

Proposed functionality

Extend the JSON representation of a ChangeDiff to include the summary diff, indicating only which attributes have changed and their current and original values.

The format of this representation is yet to be determined, but could look something like this:

{
    "status": {
        "old": "staging",
        "new": "active"
    },
    "description": {
        "old": "",
        "new": "Foo bar"
    }
}

Use case

Although a ChangeDiff retrieved via the REST API currently includes the complete set of original, main, and branch data, a client would need to reconstruct the summary diff locally. Providing this data (which is already conveyed via the web UI) makes it directly consumable by the client.

External dependencies

No response

@jeremystretch jeremystretch added the type: feature A new feature or functionality label Jul 19, 2024
@jeremystretch jeremystretch self-assigned this Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature A new feature or functionality
Projects
None yet
Development

No branches or pull requests

2 participants