openapi.json

{
  "openapi": "3.0.0",
  "info": {
    "title": "Emission Tracker API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "http://localhost:3000/api"
    },
    {
      "url": "https://emission-tracker-api-test.azurewebsites.net/api"
    },
    {
      "url": "https://emission-tracker-api.azurewebsites.net/api"
    }
  ],
  "security": [{ "AzureADBearerStrategy": [] }, { "NaiveAuth": [] }],
  "paths": {
    "/transport-activity": {
      "get": {
        "operationId": "listTransportActivities",
        "parameters": [
          {
            "in": "query",
            "name": "title",
            "schema": {
              "type": "string",
              "enum": ["true"]
            }
          },
          {
            "in": "query",
            "name": "totalEmissions",
            "schema": {
              "type": "string",
              "enum": ["true"]
            }
          },
          {
            "in": "query",
            "name": "date",
            "schema": {
              "type": "string",
              "enum": ["true"]
            }
          },
          {
            "in": "query",
            "name": "transportMode",
            "schema": {
              "type": "string",
              "enum": ["true"]
            }
          },
          {
            "in": "query",
            "name": "dateAfter",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "in": "query",
            "name": "sortBy",
            "schema": {
              "type": "string",
              "nullable": true,
              "enum": ["date"]
            }
          },
          {
            "in": "query",
            "name": "sortDirection",
            "schema": {
              "type": "string",
              "nullable": true,
              "enum": ["ASC", "DESC"]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string"
                      },
                      "title": {
                        "type": "string",
                        "nullable": true
                      },
                      "totalEmissions": {
                        "type": "number",
                        "nullable": true
                      },
                      "date": {
                        "type": "string",
                        "nullable": true,
                        "format": "date-time"
                      },
                      "transportMode": { "$ref": "#/components/schemas/transportMode" }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "operationId": "createTransportActivity",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": { "$ref": "#/components/schemas/transportActivityReqBody" }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created transport activity",
            "headers": {
              "location": {
                "schema": { "type": "string" },
                "description": "The URL to get transport activity details."
              }
            },
            "content": {
              "application/json": {
                "schema": { "type": "object", "properties": { "message": { "type": "string" } } }
              }
            }
          },
          "401": {
            "description": "Not authenticated",
            "content": {
              "application/json": {
                "schema": { "type": "object", "properties": { "error": { "type": "string" } } }
              }
            }
          },
          "403": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": { "errors": { "type": "array", "items": { "type": "object" } } }
                }
              }
            }
          }
        }
      }
    },
    "/transport-activity/{id}": {
      "get": {
        "operationId": "getTransportActivityDetails",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/transportActivity" }
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "deleteTransportActivity",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "204": {
            "description": "Deleted successfully."
          }
        }
      },
      "put": {
        "operationId": "updateTransportActivity",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": { "$ref": "#/components/schemas/transportActivityReqBody" }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Update successful.",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/transportActivity" }
              }
            }
          }
        }
      }
    },
    "/transport-activity/import": {
      "post": {
        "operationId": "importTransportActivitites",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": ["data"],
                "properties": {
                  "data": {
                    "type": "array",
                    "items": {
                      "allOf": [{ "$ref": "#/components/schemas/transportActivity" }],
                      "properties": {
                        "date": {
                          "type": "object",
                          "required": ["$date"],
                          "properties": {
                            "$date": {
                              "type": "string",
                              "format": "date-time"
                            }
                          },
                          "additionalProperties": false
                        },
                        "createdAt": {
                          "type": "object",
                          "required": ["$date"],
                          "properties": {
                            "$date": {
                              "type": "string"
                            }
                          },
                          "additionalProperties": false
                        },
                        "updatedAt": {
                          "type": "object",
                          "required": ["$date"],
                          "properties": {
                            "$date": {
                              "type": "string"
                            }
                          },
                          "additionalProperties": false,
                          "nullable": true
                        }
                      }
                    }
                  }
                },
                "additionalProperties": false
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Import successful.",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "transportActivity": {
        "allOf": [{ "$ref": "#/components/schemas/transportActivityReqBody" }],
        "type": "object",
        "required": ["id", "createdBy", "createdAt"],
        "properties": {
          "id": { "type": "string" },
          "createdBy": { "type": "string" },
          "createdAt": { "type": "string", "format": "date-time" },
          "updatedAt": { "type": "string", "format": "date-time", "nullable": true }
        }
      },
      "transportActivityReqBody": {
        "type": "object",
        "properties": {
          "title": { "type": "string" },
          "date": { "type": "string", "format": "date-time" },
          "totalEmissions": { "type": "number" },
          "distance": { "type": "number" },
          "specificEmissions": { "type": "number" },
          "fuelType": { "type": "string", "enum": ["Diesel", "Gasoline", "LPG", "CNG", "Electricity"] },
          "specificFuelConsumption": { "type": "number" },
          "totalFuelConsumption": { "type": "number" },
          "calcMode": { "type": "string", "enum": ["SpecificEmissions", "SpecificFuel", "TotalFuel"] },
          "trainType": { "type": "string", "enum": ["Local", "Long-Distance"] },
          "persons": { "type": "number" },
          "transportMode": { "$ref": "#/components/schemas/transportMode" }
        },
        "required": ["title", "date", "totalEmissions"],
        "additionalProperties": false
      },
      "transportMode": { "type": "string", "enum": ["Car", "Train"] }
    },
    "securitySchemes": {
      "AzureADBearerStrategy": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "NaiveAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Naive-Auth"
      }
    }
  }
}