Spec Operation Examples
Generate examples for a specific operation of the specified spec.
Generates examples for a specific operation of the specified spec identified by its API name. Optionally specify the operation name, count, and index.
Parameters:
- api_name (str): The name of the spec to generate examples for. examples for.
- payload (SpecExamplePayload): Payload containing operation name, count, and index flags.
- current_user (AuthUser): The current user making the request. Retrieved using dependency injection.
Returns:
- dict: Examples or error detail.
Raises:
- HTTPException(500): If an error occurs while generating the examples.
Authorizations
JWT Authorization header using the Bearer scheme. Example: 'Authorization: Bearer {token}'
Path Parameters
Body
Payload model for generating examples for a specific operation of the specified spec.
The name of the operation for which examples are to be generated.
Additional context parameters that may include relevant info for the LLM
The number of examples to generate.
Flag indicating whether to use the generated examples to index.
Flag indicating whether to force re-generation of examples.
Response
Successful Response
