Skip to content

Commit ca3d60f

Browse files
committed
docs: Remove arguments description in post route
1 parent e0d1128 commit ca3d60f

File tree

1 file changed

+3
-28
lines changed

1 file changed

+3
-28
lines changed

src/app/api/routes/sites.py

Lines changed: 3 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,66 +10,41 @@
1010

1111
@router.post("/", response_model=SiteOut, status_code=201, summary="Create a new site")
1212
async def create_site(payload: SiteIn):
13-
<<<<<<< HEAD
14-
"""Creates a new site based on the given information:
13+
"""Creates a new site based on the given information
1514
16-
- **lon**: Longitude of the site
17-
- **lat**: Latitude of the site
18-
- **name**: Site name
19-
- **type**: Type of the site chosen in the following set {"tower", "station"}
20-
21-
Below, click on "Schema" for more detailed information about fields
22-
or "Example Value" to get a concrete idea of inputs fields
15+
Below, click on "Schema" for more detailed information about arguments
16+
or "Example Value" to get a concrete idea of arguments
2317
"""
24-
return await routing.create_entry(sites, payload)
25-
=======
2618
return await crud.create_entry(sites, payload)
27-
>>>>>>> master
2819

2920

3021
@router.get("/{site_id}/", response_model=SiteOut, summary="Get information about a specific site")
3122
async def get_site(site_id: int = Path(..., gt=0)):
32-
<<<<<<< HEAD
3323
"""
3424
Based on a site_id, retrieves information about the given site
3525
"""
36-
return await routing.get_entry(sites, site_id)
37-
=======
3826
return await crud.get_entry(sites, site_id)
39-
>>>>>>> master
4027

4128

4229
@router.get("/", response_model=List[SiteOut], summary="Get the list of all sites")
4330
async def fetch_sites():
44-
<<<<<<< HEAD
4531
"""
4632
Retrieves the list of all sites with each related information
4733
"""
48-
return await routing.fetch_entries(sites)
49-
=======
5034
return await crud.fetch_all(sites)
51-
>>>>>>> master
5235

5336

5437
@router.put("/{site_id}/", response_model=SiteOut, summary="Update information about a specific site")
5538
async def update_site(payload: SiteIn, site_id: int = Path(..., gt=0)):
56-
<<<<<<< HEAD
5739
"""
5840
Based on a site_id, updates information about the given site
5941
"""
60-
return await routing.update_entry(sites, payload, site_id)
61-
=======
6242
return await crud.update_entry(sites, payload, site_id)
63-
>>>>>>> master
6443

6544

6645
@router.delete("/{site_id}/", response_model=SiteOut, summary="Delete a specific site")
6746
async def delete_site(site_id: int = Path(..., gt=0)):
68-
<<<<<<< HEAD
6947
"""
7048
Based on a site_id, deletes the given site
7149
"""
72-
return await routing.delete_entry(sites, site_id)
73-
=======
7450
return await crud.delete_entry(sites, site_id)
75-
>>>>>>> master

0 commit comments

Comments
 (0)