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.

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

Remove privacy_level field from APIv3 #6257

Merged
merged 2 commits into from
Oct 9, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions docs/api/v3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,6 @@ Project details
},
"default_version": "stable",
"default_branch": "master",
"privacy_level": {
"code": "public",
"name": "Public",
},
"subproject_of": null,
"translation_of": null,
"urls": {
Expand Down Expand Up @@ -359,7 +355,6 @@ Version update

{
"active": true,
"privacy_level": "public"
}

:statuscode 204: Updated successfully
Expand Down
21 changes: 1 addition & 20 deletions readthedocs/api/v3/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -159,14 +159,6 @@ def get_success(self, obj):
return None


class PrivacyLevelSerializer(serializers.Serializer):
code = serializers.CharField(source='privacy_level')
name = serializers.SerializerMethodField()

def get_name(self, obj):
return obj.privacy_level.title()


class VersionLinksSerializer(BaseLinksSerializer):
_self = serializers.SerializerMethodField()
builds = serializers.SerializerMethodField()
Expand Down Expand Up @@ -212,7 +204,6 @@ def get_documentation(self, obj):

class VersionSerializer(FlexFieldsModelSerializer):

privacy_level = PrivacyLevelSerializer(source='*')
ref = serializers.CharField()
downloads = serializers.SerializerMethodField()
urls = VersionURLsSerializer(source='*')
Expand All @@ -228,7 +219,6 @@ class Meta:
'ref',
'built',
'active',
'privacy_level',
'type',
'downloads',
'urls',
Expand Down Expand Up @@ -257,14 +247,13 @@ class VersionUpdateSerializer(serializers.ModelSerializer):
"""
Used when modifying (update action) a ``Version``.

It only allows to make the Version active/non-active and private/public.
It only allows to make the Version active/non-active.
"""

class Meta:
model = Version
fields = [
'active',
'privacy_level',
]


Expand Down Expand Up @@ -434,11 +423,6 @@ class ProjectUpdateSerializer(FlexFieldsModelSerializer):
repository = RepositorySerializer(source='*')
homepage = serializers.URLField(source='project_url')

# Exclude ``Protected`` as a possible value for Privacy Level
privacy_level_choices = list(PRIVACY_CHOICES)
privacy_level_choices.remove((PROTECTED, _('Protected')))
privacy_level = serializers.ChoiceField(choices=privacy_level_choices)

class Meta:
model = Project
fields = (
Expand All @@ -452,7 +436,6 @@ class Meta:
# Advanced Settings -> General Settings
'default_version',
'default_branch',
'privacy_level',
'analytics_code',
'show_version_warning',
'single_version',
Expand All @@ -468,7 +451,6 @@ class ProjectSerializer(FlexFieldsModelSerializer):
language = LanguageSerializer()
programming_language = ProgrammingLanguageSerializer()
repository = RepositorySerializer(source='*')
privacy_level = PrivacyLevelSerializer(source='*')
urls = ProjectURLsSerializer(source='*')
subproject_of = serializers.SerializerMethodField()
translation_of = serializers.SerializerMethodField()
Expand Down Expand Up @@ -497,7 +479,6 @@ class Meta:
'repository',
'default_version',
'default_branch',
'privacy_level',
'subproject_of',
'translation_of',
'users',
Expand Down
8 changes: 0 additions & 8 deletions readthedocs/api/v3/tests/responses/projects-detail.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,6 @@
"builds": "https://readthedocs.org/api/v3/projects/project/versions/v1.0/builds/",
"project": "https://readthedocs.org/api/v3/projects/project/"
},
"privacy_level": {
"code": "public",
"name": "Public"
},
"ref": null,
"slug": "v1.0",
"type": "tag",
Expand Down Expand Up @@ -68,10 +64,6 @@
},
"modified": "2019-04-29T12:00:00Z",
"name": "project",
"privacy_level": {
"code": "public",
"name": "Public"
},
"programming_language": {
"code": "words",
"name": "Only Words"
Expand Down
4 changes: 0 additions & 4 deletions readthedocs/api/v3/tests/responses/projects-list.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,6 @@
},
"default_version": "latest",
"default_branch": "master",
"privacy_level": {
"code": "public",
"name": "Public"
},
"subproject_of": null,
"translation_of": null,
"urls": {
Expand Down
4 changes: 0 additions & 4 deletions readthedocs/api/v3/tests/responses/projects-list_POST.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,6 @@
},
"modified": "2019-04-29T12:00:00Z",
"name": "Test Project",
"privacy_level": {
"code": "public",
"name": "Public"
},
"programming_language": {
"code": "py",
"name": "Python"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,6 @@
},
"modified": "2019-04-29T12:00:00Z",
"name": "subproject",
"privacy_level": {
"code": "public",
"name": "Public"
},
"programming_language": {
"code": "words",
"name": "Only Words"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,6 @@
},
"modified": "2019-04-29T12:00:00Z",
"name": "subproject",
"privacy_level": {
"code": "public",
"name": "Public"
},
"programming_language": {
"code": "words",
"name": "Only Words"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,6 @@
},
"modified": "2019-04-29T12:00:00Z",
"name": "new-project",
"privacy_level": {
"code": "public",
"name": "Public"
},
"programming_language": {
"code": "words",
"name": "Only Words"
Expand Down
4 changes: 0 additions & 4 deletions readthedocs/api/v3/tests/responses/projects-superproject.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,6 @@
},
"modified": "2019-04-29T12:00:00Z",
"name": "project",
"privacy_level": {
"code": "public",
"name": "Public"
},
"programming_language": {
"code": "words",
"name": "Only Words"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,6 @@
},
"modified": "2019-04-29T12:00:00Z",
"name": "project",
"privacy_level": {
"code": "public",
"name": "Public"
},
"programming_language": {
"code": "words",
"name": "Only Words"
Expand Down Expand Up @@ -85,10 +81,6 @@
"builds": "https://readthedocs.org/api/v3/projects/project/versions/v1.0/builds/",
"project": "https://readthedocs.org/api/v3/projects/project/"
},
"privacy_level": {
"code": "public",
"name": "Public"
},
"ref": null,
"slug": "v1.0",
"type": "tag",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@
"builds": "https://readthedocs.org/api/v3/projects/project/versions/v1.0/builds/",
"project": "https://readthedocs.org/api/v3/projects/project/"
},
"privacy_level": {
"code": "public",
"name": "Public"
},
"ref": null,
"slug": "v1.0",
"type": "tag",
Expand Down
2 changes: 1 addition & 1 deletion readthedocs/api/v3/tests/test_projects.py
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ def test_update_project(self):
self.assertEqual(self.project.project_url, 'https://updated-homepage.org')
self.assertEqual(self.project.default_version, 'stable')
self.assertEqual(self.project.default_branch, 'updated-default-branch')
self.assertEqual(self.project.privacy_level, 'private')
self.assertEqual(self.project.privacy_level, 'public')
self.assertEqual(self.project.analytics_code, 'UA-XXXXXX')
self.assertEqual(self.project.show_version_warning, False)
self.assertEqual(self.project.single_version, True)
Expand Down