Skip to content

Commit

Permalink
Added docstring to serializers.py
Browse files Browse the repository at this point in the history
  • Loading branch information
@Julio-Oliveira-Encora
Julio-Oliveira-Encora committed Feb 23, 2024
1 parent 252d966 commit 4a7f97e
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions diode-netbox-plugin/netbox_diode_plugin/api/serializers.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@


class ObjectStateSerializer(serializers.Serializer):

'''
Serializer for the Object State:
object_Type: Return a string with the format app.model.
object_change_id: Return the ID of last change.
object: return the object according to serializer defined in the Netbox.
'''

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.11)

Ruff (D211) 

netbox_diode_plugin/api/serializers.py:8:5: D211 No blank lines allowed before class docstring

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.11)

Ruff (D204) 

netbox_diode_plugin/api/serializers.py:8:5: D204 1 blank line required after class docstring

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.11)

Ruff (D205) 

netbox_diode_plugin/api/serializers.py:8:5: D205 1 blank line required between summary line and description

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.11)

Ruff (D300) 

netbox_diode_plugin/api/serializers.py:8:5: D300 Use triple double quotes `"""`

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.8)

Ruff (D211) 

netbox_diode_plugin/api/serializers.py:8:5: D211 No blank lines allowed before class docstring

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.8)

Ruff (D204) 

netbox_diode_plugin/api/serializers.py:8:5: D204 1 blank line required after class docstring

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.8)

Ruff (D205) 

netbox_diode_plugin/api/serializers.py:8:5: D205 1 blank line required between summary line and description

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.8)

Ruff (D300) 

netbox_diode_plugin/api/serializers.py:8:5: D300 Use triple double quotes `"""`

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.12)

Ruff (D211) 

netbox_diode_plugin/api/serializers.py:8:5: D211 No blank lines allowed before class docstring

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.12)

Ruff (D204) 

netbox_diode_plugin/api/serializers.py:8:5: D204 1 blank line required after class docstring

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.12)

Ruff (D205) 

netbox_diode_plugin/api/serializers.py:8:5: D205 1 blank line required between summary line and description

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.12)

Ruff (D300) 

netbox_diode_plugin/api/serializers.py:8:5: D300 Use triple double quotes `"""`

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.9)

Ruff (D211) 

netbox_diode_plugin/api/serializers.py:8:5: D211 No blank lines allowed before class docstring

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.9)

Ruff (D204) 

netbox_diode_plugin/api/serializers.py:8:5: D204 1 blank line required after class docstring

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.9)

Ruff (D205) 

netbox_diode_plugin/api/serializers.py:8:5: D205 1 blank line required between summary line and description

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.9)

Ruff (D300) 

netbox_diode_plugin/api/serializers.py:8:5: D300 Use triple double quotes `"""`

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.10)

Ruff (D211) 

netbox_diode_plugin/api/serializers.py:8:5: D211 No blank lines allowed before class docstring

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.10)

Ruff (D204) 

netbox_diode_plugin/api/serializers.py:8:5: D204 1 blank line required after class docstring

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.10)

Ruff (D205) 

netbox_diode_plugin/api/serializers.py:8:5: D205 1 blank line required between summary line and description

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.10)

Ruff (D300) 

netbox_diode_plugin/api/serializers.py:8:5: D300 Use triple double quotes `"""`

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.7)

Ruff (D211) 

netbox_diode_plugin/api/serializers.py:8:5: D211 No blank lines allowed before class docstring

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.7)

Ruff (D204) 

netbox_diode_plugin/api/serializers.py:8:5: D204 1 blank line required after class docstring

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.7)

Ruff (D205) 

netbox_diode_plugin/api/serializers.py:8:5: D205 1 blank line required between summary line and description

Check failure on line 13 in diode-netbox-plugin/netbox_diode_plugin/api/serializers.py

View workflow job for this annotation

GitHub Actions / tests (3.7)

Ruff (D300) 

netbox_diode_plugin/api/serializers.py:8:5: D300 Use triple double quotes `"""`


object_type = serializers.SerializerMethodField(read_only=True)
object_change_id = serializers.SerializerMethodField(read_only=True)
object = serializers.SerializerMethodField(read_only=True)
Expand Down

0 comments on commit 4a7f97e

Please sign in to comment.