feat: updated existing APIs to enable to generate OpenAPI documentation

backend/editor/api.py

@@ -21,7 +21,21 @@
 from .exceptions import GithubBranchExistsError, GithubUploadError
 
 # Data model imports
-from .models import Footer, Header
+from .models import (
+    CreateNodeParameters,
+    EditChildrenParameters,
+    EditChildrenResponse,
+    EditEntryParameters,
+    EditEntryResponse,
+    EditFooterParameters,
+    EditFooterResponse,
+    EditHeaderParameters,
+    EditHeaderResponse,
+    EditSynonymParameters,
+    EditSynonymResponse,
+    ImportFromGithubParameters,
+    ImportFromGithubResponse,
+)
 
 # ----------------------------------------------------------------------------#
 
@@ -309,7 +323,13 @@ async def export_to_github(
 
 
 @app.post("/{taxonomy_name}/{branch}/import")
-async def import_from_github(request: Request, branch: str, taxonomy_name: str):
+async def import_from_github(
+    request: Request,
+    branch: str,
+    taxonomy_name: str,
+    parameters: ImportFromGithubParameters,
+    response_model=ImportFromGithubResponse,
+):
     """
     Get taxonomy from Product Opener GitHub repository
     """
@@ -329,11 +349,11 @@ async def import_from_github(request: Request, branch: str, taxonomy_name: str):
 
 
 @app.post("/{taxonomy_name}/{branch}/nodes")
-async def create_node(request: Request, branch: str, taxonomy_name: str):
+async def create_node(request: Request, parameters: CreateNodeParameters):
     """
     Creating a new node in a taxonomy
     """
-    taxonomy = TaxonomyGraph(branch, taxonomy_name)
+    taxonomy = TaxonomyGraph(parameters.branch, parameters.taxonomy_name)
     incoming_data = await request.json()
     id = incoming_data["id"]
     main_language = incoming_data["main_language"]
@@ -350,43 +370,51 @@ async def create_node(request: Request, branch: str, taxonomy_name: str):
 
 
 @app.post("/{taxonomy_name}/{branch}/entry/{entry}")
-async def edit_entry(request: Request, branch: str, taxonomy_name: str, entry: str):
+async def edit_entry(
+    request: Request, parameters: EditEntryParameters, response_model=EditEntryResponse
+):
     """
     Editing an entry in a taxonomy.
     New key-value pairs can be added, old key-value pairs can be updated.
     URL will be of format '/entry/<id>'
     """
-    taxonomy = TaxonomyGraph(branch, taxonomy_name)
+    taxonomy = TaxonomyGraph(parameters.branch, parameters.taxonomy_name)
     incoming_data = await request.json()
-    result = taxonomy.update_nodes("ENTRY", entry, incoming_data)
+    result = taxonomy.update_nodes("ENTRY", parameters.entry, incoming_data)
     updated_entry = list(result)
     return updated_entry
 
 
 @app.post("/{taxonomy_name}/{branch}/entry/{entry}/children")
-async def edit_entry_children(request: Request, branch: str, taxonomy_name: str, entry: str):
+async def edit_entry_children(
+    request: Request,
+    parameters: EditChildrenParameters,
+    response_model=EditChildrenResponse,
+):
     """
     Editing an entry's children in a taxonomy.
     New children can be added, old children can be removed.
     URL will be of format '/entry/<id>/children'
     """
-    taxonomy = TaxonomyGraph(branch, taxonomy_name)
+    taxonomy = TaxonomyGraph(parameters.branch, parameters.taxonomy_name)
     incoming_data = await request.json()
-    result = taxonomy.update_node_children(entry, incoming_data)
+    result = taxonomy.update_node_children(parameters.entry, incoming_data)
     updated_children = list(result)
     return updated_children
 
 
 @app.post("/{taxonomy_name}/{branch}/synonym/{synonym}")
-async def edit_synonyms(request: Request, branch: str, taxonomy_name: str, synonym: str):
+async def edit_synonyms(
+    request: Request, parameters: EditSynonymParameters, response_model=EditSynonymResponse
+):
     """
     Editing a synonym in a taxonomy.
     New key-value pairs can be added, old key-value pairs can be updated.
     URL will be of format '/synonym/<id>'
     """
-    taxonomy = TaxonomyGraph(branch, taxonomy_name)
+    taxonomy = TaxonomyGraph(parameters.branch, parameters.taxonomy_name)
     incoming_data = await request.json()
-    result = taxonomy.update_nodes("SYNONYMS", synonym, incoming_data)
+    result = taxonomy.update_nodes("SYNONYMS", parameters.synonym, incoming_data)
     updated_synonym = list(result)
     return updated_synonym
 
@@ -406,24 +434,25 @@ async def edit_stopwords(request: Request, branch: str, taxonomy_name: str, stop
 
 
 @app.post("/{taxonomy_name}/{branch}/header")
-async def edit_header(incoming_data: Header, branch: str, taxonomy_name: str):
+async def edit_header(parameters: EditHeaderParameters, response_model: EditHeaderResponse):
     """
     Editing the __header__ in a taxonomy.
     """
-    taxonomy = TaxonomyGraph(branch, taxonomy_name)
-    convertedData = incoming_data.dict()
+    taxonomy = TaxonomyGraph(parameters.branch, parameters.taxonomy_name)
+    convertedData = parameters.incoming_data.dict()
+
     result = taxonomy.update_nodes("TEXT", "__header__", convertedData)
     updated_header = list(result)
     return updated_header
 
 
 @app.post("/{taxonomy_name}/{branch}/footer")
-async def edit_footer(incoming_data: Footer, branch: str, taxonomy_name: str):
+async def edit_footer(parameters: EditFooterParameters, response_model: EditFooterResponse):
     """
     Editing the __footer__ in a taxonomy.
     """
-    taxonomy = TaxonomyGraph(branch, taxonomy_name)
-    convertedData = incoming_data.dict()
+    taxonomy = TaxonomyGraph(parameters.branch, parameters.taxonomy_name)
+    convertedData = parameters.incoming_data.dict()
     result = taxonomy.update_nodes("TEXT", "__footer__", convertedData)
     updated_footer = list(result)
     return updated_footer

backend/editor/models.py

@@ -16,3 +16,78 @@ class Header(Marginal):
 
 class Footer(Marginal):
     pass
+
+
+# Models for FastAPI
+
+
+class CommonParameters:
+    branch = "branch"
+    taxonomy_name = "taxonomy_name"
+
+
+parameters = CommonParameters()
+
+
+class ImportFromGithubParameters(BaseModel):
+    parameters.parameters.branch: str
+    parameters.parameters.taxonomy_name: str
+
+
+class ImportFromGithubResponse(BaseModel):
+    status: str
+
+
+class CreateNodeParameters(BaseModel):
+    parameters.parameters.branch: str
+    parameters.parameters.taxonomy_name: str
+
+
+class EditEntryParameters(BaseModel):
+    parameters.branch: str
+    parameters.taxonomy_name: str
+    entry: str
+
+
+class EditEntryResponse(BaseModel):
+    result = []
+
+
+class EditChildrenParameters(BaseModel):
+    parameters.branch: str
+    parameters.taxonomy_name: str
+    entry: str
+
+
+class EditChildrenResponse(BaseModel):
+    result = []
+
+
+class EditSynonymParameters(BaseModel):
+    parameters.branch: str
+    parameters.taxonomy_name: str
+    entry: str
+
+
+class EditSynonymResponse(BaseModel):
+    result = []
+
+
+class EditHeaderParameters(BaseModel):
+    incoming_data: Header
+    parameters.branch: str
+    parameters.taxonomy_name: str
+
+
+class EditHeaderResponse(BaseModel):
+    result: []
+
+
+class EditFooterParameters(BaseModel):
+    incoming_data: Footer
+    parameters.branch: str
+    parameters.taxonomy_name: str
+
+
+class EditFooterResponse(BaseModel):
+    result: []