BAbavix
stubs

Inspect stub matching decision path

Changed on

Returns detailed matching stages/candidates for a query without consuming stub times.

post/stubs/inspect

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/stubs/inspect
  • Auth
    none required

Request body

idstring uuid

Stub identifier (UUID).

servicestring required

Fully qualified gRPC service name.

methodstring required

gRPC method name.

sessionstring

Session to resolve against; empty means the global scope.

headersobject

Request metadata, matched against stub headers.

inputobject[]

Request body, matched against stub input.

Example request

{
  "id": "51c50050-ec27-4dae-a583-a32ca71a1dd5"
}

Response

Successful operation

servicestring required

Service that was inspected.

methodstring required

Method that was inspected.

sessionstring required

Session the request was resolved against.

matchedStubIdstring required

UUID of the winning stub, absent when nothing matched.

similarStubIdstring required

Closest non-matching stub, offered as a hint when nothing matched.

fallbackToMethodboolean required

True when no stub matched the input and the search widened to any stub on the method.

errorstring required

Why the request could not be resolved.

Changes