Skip to content

Commit ea3cade

Browse files
committed
Rename fields: project_homepage and homepage
1 parent 39fde97 commit ea3cade

6 files changed

+17
-17
lines changed

readthedocs/api/v3/serializers.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -306,11 +306,11 @@ class ProjectURLsSerializer(BaseLinksSerializer, serializers.Serializer):
306306
"""Serializer with all the user-facing URLs under Read the Docs."""
307307

308308
documentation = serializers.CharField(source='get_docs_url')
309-
homepage = serializers.SerializerMethodField()
309+
home = serializers.SerializerMethodField()
310310
builds = serializers.SerializerMethodField()
311311
versions = serializers.SerializerMethodField()
312312

313-
def get_homepage(self, obj):
313+
def get_home(self, obj):
314314
path = reverse('projects_detail', kwargs={'project_slug': obj.slug})
315315
return self._absolute_url(path)
316316

@@ -401,7 +401,7 @@ def get_translations(self, obj):
401401

402402
class ProjectSerializer(FlexFieldsModelSerializer):
403403

404-
project_homepage = serializers.SerializerMethodField()
404+
homepage = serializers.SerializerMethodField()
405405
language = LanguageSerializer()
406406
programming_language = ProgrammingLanguageSerializer()
407407
repository = RepositorySerializer(source='*')
@@ -442,7 +442,7 @@ class Meta:
442442
'modified',
443443
'language',
444444
'programming_language',
445-
'project_homepage',
445+
'homepage',
446446
'repository',
447447
'default_version',
448448
'default_branch',
@@ -461,7 +461,7 @@ class Meta:
461461
'_links',
462462
]
463463

464-
def get_project_homepage(self, obj):
464+
def get_homepage(self, obj):
465465
# Overridden only to return ``None`` when the project_url is ``''``
466466
return obj.project_url or None
467467

readthedocs/api/v3/tests/responses/projects-detail.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
"code": "words",
7676
"name": "Only Words"
7777
},
78-
"project_homepage": "http://project.com",
78+
"homepage": "http://project.com",
7979
"repository": {
8080
"type": "git",
8181
"url": "https://github.com/rtfd/project"
@@ -91,7 +91,7 @@
9191
"urls": {
9292
"builds": "https://readthedocs.org/projects/project/builds/",
9393
"documentation": "http://readthedocs.org/docs/project/en/latest/",
94-
"homepage": "https://readthedocs.org/projects/project/",
94+
"home": "https://readthedocs.org/projects/project/",
9595
"versions": "https://readthedocs.org/projects/project/versions/"
9696
},
9797
"users": [

readthedocs/api/v3/tests/responses/projects-list.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"code": "words",
1818
"name": "Only Words"
1919
},
20-
"project_homepage": "http://project.com",
20+
"homepage": "http://project.com",
2121
"repository": {
2222
"url": "https://github.com/rtfd/project",
2323
"type": "git"
@@ -33,7 +33,7 @@
3333
"urls": {
3434
"builds": "https://readthedocs.org/projects/project/builds/",
3535
"documentation": "http://readthedocs.org/docs/project/en/latest/",
36-
"homepage": "https://readthedocs.org/projects/project/",
36+
"home": "https://readthedocs.org/projects/project/",
3737
"versions": "https://readthedocs.org/projects/project/versions/"
3838
},
3939
"tags": [

readthedocs/api/v3/tests/responses/projects-subprojects-list.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"code": "words",
1818
"name": "Only Words"
1919
},
20-
"project_homepage": "http://subproject.com",
20+
"homepage": "http://subproject.com",
2121
"repository": {
2222
"url": "https://github.com/rtfd/subproject",
2323
"type": "git"
@@ -42,7 +42,7 @@
4242
"code": "words",
4343
"name": "Only Words"
4444
},
45-
"project_homepage": "http://project.com",
45+
"homepage": "http://project.com",
4646
"repository": {
4747
"url": "https://github.com/rtfd/project",
4848
"type": "git"
@@ -58,7 +58,7 @@
5858
"urls": {
5959
"builds": "https://readthedocs.org/projects/project/builds/",
6060
"documentation": "http://readthedocs.org/docs/project/en/latest/",
61-
"homepage": "https://readthedocs.org/projects/project/",
61+
"home": "https://readthedocs.org/projects/project/",
6262
"versions": "https://readthedocs.org/projects/project/versions/"
6363
},
6464
"tags": [
@@ -86,7 +86,7 @@
8686
"urls": {
8787
"builds": "https://readthedocs.org/projects/subproject/builds/",
8888
"documentation": "http://readthedocs.org/docs/project/projects/subproject/en/latest/",
89-
"homepage": "https://readthedocs.org/projects/subproject/",
89+
"home": "https://readthedocs.org/projects/subproject/",
9090
"versions": "https://readthedocs.org/projects/subproject/versions/"
9191
},
9292
"tags": [],

readthedocs/api/v3/tests/responses/projects-superproject.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
"code": "words",
2727
"name": "Only Words"
2828
},
29-
"project_homepage": "http://project.com",
29+
"homepage": "http://project.com",
3030
"repository": {
3131
"type": "git",
3232
"url": "https://github.com/rtfd/project"
@@ -42,7 +42,7 @@
4242
"urls": {
4343
"builds": "https://readthedocs.org/projects/project/builds/",
4444
"documentation": "http://readthedocs.org/docs/project/en/latest/",
45-
"homepage": "https://readthedocs.org/projects/project/",
45+
"home": "https://readthedocs.org/projects/project/",
4646
"versions": "https://readthedocs.org/projects/project/versions/"
4747
},
4848
"users": [

readthedocs/api/v3/tests/responses/projects-versions-builds-list_POST.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
"code": "words",
4848
"name": "Only Words"
4949
},
50-
"project_homepage": "http://project.com",
50+
"homepage": "http://project.com",
5151
"repository": {
5252
"type": "git",
5353
"url": "https://github.com/rtfd/project"
@@ -63,7 +63,7 @@
6363
"urls": {
6464
"builds": "https://readthedocs.org/projects/project/builds/",
6565
"documentation": "http://readthedocs.org/docs/project/en/latest/",
66-
"homepage": "https://readthedocs.org/projects/project/",
66+
"home": "https://readthedocs.org/projects/project/",
6767
"versions": "https://readthedocs.org/projects/project/versions/"
6868
},
6969
"users": [

0 commit comments

Comments
 (0)