Build · Create · Engineering

OpenAPI endpoint reference

A complete, well-formed reference for one endpoint: method, path, parameters (with every path placeholder covered), the required status codes, and a consistent request body.

You receive: A structured endpoint reference (JSON) that passes the method, path-parameter, response-code, and body checks.

Part of Ship MVP

What's verified: STUD verifies the submitted endpoint reference (JSON) is well-formed and complete: the HTTP method and path are valid and match your intake, every {placeholder} in the path has a required path parameter, parameters are typed and non-duplicated, the required status codes are all documented, and a request body is present and typed exactly when one is required. STUD does NOT call the endpoint or verify the descriptions are accurate; it checks the reference's structure.