Galaxies

delete_galaxy async

delete_galaxy(
    auth: Annotated[
        Auth,
        Depends(
            authorize(
                AuthStrategy.HYBRID, [Permission.SITE_ADMIN]
            )
        ),
    ],
    db: Annotated[Session, Depends(get_db)],
    galaxy_id: Annotated[str, Path(alias=galaxyId)],
    request: Request,
) -> DeleteForceUpdateImportGalaxyResponse

"Delete a specific galaxy by its Id.

Input:

• the user's authentification status

• the current database

• the galaxy id

• the request

Output:

• the deleted galaxy

delete_galaxy_depr async

delete_galaxy_depr(
    auth: Annotated[
        Auth,
        Depends(
            authorize(
                AuthStrategy.HYBRID, [Permission.SITE_ADMIN]
            )
        ),
    ],
    db: Annotated[Session, Depends(get_db)],
    galaxy_id: Annotated[str, Path(alias=galaxyId)],
    request: Request,
) -> DeleteForceUpdateImportGalaxyResponse

Delete Galaxy by GalaxyID.

Input:

• the user's authentification status

• the current database

• the galaxy id

• the request

Output:

• the deleted galaxy

get_galaxies async

get_galaxies(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.HYBRID))
    ],
    db: Annotated[Session, Depends(get_db)],
) -> list[GetAllSearchGalaxiesResponse]

Get a list with all existing galaxies.

Input:

• the user's authentification status

• the current database

Output:

• all galaxies

get_galaxy_details async

get_galaxy_details(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.HYBRID))
    ],
    db: Annotated[Session, Depends(get_db)],
    galaxy_id: Annotated[str, Path(alias=galaxyId)],
) -> GetGalaxyResponse

"Gets the details of a galaxy.

Input:

• the user's authentification status

• the current database

• the galaxy id

Output:

• the details of the galaxy

get_galaxy_details_depr async

get_galaxy_details_depr(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.HYBRID))
    ],
    db: Annotated[Session, Depends(get_db)],
    galaxy_id: Annotated[str, Path(alias=galaxyId)],
) -> GetGalaxyResponse

View Galaxy by given Galaxy ID.

Input:

• the user's authentification status

• the current database

• the galaxy id

Output:

• the details of the galaxy

search_galaxies async

search_galaxies(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.HYBRID))
    ],
    db: Annotated[Session, Depends(get_db)],
    body: SearchGalaxiesbyValue,
) -> list[GetAllSearchGalaxiesResponse]

Search galaxies by search term which matches with galaxy name, namespace, description, kill_chain_order or uuid."

Input:

• the user's authentification status

• the current database

• the request body

Output:

• the galaxies found by search

update_galaxy async

update_galaxy(
    auth: Annotated[
        Auth,
        Depends(
            authorize(
                AuthStrategy.WORKER_KEY,
                [Permission.SITE_ADMIN],
            )
        ),
    ],
    db: Annotated[Session, Depends(get_db)],
) -> DeleteForceUpdateImportGalaxyResponse

Force the galaxies to update with the JSON definitions, not yet implemented.

Input:

• the user's authentification status

• the current database

Output:

• the updated galaxies