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

[WIP] Add @addons endpoint #556

Open
wants to merge 18 commits into
base: master
from

Conversation

Projects
None yet
4 participants
@esteele
Member

esteele commented Jun 24, 2018

Beginning to add the @addons endpoint as per our discussion earlier today.

GET /@addons : Lists all addons
GET /@addons/package.name : Shows details of a particular addon
POST /@addons/package.name/install: Installs the addon
POST /@addons/package.name/uninstall: Uninstalls the addon
POST /@addons/package.name/upgrade: Upgrades addon to latest version

"upgrade_profiles": {},
"uninstall_profile_id": "plone.session:uninstall",
"other_profiles": [],
"is_installed": "FALSE",

This comment has been minimized.

@lukasgraf

lukasgraf Jun 24, 2018

Member

That should probably be serialized to JavsScript false. Same for "NULL" below.

Show resolved Hide resolved docs/source/_json/addons_get.resp Outdated
Show resolved Hide resolved docs/source/_json/addons_get_list.resp Outdated
@@ -0,0 +1,6 @@
HTTP/1.1 200 OK

This comment has been minimized.

@lukasgraf

lukasgraf Jun 24, 2018

Member

We might want to mirror the behavior of POST for content CRUD operations here:

  • Return 204 No Content to just acknowledge success (we don't really have anything else to say here)
  • Return 200 OK with the new representation of the "addon resource" if the client requests it via the Prefer: return=representation header

I think the same should be applicable to uninstall and upgrade.

@coveralls

This comment has been minimized.

coveralls commented Jun 24, 2018

Coverage Status

Coverage decreased (-0.7%) to 95.769% when pulling 4709ea0 on addons-endpoint into c92af77 on master.

@@ -22,6 +22,7 @@ Contents
content
history
batching
addons

This comment has been minimized.

@lukasgraf

lukasgraf Jun 24, 2018

Member

FYI: If you want to supress the Sphinx warning, but don't want it included in the toctree yet, you can add :orphan: at the top of the file.

@tisto tisto added this to the 3.x.x milestone Jun 24, 2018

@tisto tisto changed the title from Add @addons endpoint to [WIP] Add @addons endpoint Jun 24, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment