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

Do not return x_by fields for v2 API #10286

Closed
5 tasks done
kirrg001 opened this issue Dec 14, 2018 · 0 comments
Closed
5 tasks done

Do not return x_by fields for v2 API #10286

kirrg001 opened this issue Dec 14, 2018 · 0 comments
Assignees
@kirrg001
Labels
affects:api Affects the Ghost API server / core Issues relating to the server or core of Ghost

Comments

@kirrg001
Copy link
Contributor

kirrg001 commented Dec 14, 2018 •
edited
Loading

What

We decided to burn the x_by fields in API v2.

Instead, we will introduce a new concept/feature for v2, coming soon. I will link the issue here as soon as it's fully written down.

Why

  • we are currently working on integrations (API v2 - Authentication #9865)
  • integrations will have the permissions to update/create resources
  • we need to find a way that multiple models (users, integrations) can act on resources
  • we need to find a way to track changes (who did what when)

V2 is still in active development.
@kirrg001 kirrg001 added server / core Issues relating to the server or core of Ghost affects:api Affects the Ghost API labels Dec 14, 2018
@kirrg001 kirrg001 self-assigned this Dec 14, 2018
kirrg001 added a commit to kirrg001/Ghost that referenced this issue Dec 17, 2018
@kirrg001
Removed invitedBy from admin API: invitation endpoint
f8253c8 
refs TryGhost#10286

- we want to deprecate all `x_by` fields
- we would like to get rid of all usages to be able to easily remove the fields in the future
- `invitedBy` is not used in the admin client
This was referenced Dec 17, 2018
Merged
Merged
kevinansfield pushed a commit to TryGhost/Admin that referenced this issue Dec 17, 2018
@kirrg001 @kevinansfield
Removed invitedBy from signup routes (#1087)
d27c067 
refs TryGhost/Ghost#10286

- not used
- looking for more information? visit TryGhost/Ghost#10291
kirrg001 added a commit that referenced this issue Dec 17, 2018
@kirrg001
Removed invitedBy from admin API: invitation endpoint (#10291)
5d2ab19 
refs #10286

- we want to deprecate all `x_by` fields
- we would like to get rid of all usages to be able to easily remove the fields in the future
- `invitedBy` is not used in the admin client
@kirrg001 kirrg001 mentioned this issue Dec 17, 2018
Merged
@kirrg001 kirrg001 mentioned this issue Dec 17, 2018
Merged
kirrg001 added a commit to kirrg001/Ghost that referenced this issue Jan 3, 2019
@kirrg001
Removed x_by fields from API v2 response
6c66627 
refs TryGhost#10286

- v2 no longer exposes x_by fields (published_by, updated_by, created_by)
- we will add a brand new concept called activity stream/actions soon
kirrg001 added a commit that referenced this issue Jan 3, 2019
@kirrg001
Removed x_by fields from API v2 response
789a3c0 
refs #10286

- v2 no longer exposes x_by fields (published_by, updated_by, created_by)
- we will add a brand new concept called activity stream/actions soon
kirrg001 added a commit to kirrg001/Ghost that referenced this issue Jan 21, 2019
@kirrg001
Added quick fix to handle integration upserts for x_by columns
ea6d161 
refs TryGhost#10286

- this is just a hotfix for v0.1
- we keep the x_by fields for now and deprecate them
- as soon as an integration updates/inserts a resource, we just store the owner ID
- we currently work on a new concept for v2
- v2 no longer exposes or uses x_by, see TryGhost#10294
kirrg001 added a commit that referenced this issue Jan 21, 2019
@kirrg001
Added quick fix to handle integration upserts for x_by columns (#10295
3df7630 
)

refs #10286

- this is just a hotfix for v0.1
- we keep the x_by fields for now and deprecate them
- as soon as an integration updates/inserts a resource, we just store the owner ID
- we currently work on a new concept for v2
- v2 no longer exposes or uses x_by, see #10294
- we need to iterate on this change, because we currently use the naming `context.api_key_id` in the auth/API layer
@kirrg001 kirrg001 mentioned this issue Jan 29, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kirrg001 kirrg001

Labels
affects:api Affects the Ghost API server / core Issues relating to the server or core of Ghost
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kirrg001