Skip to content

Commit 099e038

Browse files
committed
Rename fields: project_homepage and homepage
1 parent 574df91 commit 099e038

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
@@ -305,11 +305,11 @@ class ProjectURLsSerializer(BaseLinksSerializer, serializers.Serializer):
305305
"""Serializer with all the user-facing URLs under Read the Docs."""
306306

307307
documentation = serializers.CharField(source='get_docs_url')
308-
homepage = serializers.SerializerMethodField()
308+
home = serializers.SerializerMethodField()
309309
builds = serializers.SerializerMethodField()
310310
versions = serializers.SerializerMethodField()
311311

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

@@ -390,7 +390,7 @@ def get_translations(self, obj):
390390

391391
class ProjectSerializer(FlexFieldsModelSerializer):
392392

393-
project_homepage = serializers.SerializerMethodField()
393+
homepage = serializers.SerializerMethodField()
394394
language = LanguageSerializer()
395395
programming_language = ProgrammingLanguageSerializer()
396396
repository = RepositorySerializer(source='*')
@@ -431,7 +431,7 @@ class Meta:
431431
'modified',
432432
'language',
433433
'programming_language',
434-
'project_homepage',
434+
'homepage',
435435
'repository',
436436
'default_version',
437437
'default_branch',
@@ -450,7 +450,7 @@ class Meta:
450450
'_links',
451451
]
452452

453-
def get_project_homepage(self, obj):
453+
def get_homepage(self, obj):
454454
# Overridden only to return ``None`` when the project_url is ``''``
455455
return obj.project_url or None
456456

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
"code": "words",
7575
"name": "Only Words"
7676
},
77-
"project_homepage": "http://project.com",
77+
"homepage": "http://project.com",
7878
"repository": {
7979
"type": "git",
8080
"url": "https://github.com/rtfd/project"
@@ -90,7 +90,7 @@
9090
"urls": {
9191
"builds": "https://readthedocs.org/projects/project/builds/",
9292
"documentation": "http://readthedocs.org/docs/project/en/latest/",
93-
"homepage": "https://readthedocs.org/projects/project/",
93+
"home": "https://readthedocs.org/projects/project/",
9494
"versions": "https://readthedocs.org/projects/project/versions/"
9595
},
9696
"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": [
@@ -85,7 +85,7 @@
8585
"urls": {
8686
"builds": "https://readthedocs.org/projects/subproject/builds/",
8787
"documentation": "http://readthedocs.org/docs/project/projects/subproject/en/latest/",
88-
"homepage": "https://readthedocs.org/projects/subproject/",
88+
"home": "https://readthedocs.org/projects/subproject/",
8989
"versions": "https://readthedocs.org/projects/subproject/versions/"
9090
},
9191
"tags": [],

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"code": "words",
2626
"name": "Only Words"
2727
},
28-
"project_homepage": "http://project.com",
28+
"homepage": "http://project.com",
2929
"repository": {
3030
"type": "git",
3131
"url": "https://github.com/rtfd/project"
@@ -41,7 +41,7 @@
4141
"urls": {
4242
"builds": "https://readthedocs.org/projects/project/builds/",
4343
"documentation": "http://readthedocs.org/docs/project/en/latest/",
44-
"homepage": "https://readthedocs.org/projects/project/",
44+
"home": "https://readthedocs.org/projects/project/",
4545
"versions": "https://readthedocs.org/projects/project/versions/"
4646
},
4747
"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
@@ -46,7 +46,7 @@
4646
"code": "words",
4747
"name": "Only Words"
4848
},
49-
"project_homepage": "http://project.com",
49+
"homepage": "http://project.com",
5050
"repository": {
5151
"type": "git",
5252
"url": "https://github.com/rtfd/project"
@@ -62,7 +62,7 @@
6262
"urls": {
6363
"builds": "https://readthedocs.org/projects/project/builds/",
6464
"documentation": "http://readthedocs.org/docs/project/en/latest/",
65-
"homepage": "https://readthedocs.org/projects/project/",
65+
"home": "https://readthedocs.org/projects/project/",
6666
"versions": "https://readthedocs.org/projects/project/versions/"
6767
},
6868
"users": [

0 commit comments

Comments
 (0)