housing API Documentation Modules Classes Names
Clear Help

Search bar offers the following options:

  • Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: +foo bar -baz
  • Wildcards. The below example searches for documents with words beginning with “foo”: foo*
  • Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: +qname:twisted.mail.* +search

    Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

  • Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: foo~1

Results provided by Lunr.js

Class Hierarchy

  • django.apps.AppConfig
    • housing.apps.HousingConfig - This is configuration for Housing Module.
  • django.db.migrations.Migration
    • housing.migrations.0001_initial.Migration - Intital Database Schema
    • housing.migrations.0002_alter_owner_contact_email_alter_user_contact_email.Migration - Modifying email field
    • housing.migrations.0002_alter_owner_contact_email_alter_user_contact_email_and_more.Migration - Altering field names in Owner and User Database
    • housing.migrations.0003_alter_interested_flat_id.Migration - Adding foreign keys in Interested Database
    • housing.migrations.0004_merge_20221009_1347.Migration - Updated housing Database
  • django.db.models.Model
    • housing.models.Apartment - This is Apartment database structure.
    • housing.models.Flat - This is Flat database structure.
    • housing.models.Interested - This is Interested database structure.
    • housing.models.Lease - This is Lease database structure.
    • housing.models.Owner - This is a Owner database structure.
    • housing.models.User - This is User database structure.
  • django.test.TestCase
    • housing.tests.ApartmentTests - This is Apartment test class.
    • housing.tests.FlatTests - This is Flat test class.
    • housing.tests.InterestedTests - This is Interested test class.
    • housing.tests.LeaseTests - This is Lease test class.
    • housing.tests.UserTests - This is User test class.
  • housing.serializers.ApartmentSerializer.Meta - This class contains fields to be serialized.
  • housing.serializers.FlatSerializer.Meta - This class contains fields to be serialized.
  • housing.serializers.InterestedSerializer.Meta - This class contains fields to be serialized.
  • housing.serializers.LeaseSerializer.Meta - This class contains fields to be serialized.
  • housing.serializers.OwnerSerializer.Meta - This class contains fields to be serialized.
  • housing.serializers.UserSerializer.Meta - This class contains fields to be serialized.
  • rest_framework.generics.ListCreateAPIView
    • housing.views.ApartmentViewSet - This viewset automatically provides CRUD actions for Apartment model.
    • housing.views.FlatViewSet - This viewset automatically provides CRUD actions for Flat model.
    • housing.views.InterestedViewSet - This viewset automatically provides CRUD actions for Interested model.
    • housing.views.LeaseViewSet - This viewset automatically provides CRUD actions for Lease model.
    • housing.views.OwnerViewSet - This viewset automatically provides CRUD actions for Owner model.
    • housing.views.UserViewSet - This viewset automatically provides CRUD actions for User model.
  • rest_framework.generics.RetrieveUpdateDestroyAPIView
    • housing.views.ApartmentViewSet - This viewset automatically provides CRUD actions for Apartment model.
    • housing.views.FlatViewSet - This viewset automatically provides CRUD actions for Flat model.
    • housing.views.InterestedViewSet - This viewset automatically provides CRUD actions for Interested model.
    • housing.views.LeaseViewSet - This viewset automatically provides CRUD actions for Lease model.
    • housing.views.OwnerViewSet - This viewset automatically provides CRUD actions for Owner model.
    • housing.views.UserViewSet - This viewset automatically provides CRUD actions for User model.
  • rest_framework.serializers.ModelSerializer
    • housing.serializers.ApartmentSerializer - This is ApartmentSerializer for Apartment model.
    • housing.serializers.FlatSerializer - This is FlatSerializer for Flat model.
    • housing.serializers.InterestedSerializer - This is InterestedSerializer for Interested model.
    • housing.serializers.LeaseSerializer - This is LeaseSerializer for Lease model.
    • housing.serializers.OwnerSerializer - This is OwnerSerializer for Owner model.
    • housing.serializers.UserSerializer - This is UserSerializer for User model.
  • rest_framework.test.APITestCase
    • housing.tests.ApartmentTests - This is Apartment test class.
    • housing.tests.FlatTests - This is Flat test class.
    • housing.tests.InterestedTests - This is Interested test class.
    • housing.tests.LeaseTests - This is Lease test class.
    • housing.tests.OwnerTests - This is Owner test class.
    • housing.tests.UserTests - This is User test class.
API Documentation for housing, generated by pydoctor 22.9.1 at 2022-10-09 23:38:08.