api_config.yml

# THIS FILE IS USED TO GENERATE OTHER VERY IMPORTANT FILES
# BOTH IN THE FRONTEND AND IN THE BACKEND !
# TAKE CARE WHEN MODYFING IT ;)

# model : the model name (may be null)
# viewset : the viewset name for the api
# api_end_pont : the main part of the url for making request to the api
#  This string will also be used for naming variables in JS !!
#  So no weird characters there please...
# versionned: boolean to specify wether this model is versionned or not
# api_attr : to specify some attributes that may be captured
#  and used in the viewset
# requires_testing: boolean to tell if this viewset is only availble in
#  a testing environment.

# Moderation levels are defined as follow :
#     0 : moderation will never be applied
#     1 : moderation will be on if the global settings for moderation is turned on
#     2 : (default for security reasons) moderation will always be on no matter what
# It is to be noted that staff members, dri members and moderators won't be subject to moderation !
#
# When moderation_level > 0, someone may decide to enforce moderation on for the users with a lower 
#   status in the app. This is called object level moderation ! 
#   staff ⊂ dri ⊂ moderators ⊂ authenficated_user 

# For viewset permissions we have the followings
# 
# By default, every viewset will have :
#     - isAuthentificated : to use the API the client needs to be authentificated
#     - noDeleteIsNotStaff : nothing can be deleted except if you are a staff member
#
# Some viewsets may have more presice permissions
#     - IsStaff
#     - IsStaffOrReadOnly
#     - IsDriOrReadOnly   
#     - IsOwner : (or )
# 

- model: Country
  viewset: CountryViewSet
  import_location: country
  api_end_point: countries
  viewset_permission: IsStaffOrReadOnly

- model: City
  viewset: CityViewSet
  import_location: city
  api_end_point: cities
  moderation_level: 2

- model: University
  viewset: UniversityViewSet
  import_location: university
  api_end_point: universities
  moderation_level: 2

- model: Campus
  viewset: CampusViewSet
  import_location: campus
  api_end_point: campuses
  versionned: true
  moderation_level: 2


- model: UserData
  viewset: UserDataViewSet
  import_location: user
  api_end_point: userData
  api_name: user-data-detail
  moderation_level: 0
  viewset_permission: IsOwner


- model: Tag
  viewset: TagViewSet
  import_location: tag
  api_end_point: tags
  moderation_level: 2
  viewset_permission: IsStaffOrReadOnly

- model: Currency
  viewset: CurrencyViewSet
  import_location: currency
  api_end_point: currencies
  moderation_level: 2
  viewset_permission: IsStaffOrReadOnly

- model: Department
  viewset: DepartmentViewSet
  import_location: other_core
  api_end_point: departments
  moderation_level: 2
  viewset_permission: IsStaffOrReadOnly

- model: Specialty
  viewset: SpecialtyViewSet
  import_location: other_core
  api_end_point: specialties
  moderation_level: 2
  viewset_permission: IsStaffOrReadOnly

- model: Semester
  viewset: SemesterViewSet
  import_location: other_core
  api_end_point: semesters
  moderation_level: 2
  viewset_permission: IsStaffOrReadOnly

- model: Offer
  viewset: OfferViewSet
  import_location: other_core
  api_end_point: offers
  moderation_level: 2
  viewset_permission: IsStaffOrReadOnly


- model: CountryTaggedItem
  viewset: CountryTaggedItemViewSet
  import_location: country
  api_end_point: countriesTaggedItems
  versionned: true

- model: CountryScholarship
  viewset: CountryScholarshipViewSet
  import_location: country
  api_end_point: countriesScholarships
  versionned: true

- model: CountryDri
  viewset: CountryDriViewSet
  import_location: country
  api_end_point: countriesDri
  viewset_permission: IsDriOrReadOnly
  versionned: true



- model: CityTaggedItem
  viewset: CityTaggedItemViewSet
  import_location: city
  api_end_point: citiesTaggedItems
  versionned: true



- model: UniversityTaggedItem
  viewset: UniversityTaggedItemViewSet
  import_location: university
  api_end_point: universitiesTaggedItems
  versionned: true

- model: UniversityScholarship
  viewset: UniversityScholarshipViewSet
  import_location: university
  api_end_point: universitiesScholarships
  versionned: true

- model: UniversityInfo
  viewset: UniversityInfoViewSet
  import_location: university
  api_end_point: universitiesInfo
  versionned: true

- model: UniversitySemestersDates
  viewset: UniversitySemestersDatesViewSet
  import_location: university
  api_end_point: universitiesSemestersDates
  versionned: true

- model: UniversityDri
  viewset: UniversityDriViewSet
  import_location: university
  api_end_point: universitiesDri
  viewset_permission: IsDriOrReadOnly
  versionned: true

- model: null
  viewset: UniversityModulesViewSet
  import_location: university
  api_end_point: universityAll
  api_attr: (?P<univ_id>[0-9]+)
  api_name: university_details
  read_only: true

- model: null
  viewset: CountryModulesViewSet
  import_location: country
  api_end_point: countryAll
  api_attr: (?P<country_id>[a-zA-Z]+)
  api_name: country_details
  read_only: true

- model: null
  viewset: CityModulesViewSet
  import_location: city
  api_end_point: cityAll
  api_attr: (?P<city_id>[0-9]+)
  api_name: city_details
  read_only: true

- model: null
  viewset: CampusModulesViewSet
  import_location: campus
  api_end_point: campusAll
  api_attr: (?P<campus_id>[0-9]+)
  api_name: campus_details
  read_only: true


- model: CampusTaggedItem
  viewset: CampusTaggedItemViewSet
  import_location: campus
  api_end_point: campusesTaggedItems
  versionned: true

- model: null
  viewset: MainCampusViewSet
  import_location: campus
  api_end_point: mainCampuses
  read_only: true



- model: Recommendation
  viewset: RecommendationViewSet
  import_location: user
  api_end_point: userRecommendations
  moderation_level: 0

- model: RecommendationList
  viewset: RecommendationListViewSet
  import_location: user
  api_end_point: userRecommendationLists
  moderation_level: 0

- model: PreviousDeparture
  viewset: PreviousDepartureViewSet
  import_location: user
  api_end_point: universitiesPreviousDepartures
  moderation_level: 2

- model: PreviousDepartureFeedback
  viewset: PreviousDepartureFeedbackViewSet
  import_location: user
  api_end_point: universitiesPreviousDepartureFeedback



- model: PendingModeration
  viewset: PendingModerationViewSet
  import_location: abstract.my_model
  api_end_point: pendingModeration
  viewset_permission: IsStaff


- model: Version
  viewset: VersionViewSet
  import_location: abstract.my_model
  api_end_point: versions
  api_attr: (?P<content_type_id>[0-9]+)/(?P<object_pk>[0-9A-Za-z]+)
  api_name: versionsList
  ignore_in_admin: true

- model: ForTestingModeration
  viewset: ForTestingModerationViewSet
  import_location: abstract.my_model
  api_end_point: test/moderation
  moderation_level: 1
  requires_testing: true

- model: ForTestingVersioning
  viewset: ForTestingVersioningViewSet
  import_location: abstract.my_model
  api_end_point: test/versioning
  moderation_level: 1
  requires_testing: true
  # versionned: true don't put it here, it is manually handled with @register decorator