mainframe.endpoints.suppressions

Attributes

router

Classes

SuppressionPath

The nested identity of one suppression resource.

Functions

_normalize_package_name(→ str)	Return the normalized package name defined by PEP 503.
_get_suppression(→ mainframe.models.orm.Suppression)
list_package_suppressions(], _auth, ...)	List every suppression for a package across all versions.
create_suppression(], auth, ...)	Create an independently addressable suppression.
get_suppression(], session, Depends], _auth, ...)	Get one suppression by its stable identifier.
update_suppression(], body, session, Depends], auth, ...)	Replace the rule corpus for one suppression.
delete_suppression(], session, Depends], _auth, ...)	Delete one suppression by its stable identifier.
delete_version_suppressions(], _auth, ...)	Delete every suppression for one package version.

Module Contents

mainframe.endpoints.suppressions.router

class mainframe.endpoints.suppressions.SuppressionPath(package_name: str, package_version: str, suppression_id: uuid.UUID)

The nested identity of one suppression resource.

package_name

package_version

suppression_id

mainframe.endpoints.suppressions._normalize_package_name(package_name: str) → str

Return the normalized package name defined by PEP 503.

mainframe.endpoints.suppressions._get_suppression(session: sqlalchemy.orm.Session, *, package_name: str, package_version: str, suppression_id: uuid.UUID) → mainframe.models.orm.Suppression

mainframe.endpoints.suppressions.list_package_suppressions(package_name: str, session: Annotated[sqlalchemy.orm.Session, Depends(get_db)], _auth: Annotated[mainframe.json_web_token.AuthenticationData, Depends(validate_token)]) → list[mainframe.models.schemas.SuppressionResponse]

List every suppression for a package across all versions.

mainframe.endpoints.suppressions.create_suppression(package_name: str, package_version: str, body: mainframe.models.schemas.SuppressionCreate, session: Annotated[sqlalchemy.orm.Session, Depends(get_db)], auth: Annotated[mainframe.json_web_token.AuthenticationData, Depends(validate_token)]) → mainframe.models.schemas.SuppressionResponse

Create an independently addressable suppression.

mainframe.endpoints.suppressions.get_suppression(path: Annotated[SuppressionPath, Depends()], session: Annotated[sqlalchemy.orm.Session, Depends(get_db)], _auth: Annotated[mainframe.json_web_token.AuthenticationData, Depends(validate_token)]) → mainframe.models.schemas.SuppressionResponse

Get one suppression by its stable identifier.

mainframe.endpoints.suppressions.update_suppression(path: Annotated[SuppressionPath, Depends()], body: mainframe.models.schemas.SuppressionUpdate, session: Annotated[sqlalchemy.orm.Session, Depends(get_db)], auth: Annotated[mainframe.json_web_token.AuthenticationData, Depends(validate_token)]) → mainframe.models.schemas.SuppressionResponse

Replace the rule corpus for one suppression.

mainframe.endpoints.suppressions.delete_suppression(path: Annotated[SuppressionPath, Depends()], session: Annotated[sqlalchemy.orm.Session, Depends(get_db)], _auth: Annotated[mainframe.json_web_token.AuthenticationData, Depends(validate_token)]) → mainframe.models.schemas.SuppressionDeleteResponse

Delete one suppression by its stable identifier.

mainframe.endpoints.suppressions.delete_version_suppressions(package_name: str, package_version: str, session: Annotated[sqlalchemy.orm.Session, Depends(get_db)], _auth: Annotated[mainframe.json_web_token.AuthenticationData, Depends(validate_token)]) → mainframe.models.schemas.SuppressionDeleteResponse

Delete every suppression for one package version.