oso.framework.plugin.api.v1alpha1 namespace

Submodules

oso.framework.plugin.api.v1alpha1.documents module

Documents Endpoints.

class oso.framework.plugin.api.v1alpha1.documents.Api

Bases: MethodView

Plugin Documents View.

get()

GET /v1alpha/documents endpoint.

Returns:

body – jsonify’d return from oso.framework.plugin.base.ISVBase.to_oso() with a 200 HTTP response code. To return an error, ISVBase.to_oso() should raise the appropriate HTTPError.

Return type:

dict

methods: t.ClassVar[t.Collection[str] | None] = {'GET', 'POST'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

post()

POST /v1alpha/documents endpoint.

Returns:

body – jsonify’d return from oso.framework.plugin.base.ISVBase.to_isv() with a 200 HTTP response code. To return an error, ISVBase.to_isv() should raise the appropriate HTTPError.

Return type:

dict

oso.framework.plugin.api.v1alpha1.status module

Status Endpoint.

class oso.framework.plugin.api.v1alpha1.status.Api

Bases: MethodView

Plugin Status View.

get()

GET /v1alpha1/status endpoint.

methods: t.ClassVar[t.Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.