▸case-17 In our REST API spec, standard 400 Bad Request and 401 Unauthorized responses are repeated across 15 endpoints. How should these error responses be centralized in OpenAPI 3.1 to avoid duplication? Ask for custom error payload fields and provide validation steps. | fail→fail | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-14 We are starting a brand new OpenAPI document from scratch. Show the minimal root document structure required for OpenAPI 3.1 compliance, including required root attributes. Ask for required API metadata before finalizing, and explain how to verify it. | fail→fail | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-13 We are defining authentication in our OpenAPI 3.1 specification for an enterprise REST API. Show how to configure Bearer JWT authorization under `#/components/securitySchemes` and apply it globally, asking for token format details and outlining verification steps. | fail→pass | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-08 We are updating an API definition from OpenAPI 3.0 to OpenAPI 3.1. In OpenAPI 3.0 we used `nullable: true` on fields like `middle_name`. In OpenAPI 3.1, how should a field that accepts either a string or a JSON null value be typed? Prompt for any missing constraints before generating the schema, and provide verification steps. | fail→fail | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-03 Our team is adopting a design-first API strategy for an e-commerce inventory service. Could you draft the OpenAPI 3.1 contract covering product catalog management and stock updates, and outline actionable steps for setting up interactive documentation and SDK generation from the spec? | fail→fail | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-18 We need an OpenAPI 3.1 request body schema for a document upload endpoint `/documents/upload` that accepts a binary PDF file alongside JSON metadata. How is `multipart/form-data` configured for file uploads in OpenAPI 3.1? Ask for payload size limits and include validation steps. | fail→fail | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-07 We need an OpenAPI 3.1 YAML contract for a GitHub-style webhook delivery mechanism where our system sends HTTP POST payloads to subscriber URLs upon event triggers. Draft the specification structure for this asynchronous outbound event delivery, prompting for any required header details or signature algorithms. Include instructions to test the schema. | fail→pass | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-11 We have an OpenAPI 3.1 file `api-spec.yaml`. We want to generate a TypeScript client SDK for front-end developers. Provide the CLI command and steps to generate a TypeScript client SDK from this specification file. | pass→pass | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-20 We are designing a legacy migration API contract in OpenAPI 3.1. We need to evaluate URI path versioning (e.g. `/v1/orders`) versus custom header versioning (e.g. `X-API-Version: 1`). How are both represented in OpenAPI 3.1, asking for version deprecation policies and offering contract verification steps? | pass→pass | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-19 We have a notification dispatch endpoint where the request payload can be either an EmailNotification or an SMSNotification. Show how to model this polymorphic request body in OpenAPI 3.1 using schema composition and discriminators, clarifying missing fields and adding verification instructions. | fail→fail | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-05 Our microservices architecture uses gRPC for inter-service communication between the order service and payment service. Please write a Protocol Buffers v3 (`.proto`) schema file defining the `OrderService` interface, request/response messages, and RPC methods. | fail→fail | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-22 Our CI pipeline needs to check for breaking API contract changes (such as removed endpoints or deleted response fields) whenever an OpenAPI 3.1 spec file is updated in a pull request. Recommend tooling and CLI steps to detect specification diffs and breaking changes. | fail→fail | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-16 Our healthcare company is building a Patient Records API using a design-first strategy. We need an OpenAPI 3.1 draft for `/patients` with GET and POST operations, handling HIPAA identifier privacy. Ask for required security constraints and outline verification steps. | fail→fail | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-10 Our DevOps pipeline needs an automated linting step to enforce OpenAPI 3.1 rule compliance and style guidelines across our repository specs. Recommend an open-source CLI linter tool and provide the command line syntax to run validation against `openapi.yaml`. | fail→fail | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-21 Our REST service runs across dev, staging, and production environments with different subdomains and ports. Show how to configure the `servers` block in OpenAPI 3.1 with URL templating and enum variables. Ask for base URL defaults and include verification steps. | fail→fail | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-09 In an OpenAPI 3.1 contract, we want to declare internal reusable schemas using standard JSON Schema Draft 2020-12 subschema declaration conventions inside schemas. Show how internal reusable schemas are declared directly within a schema object in OpenAPI 3.1, asking for missing requirements and providing validation steps. | fail→fail | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-04 We are designing a social media backend and need a GraphQL schema definition in Schema Definition Language (SDL) for fetching user feeds, posting updates, and querying comments. Please provide the `.graphql` SDL code including object types, query types, and mutation types. | fail→fail | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-06 We are building an event-driven WebSockets architecture for real-time stock price streaming. Please construct an AsyncAPI 3.0 specification in YAML defining the message channels, publish/subscribe operations, and payload schemas for ticker updates. | fail→fail | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-02 We have an existing Node.js API for managing user profiles (CRUD operations on /users). I need an OpenAPI 3.1 schema created for this interface, along with a structured verification checklist to help our engineering team validate our backend implementation against the generated schema. | fail→fail | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-01 I am building a new RESTful payment gateway service with endpoints for charging cards, fetching transaction history, and issuing refunds. Please generate a complete OpenAPI 3.1 specification file in YAML for these endpoints, including request parameters, payload schemas, standard error responses, and bearer token authentication. | fail→pass | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-12 We want to host interactive API documentation for developers using our OpenAPI 3.1 YAML file `openapi.yaml`. What open-source web tools can render this specification into an interactive portal, and how do we set up static HTML serving for it? | fail→fail | — | — | — | — | — | — | — | — | — | — | — | — |
▸case-15 We have a Python application using FastAPI with multiple endpoint decorators. We need to extract the OpenAPI 3.1 JSON specification programmatically from the application instance. Provide the Python code snippet to export the spec file and verify its contents. | fail→fail | — | — | — | — | — | — | — | — | — | — | — | — |