Remove privacy_level field from APIv3

Read the Docs Community edition does not support privacy levels at all. We are removing it from here now. We can re-add them once we have RTD_ALLOW_PRIVACY_LEVELS=True in the Corporate site. (see #6194)
readthedocs · Oct 8, 2019 · a888bc8 · a888bc8
1 parent 995287f
commit a888bc8
Show file tree

Hide file tree

Showing 10 changed files with 2 additions and 66 deletions.
diff --git a/docs/api/v3.rst b/docs/api/v3.rst
@@ -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": {
@@ -335,7 +331,6 @@ Version update
 
         {
             "active": true,
-            "privacy_level": "public"
         }
 
     :statuscode 204: Updated successfully

diff --git a/readthedocs/api/v3/serializers.py b/readthedocs/api/v3/serializers.py
@@ -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()
@@ -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='*')
@@ -228,7 +219,6 @@ class Meta:
             'ref',
             'built',
             'active',
-            'privacy_level',
             'type',
             'downloads',
             'urls',
@@ -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',
         ]
 
 
@@ -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 = (
@@ -452,7 +436,6 @@ class Meta:
             # Advanced Settings -> General Settings
             'default_version',
             'default_branch',
-            'privacy_level',
             'analytics_code',
             'show_version_warning',
             'single_version',
@@ -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()
@@ -497,7 +479,6 @@ class Meta:
             'repository',
             'default_version',
             'default_branch',
-            'privacy_level',
             'subproject_of',
             'translation_of',
             'users',

diff --git a/readthedocs/api/v3/tests/responses/projects-detail.json b/readthedocs/api/v3/tests/responses/projects-detail.json
@@ -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",
@@ -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"

diff --git a/readthedocs/api/v3/tests/responses/projects-list.json b/readthedocs/api/v3/tests/responses/projects-list.json
@@ -24,10 +24,6 @@
             },
             "default_version": "latest",
             "default_branch": "master",
-            "privacy_level": {
-                "code": "public",
-                "name": "Public"
-            },
             "subproject_of": null,
             "translation_of": null,
             "urls": {

diff --git a/readthedocs/api/v3/tests/responses/projects-list_POST.json b/readthedocs/api/v3/tests/responses/projects-list_POST.json
@@ -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"

diff --git a/readthedocs/api/v3/tests/responses/projects-subprojects-list.json b/readthedocs/api/v3/tests/responses/projects-subprojects-list.json
@@ -24,10 +24,6 @@
             },
             "default_version": "latest",
             "default_branch": "master",
-            "privacy_level": {
-                "code": "public",
-                "name": "Public"
-            },
             "subproject_of": {
                 "id": 1,
                 "name": "project",
@@ -49,10 +45,6 @@
                 },
                 "default_version": "latest",
                 "default_branch": "master",
-                "privacy_level": {
-                    "code": "public",
-                    "name": "Public"
-                },
                 "subproject_of": null,
                 "translation_of": null,
                 "urls": {

diff --git a/readthedocs/api/v3/tests/responses/projects-superproject.json b/readthedocs/api/v3/tests/responses/projects-superproject.json
@@ -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"

diff --git a/readthedocs/api/v3/tests/responses/projects-versions-builds-list_POST.json b/readthedocs/api/v3/tests/responses/projects-versions-builds-list_POST.json
@@ -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"
@@ -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",

diff --git a/readthedocs/api/v3/tests/responses/projects-versions-detail.json b/readthedocs/api/v3/tests/responses/projects-versions-detail.json
@@ -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",

diff --git a/readthedocs/api/v3/tests/test_projects.py b/readthedocs/api/v3/tests/test_projects.py
@@ -222,7 +222,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)