Turn endpoint notes or implementation excerpts into a clear API reference with parameter tables, examples, error handling, and open questions.
No public result for version 1 yet
Version 1 · 3 variables · 3 required
Fill in the values below — the customized prompt updates as you type. marks a required value.
Who will use the API reference and their expected familiarity. Default: External developers integrating a project-management service.
Authoritative endpoint behavior and data schemas; include known gaps. Default: GET /v1/projects. Bearer-token authentication is required. Query: limit, optional integer 1-100, default 20; cursor, optional opaque string. Success 200: {items: [{id: string, name: string}], next_cursor: string|null}. Invalid limit returns 400; missing or invalid token returns 401. Error body format is not yet specified.
Language or tool to use for the minimal request example. Default: curl
Write an API reference for External developers integrating a project-management service. using the supplied contract as the source of truth.
API contract, endpoint notes, or implementation excerpts:
GET /v1/projects. Bearer-token authentication is required. Query: limit, optional integer 1-100, default 20; cursor, optional opaque string. Success 200: {items: [{id: string, name: string}], next_cursor: string|null}. Invalid limit returns 400; missing or invalid token returns 401. Error body format is not yet specified.
Preferred example language:
curl
Structure the Markdown document as:
1. Overview: what the endpoint does and the prerequisite knowledge or access that the supplied contract actually establishes.
2. Request: method and path, authentication when specified, and separate tables for path, query, header, and body fields. Include type, required status, constraints, and defaults only when supported.
3. Responses: documented success and error status codes, response-field meanings, pagination or rate-limit behavior if present, and recovery actions supported by the contract.
4. One minimal request example and a corresponding illustrative response shaped by the documented schema. Clearly label the response as illustrative, and label any credentials or host names as placeholders.
5. Common pitfalls and an implementation-review checklist.
Keep names and types consistent across tables and examples. Never invent endpoint paths, SDK packages, authentication schemes, error payloads, limits, or default values. If a required fact is missing or contradictory, list it under Open questions and explain which part of the documentation cannot be finalized.
Do not claim examples were executed or verified. Prefer a short, accurate reference with explicit gaps over filling those gaps with assumptions.No public examples yet for version 1
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Curated prompt only. No example output or model test is attached; model compatibility has not been verified. Default inputs are illustrative practice material; replace them with your own facts and context.
Reports go to moderators and are never shown publicly.
No public results yet
Turn a documented workflow into a practical SOP with prerequisites, ordered actions, checks, exceptions and explicit gaps for review.
No public results yet
Break a dependency replacement into reviewable stages with compatibility checks, exit criteria and realistic rollback limits.
No public results yet
Define realistic traffic, workload data, measurements and stopping rules for an authorized performance test.
No public results yet
Find source-visible labeling, semantics and keyboard risks, while separating code findings from checks that require a browser.
No public results yet
Map feature assets, trust boundaries and data flows to concrete threats, existing controls and targeted verification tasks.
No public results yet
Turn an API contract into a small client design that handles retryable failures, deadlines and idempotency deliberately.
Oldest first · one level of replies
Sign in to join the discussion. Share what you learned or made with this prompt.
No comments yet
Be the first to share how this prompt worked for you.