Dazaev added a README to his API

UFC-API-README.md

@@ -0,0 +1,65 @@
+# UFC API DOCUMENTATION
+### By Dazaev
+
+Welcome to my UFC API! Here you will find the documentation you need to start retrieving, creating, updating and even deleting data! (But please... don't erase data)
+
+## About my UFC API:
+The API built on the principles of REST keeps track of current and past UFC fighters, you can access data like their fighting records, what country are they fighting from and if they're currently holding the title belt.
+
+# PUBLIC ENDPOINTS
+
+## This is the url where you can access all the data: https://guarded-mesa-21535.herokuapp.com/
+
+## GET "/"
+This will get you to the **homepage** where a welcome message will be displayed in the form of JSON data.
+```
+https://guarded-mesa-21535.herokuapp.com/
+```
+
+## GET "/fighters"
+The fighters endpoint allows you to browse **all** published posts existing on the database.
+```
+https://guarded-mesa-21535.herokuapp.com/fighters
+```
+## GET "/fighters/:id"
+This endpoint allows you to fetch a specific fighter based on its **id**.
+```
+https://guarded-mesa-21535.herokuapp.com/fighters/59dcdb5bd7aca80012cf1078
+```
+
+# PRIVATE ENDPOINTS
+(This is the endpoints only **Admins** should be authorized to use, but hey feel free to contribute!)
+
+## POST "/fighters"
+With this method and this endpoint users can create via **Postman** new fighter entrees using the following guidelines:
+
+```
+{
+firstName: String,
+lastName: String,
+titleHolder: Boolean,
+country: String,
+record: String,
+}
+```
+They key "record" must have a value written like in this example "10-5", 10 being the fights the fighter has won and 5 being the ones he has lost.
+
+## PUT "fighter/:id"
+Using **PUT** in this endpoint allows users to modify the data of a specific previously created fighter entree by fetching it by its id. This is useful to keep all of their record data up to date. The guidelines on how to update their info are the same as the POST method mentioned above.
+```
+https://guarded-mesa-21535.herokuapp.com/fighters/59dcdb5bd7aca80012cf1078
+```
+```
+{
+  titleHolder: true
+  record: "12-2"
+}
+```
+
+## DELETE "fighter/:id"
+**CAUTION!** I would suggest being careful with this method, avoid using it if you are not sure of how to use it. This endpoint looks for a fighter using its id and deletes it from the API.
+```
+https://guarded-mesa-21535.herokuapp.com/fighters/59dcdb5bd7aca80012cf1078
+```
+
+# This site is still in the works so hopefully when I get the chance I'll continue updating it since I'm a really big fan of MMA. Thanks for reading and have fun using it!

models/index.js

@@ -1,7 +1,9 @@
 const mongoose = require('mongoose');
 require('dotenv').config();
 // TODO: include all model files here (and export models together below)
-const testModels = require('./test');
+const fighterModels = require('./test');
+const leagueModels = require('./league');
+const teamModels = require('./team');
 
 // connect to Mongo DB
 mongoose.connection.openUri(process.env.MONGODB_URI || process.env.DB_CONN, {}, function(err, conn) {
@@ -14,5 +16,7 @@ mongoose.connection.openUri(process.env.MONGODB_URI || process.env.DB_CONN, {},
 
 module.exports = {
   // TODO: add references to all models here
-  Test: testModels.Test
+  Fighter: fighterModels.Fighter,
+  League: leagueModels.League,
+  Team: teamModels.Team,
 };

models/league.js

@@ -0,0 +1,25 @@
+const mongoose = require("mongoose");
+const Schema = mongoose.Schema;
+
+//LEAGUE SCHEMA
+const LeagueSchema = new Schema ({
+  name: String,
+  established: Number,
+  headquarters: String,
+  owner: String
+});
+
+// var ufcLeague = new db.League ({
+//   name: "Ultimate Fighting Championship",
+//   established: 1993,
+//   headquarters: "Las Vegas",
+//   owner: "Danna White"
+// })
+
+//LEAGUE MODEL
+const League = mongoose.model("League", LeagueSchema);
+
+//MODULE EXPORT
+module.exports = {
+  League: League
+}

models/team.js

@@ -0,0 +1,17 @@
+const mongoose = require("mongoose");
+const Schema = mongoose.Schema;
+
+//TEAM SCHEMA
+const TeamSchema = new Schema ({
+  established: Number,
+  foundedBy: String,
+  facilities: String
+});
+
+//TEAM MODULE
+const Team = mongoose.model('Team', TeamSchema);
+
+//EXPORT MODULE
+module.exports = {
+  Team: Team
+}

models/test.js

@@ -1,22 +1,26 @@
 const mongoose = require('mongoose');
+const Schema = mongoose.Schema;
 
-const TestSchema = new mongoose.Schema({
-  name: {
-    type: String,
-    required: true
+//FIGHTER SCHEMA
+const FighterSchema = new Schema ({
+  firstName: String,
+  lastName: String,
+  league: {
+    type: Schema.ObjectId,
+    ref: "League"
   },
-  count: {
-    type: Number,
-    default: 42
+  titleHolder: Boolean,
+  country: String,
+  team: {
+    type: Schema.ObjectId,
+    ref: "Team"
   },
-  time: {
-    type: Date,
-    default: Date.now
-  }
+  record: String
 });
 
-const Test = mongoose.model('Test', TestSchema);
+//FIGHTER MODEL
+const Fighter = mongoose.model('Fighter', FighterSchema);
 
 module.exports = {
-  Test: Test
+  Fighter: Fighter
 }