Issue #3539
closed
Install drf_openapi when installing pulp3
Tags:
Documentation, Easy Fix
Description
Right now, in order to have access to auto generated docs, it is necessary an extra step to install drf_openapi
pip3 install -e git+https://github.com/limdauto/drf_openapi.git@54d24fb#egg=drf_openapi
I would like to suggest this extra step to be removed, and drf_openapi be installed together with pulp.
- Groomed changed from No to Yes
- Sprint Candidate changed from No to Yes
- Groomed changed from Yes to No
- Sprint Candidate changed from Yes to No
bizhang, does this also work when installing pulpcore from source?
Yep!
pip install -e .['test']
for local installs
pip3 install -e "git+https://github.com/werwty/pulp.git@3.0-dev#egg=pulpcore[test]&subdirectory=plugin"
for remote
- Related to Task #3533: Prepare for pypi pulp3 beta release added
In terms of a mechanism, I think having the optional setuptools approach is right.
I also want to hear feedback on this question: should all Pulp installations ship with local API docs by default?
I also want to hear feedback on this question: should all Pulp installations ship with local API docs by default?
Seems easier to just have a central place for users to see their api schema for their particular set up rather than having to hunt down the docs online for core, plugins, etc; and then have to look up what versions of things that are being used, etc.
Are there any downsides?
- Triaged changed from No to Yes
- Sprint set to Sprint 35
- Tags Easy Fix added
When I think of dependencies I think of things that pulp must have in order to run.
Tools like drf_openapi/drf_yawg is nice to have but not necessary; the schema is still available to the user when they GET /api/v3/; all this optional dependencies provide is a nice UI wrapper on top.
- Status changed from NEW to ASSIGNED
- Assignee set to dalley
- Status changed from ASSIGNED to POST
- Status changed from POST to CLOSED - WONTFIX
- Assignee deleted (
dalley)
- Sprint deleted (
Sprint 35)
- Sprint/Milestone set to 3.0.0
Also available in: Atom
PDF