add group endpoints

app/schemas.py

@@ -307,3 +307,9 @@ class ServiceStatus(BaseModel):
         title="Database",
         description="Operational status of the database",
     )
+
+
+class TagsEnum(str, Enum):
+    apiKeyMaster = "Requests with Master apiKey 🔑"
+    apiKey = "Requests with apiKey 🔑"
+    public = "Requests Public 🌎"

app/service.py

@@ -43,52 +43,70 @@ async def lifespan(app: FastAPI):
 )
 
 
-@app.post("/api/v1/providers", response_model=schemas.APIKey)
+@app.post(
+    "/api/v1/providers",
+    response_model=schemas.APIKey,
+    tags=[schemas.TagsEnum.apiKeyMaster],
+)
 async def create_provider(
     provider: schemas.Provider, key: APIKey = Depends(validate_master_key)
 ):
     key = await models.Provider.create_new_key(db, provider.provider)
     return schemas.APIKey(key=key)
 
 
-@app.get("/api/v1/providers")
+@app.get("/api/v1/providers", tags=[schemas.TagsEnum.apiKeyMaster])
 async def list_providers(key: APIKey = Depends(validate_master_key)):
     return [
         schemas.Provider.from_orm(s) for s in await models.Provider.get_providers(db)
     ]
 
 
-@app.delete("/api/v1/providers/{provider}")
+@app.delete("/api/v1/providers/{provider}", tags=[schemas.TagsEnum.apiKeyMaster])
 async def delete_provider(provider: str, key: APIKey = Depends(validate_master_key)):
     return await models.Provider.revoke_all_keys(db, provider)
 
 
-@app.post("/api/v1/measurements")
+@app.post("/api/v1/measurements", tags=[schemas.TagsEnum.apiKey])
 async def post(
     measurements: List[schemas.Measurement], provider: str = Depends(validate_api_key)
 ):
     await models.Measurement.store(db, [m.to_orm(provider) for m in measurements])
 
 
-@app.get("/api/v1/measurements", response_model=List[schemas.Measurement])
+@app.get(
+    "/api/v1/measurements",
+    response_model=List[schemas.Measurement],
+    tags=[schemas.TagsEnum.public],
+)
 async def get(query: schemas.QueryParams = Depends(schemas.QueryParams)):
     return [
         schemas.Measurement.from_orm(m)
         for m in await models.Measurement.retrieve(db, query)
     ]
 
 
-@app.get("/api/v1/aqi", response_model=List[schemas.Report])
+@app.get(
+    "/api/v1/aqi", response_model=List[schemas.Report], tags=[schemas.TagsEnum.public]
+)
 async def aqi(query: schemas.QueryParams = Depends(schemas.QueryParams)):
     return await reports.AQI.generate(db, query)
 
 
-@app.get("/api/v1/stats", response_model=List[schemas.ReportStats])
+@app.get(
+    "/api/v1/stats",
+    response_model=List[schemas.ReportStats],
+    tags=[schemas.TagsEnum.public],
+)
 async def stats(query: schemas.QueryParams = Depends(schemas.QueryParams)):
     return await reports.Stats.generate(db, query)
 
 
-@app.get("/api/v1/status", response_model=schemas.ServiceStatus)
+@app.get(
+    "/api/v1/status",
+    response_model=schemas.ServiceStatus,
+    tags=[schemas.TagsEnum.public],
+)
 async def status():
     status = schemas.ServiceStatus()