archive/bramw_baserow
1
0
Fork 0
mirror of https://gitlab.com/bramw/baserow.git synced 2025-04-11 16:01:20 +00:00
Code Issues Projects Releases Wiki Activity

Don't indicate user_field_names is an option for the grid endpoints

Browse source
This commit is contained in:
Nigel Gott 2021-07-12 10:31:08 +01:00
parent 0d5d63b3ed
commit 07a1992ac0
3 changed files with 26 additions and 12 deletions
backend/src/baserow/contrib/database/api
rows
serializers.pyviews.py
views/grid
views.py

20
backend/src/baserow/contrib/database/api/rows/serializers.py
View file

@ -99,7 +99,7 @@ def get_row_serializer_class(
return get_serializer_class(model, field_names, field_overrides, base_class)
def get_example_row_serializer_class(add_id=False):
def get_example_row_serializer_class(add_id=False, user_field_names=False):
"""
Generates a serializer containing a field for each field type. It is only used for
example purposes in the openapi documentation.
@ -107,6 +107,9 @@ def get_example_row_serializer_class(add_id=False):
:param add_id: Indicates whether the id field should be added. This could for
example differ for request or response documentation.
:type add_id: bool
:param user_field_names: Whether this example serializer help text should indicate
the fields names can be switched using the `user_field_names` GET parameter.
:type user_field_names: bool
:return: Generated serializer containing a field for each field type.
:rtype: Serializer
"""
@ -118,6 +121,9 @@ def get_example_row_serializer_class(add_id=False):
"ExampleRowResponseSerializer" if add_id else "ExampleRowRequestSerializer"
)
if user_field_names:
class_name += "WithUserFieldNames"
if class_name in get_example_row_serializer_class.cache:
return get_example_row_serializer_class.cache[class_name]
@ -143,6 +149,13 @@ def get_example_row_serializer_class(add_id=False):
"imported before the fields have been registered."
)
optional_user_field_names_info = ""
if user_field_names:
optional_user_field_names_info = (
" If the GET parameter `user_field_names` is provided then the key will "
"instead be the actual name of the field."
)
for i, field_type in enumerate(field_types):
# In order to generate a serializer we need a model instance. This method is
# called before Django has been loaded so it will result in errors when
@ -154,8 +167,7 @@ def get_example_row_serializer_class(add_id=False):
kwargs = {
"help_text": f"This field represents the `{field_type.type}` field. The "
f"number in field_{i + 1} is in a normal request or response "
f"the id of the field. If the GET parameter `user_field_names` is "
f"provided then the key will instead be the actual name of the field."
f"the id of the field.{optional_user_field_names_info}"
f"{field_type.get_serializer_help_text(instance)}"
}
get_field_method = (
@ -171,5 +183,5 @@ def get_example_row_serializer_class(add_id=False):
example_pagination_row_serializer_class = get_example_pagination_serializer_class(
get_example_row_serializer_class(True)
get_example_row_serializer_class(True, user_field_names=True)
)

12
backend/src/baserow/contrib/database/api/rows/views.py
View file

@ -323,9 +323,9 @@ class RowsView(APIView):
"purposes, the field_ID must be replaced with the actual id of the field "
"or the name of the field if `user_field_names` is provided."
),
request=get_example_row_serializer_class(False),
request=get_example_row_serializer_class(False, user_field_names=True),
responses={
200: get_example_row_serializer_class(True),
200: get_example_row_serializer_class(True, user_field_names=True),
400: get_error_schema(
["ERROR_USER_NOT_IN_GROUP", "ERROR_REQUEST_BODY_VALIDATION"]
),
@ -432,7 +432,7 @@ class RowView(APIView):
"depends on the fields type."
),
responses={
200: get_example_row_serializer_class(True),
200: get_example_row_serializer_class(True, user_field_names=True),
400: get_error_schema(
["ERROR_USER_NOT_IN_GROUP", "ERROR_REQUEST_BODY_VALIDATION"]
),
@ -511,9 +511,9 @@ class RowView(APIView):
"the field_ID must be replaced with the actual id of the field or the name "
"of the field if `user_field_names` is provided."
),
request=get_example_row_serializer_class(False),
request=get_example_row_serializer_class(False, user_field_names=True),
responses={
200: get_example_row_serializer_class(True),
200: get_example_row_serializer_class(True, user_field_names=True),
400: get_error_schema(
["ERROR_USER_NOT_IN_GROUP", "ERROR_REQUEST_BODY_VALIDATION"]
),
@ -674,7 +674,7 @@ class RowMoveView(APIView):
"parameter is not provided, then the row will be moved to the end.",
request=None,
responses={
200: get_example_row_serializer_class(True),
200: get_example_row_serializer_class(True, user_field_names=True),
400: get_error_schema(["ERROR_USER_NOT_IN_GROUP"]),
401: get_error_schema(["ERROR_NO_PERMISSION_TO_TABLE"]),
404: get_error_schema(

6
backend/src/baserow/contrib/database/api/views/grid/views.py
View file

@ -122,7 +122,7 @@ class GridViewView(APIView):
),
responses={
200: get_example_pagination_serializer_class(
get_example_row_serializer_class(True),
get_example_row_serializer_class(add_id=True, user_field_names=False),
additional_fields={
"field_options": FieldOptionsField(
serializer_class=GridViewFieldOptionsSerializer, required=False
@ -213,7 +213,9 @@ class GridViewView(APIView):
),
request=GridViewFilterSerializer,
responses={
200: get_example_row_serializer_class(True)(many=True),
200: get_example_row_serializer_class(add_id=True, user_field_names=False)(
many=True
),
400: get_error_schema(
["ERROR_USER_NOT_IN_GROUP", "ERROR_REQUEST_BODY_VALIDATION"]
),