Skip to content

Commit eaa16af

Browse files
committed
Titlecased router names; rearranged order of routers as loaded in the docs page
1 parent 340fe8f commit eaa16af

File tree

16 files changed

+48
-36
lines changed

16 files changed

+48
-36
lines changed

src/murfey/server/api/auth.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
logger = getLogger("murfey.server.api.auth")
2727

2828
# Set up router
29-
router = APIRouter()
29+
router = APIRouter(tags=["Authentication"])
3030

3131

3232
class CookieScheme(HTTPBearer):

src/murfey/server/api/bootstrap.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
from murfey.util.config import get_hostname, get_machine_config, get_microscope
3535

3636
tag = {
37-
"name": "bootstrap",
37+
"name": "Bootstrap",
3838
"description": __doc__,
3939
"externalDocs": {
4040
"description": "PEP 503",
@@ -44,13 +44,13 @@
4444

4545
# Set up API endpoint groups
4646
# NOTE: Routers MUST have prefixes. prefix="" causes an error
47-
version = APIRouter(prefix="/version", tags=["bootstrap"])
48-
bootstrap = APIRouter(prefix="/bootstrap", tags=["bootstrap"])
49-
cygwin = APIRouter(prefix="/cygwin", tags=["bootstrap"])
50-
msys2 = APIRouter(prefix="/msys2", tags=["bootstrap"])
51-
rust = APIRouter(prefix="/rust", tags=["bootstrap"])
52-
pypi = APIRouter(prefix="/pypi", tags=["bootstrap"])
53-
plugins = APIRouter(prefix="/plugins", tags=["bootstrap"])
47+
version = APIRouter(prefix="/version", tags=["Bootstrap"])
48+
bootstrap = APIRouter(prefix="/bootstrap", tags=["Bootstrap"])
49+
cygwin = APIRouter(prefix="/cygwin", tags=["Bootstrap"])
50+
msys2 = APIRouter(prefix="/msys2", tags=["Bootstrap"])
51+
rust = APIRouter(prefix="/rust", tags=["Bootstrap"])
52+
pypi = APIRouter(prefix="/pypi", tags=["Bootstrap"])
53+
plugins = APIRouter(prefix="/plugins", tags=["Bootstrap"])
5454

5555
logger = logging.getLogger("murfey.server.api.bootstrap")
5656

src/murfey/server/api/clem.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
logger = getLogger("murfey.server.api.clem")
3232

3333
# Create APIRouter class object
34-
router = APIRouter()
34+
router = APIRouter(tags=["Workflows: CLEM"])
3535

3636
# Valid file types
3737
valid_file_types = (

src/murfey/server/api/display.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
from murfey.util.db import DataCollectionGroup, FoilHole, GridSquare
1010

1111
# Create APIRouter class object
12-
router = APIRouter(prefix="/display", tags=["display"])
12+
router = APIRouter(prefix="/display", tags=["Display"])
1313
machine_config = get_machine_config()
1414

1515

src/murfey/server/api/file_manip.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
router = APIRouter(
2222
prefix="/file_manipulation",
2323
dependencies=[Depends(validate_token)],
24-
tags=["file manipulation"],
24+
tags=["File Manipulation"],
2525
)
2626

2727

src/murfey/server/api/hub.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
config = get_machine_config()
1313

14-
router = APIRouter()
14+
router = APIRouter(tags=["Murfey Hub"])
1515

1616

1717
class InstrumentInfo(BaseModel):

src/murfey/server/api/instrument.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
router = APIRouter(
3030
prefix="/instrument_server",
3131
dependencies=[Depends(validate_token)],
32-
tags=["instrument_server"],
32+
tags=["Instrument Server"],
3333
)
3434

3535
log = logging.getLogger("murfey.server.instrument")

src/murfey/server/api/mag_table.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
router = APIRouter(
1111
prefix="/mag_table",
1212
dependencies=[Depends(validate_token)],
13-
tags=["magnification table"],
13+
tags=["Magnification Table"],
1414
)
1515

1616

src/murfey/server/api/processing_parameters.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
router = APIRouter(
1616
prefix="/session_parameters",
1717
dependencies=[Depends(validate_token)],
18-
tags=["processing parameters"],
18+
tags=["Processing Parameters"],
1919
)
2020

2121

src/murfey/server/api/prometheus.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
router = APIRouter(
2020
prefix="/prometheus",
2121
dependencies=[Depends(validate_token)],
22-
tags=["prometheus"],
22+
tags=["Prometheus"],
2323
)
2424

2525

0 commit comments

Comments
 (0)