Skip to navigation

nemoguardrails.server.experimental.provider.transport

View as MarkdownOpen in Claude

Describe provider fields and API revisions bound outside JSON bodies.

Module Contents

Classes

NameDescription
ApiRevisionConstraintDefine which client-selected API revisions a binding accepts.
ExactApiRevisionAccept one exact provider API revision.
ProviderApiRevisionBindingBind a client-selected provider API revision to HTTP metadata.
ProviderBindingViolationReport request metadata outside a guarded endpoint binding.
ProviderTransportRequestExpose the HTTP metadata used by provider transport bindings.
TransportLocationIdentify where provider protocol data appears in an HTTP request.

API

class nemoguardrails.server.experimental.provider.transport.ApiRevisionConstraint()
Abstract

Define which client-selected API revisions a binding accepts.

example
str

Return one accepted revision for examples and tests.

nemoguardrails.server.experimental.provider.transport.ApiRevisionConstraint.accepts(
revision: str | None
) -> bool
abstract

Return whether a received revision is accepted.

nemoguardrails.server.experimental.provider.transport.ApiRevisionConstraint.describe() -> str
abstract

Describe accepted revisions in validation errors.

nemoguardrails.server.experimental.provider.transport.ApiRevisionConstraint.openapi_schema() -> dict[str, object]
abstract

Describe accepted revisions as an OpenAPI string schema.

class nemoguardrails.server.experimental.provider.transport.ExactApiRevision(
value: str
)
Dataclass

Bases: ApiRevisionConstraint

Accept one exact provider API revision.

example
str

Return the accepted revision.

value
str
nemoguardrails.server.experimental.provider.transport.ExactApiRevision.__post_init__() -> None

Require a non-empty revision.

nemoguardrails.server.experimental.provider.transport.ExactApiRevision.accepts(
revision: str | None
) -> bool

Return whether the received revision is the reviewed value.

nemoguardrails.server.experimental.provider.transport.ExactApiRevision.describe() -> str

Describe the accepted revision in validation errors.

nemoguardrails.server.experimental.provider.transport.ExactApiRevision.openapi_schema() -> dict[str, object]

Describe the exact revision as an OpenAPI string schema.

class nemoguardrails.server.experimental.provider.transport.ProviderApiRevisionBinding(
transport_name: str,
error_code: str = 'unsupported_provider_api_r...
)
Dataclass

Bind a client-selected provider API revision to HTTP metadata.

accepted
ApiRevisionConstraint
error_code
str = 'unsupported_provider_api_revision'
location
TransportLocation
transport_name
str
nemoguardrails.server.experimental.provider.transport.ProviderApiRevisionBinding.__post_init__() -> None

Validate revision transport metadata.

nemoguardrails.server.experimental.provider.transport.ProviderApiRevisionBinding.openapi_parameter() -> dict[str, object]

Return the required OpenAPI revision parameter.

nemoguardrails.server.experimental.provider.transport.ProviderApiRevisionBinding.validate(
) -> None

Validate one revision selector, rejecting even identical duplicates.

class nemoguardrails.server.experimental.provider.transport.ProviderBindingViolation(
message: str,
code: str
)

Bases: ValueError

Report request metadata outside a guarded endpoint binding.

class nemoguardrails.server.experimental.provider.transport.ProviderTransportRequest()
Protocol

Expose the HTTP metadata used by provider transport bindings.

headers
Sequence[tuple[bytes, bytes]]

Return the request headers as raw name/value pairs.

query
bytes

Return the raw request query string.

class nemoguardrails.server.experimental.provider.transport.TransportLocation

Bases: enum.Enum

Identify where provider protocol data appears in an HTTP request.

HEADER
= 'header'
PATH
= 'path'
QUERY
= 'query'