Front-End Checklist API

openapi: 3.1.0
info:
  title: Front-End Checklist API
  version: '2026-11-08'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-08: 5 operation(s) read from 4 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Front-End Checklist has published no machine-readable contract
    that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 3
    pages-with-code: 2
    pages-read: 4
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-08'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://frontendchecklist.io/rules/testing/contract-testing
  - https://frontendchecklist.io/rules/html/subresource-integrity
  - https://frontendchecklist.io/rules/testing/integration-testing
  - https://frontendchecklist.io/rules/javascript/cross-origin-security
paths:
  /api/users:
    post:
      operationId: post_api_users
      tags:
      - Api
      summary: Write integration tests for key workflows
      description: Creates a user with valid data and returns the created user object (id, name, email). Returns 400 for duplicate email.
      x-source: https://frontendchecklist.io/rules/testing/integration-testing
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiUsersRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiUsersResponse'
      x-evidence:
        kind: documentation
  /lib.js:
    get:
      operationId: get_lib_js
      tags:
      - Lib
      summary: GET /lib.js
      x-source: https://frontendchecklist.io/rules/html/subresource-integrity
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -s https://cdn.example.com/lib.js | openssl dgst -sha384 -binary | openssl base64 -A '
  /user:
    get:
      operationId: get_user
      tags:
      - User
      summary: GET /user
      x-source: https://frontendchecklist.io/rules/javascript/cross-origin-security
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserResponse'
      x-evidence:
        kind: code-example
        language: javascript
        snippet: "fetch ( 'https://api.example.com/user' , { \n credentials: 'include' , //Sends cookies \n headers: { 'Content-Type' : 'application/json'\
          \ } \n })"
  /users:
    get:
      operationId: get_users
      tags:
      - Users
      summary: GET /users
      x-source: https://frontendchecklist.io/rules/testing/contract-testing
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: string
        description: Page number
      - name: limit
        in: query
        required: false
        schema:
          type: string
        description: Number of items per page
      - name: Accept
        in: header
        required: false
        schema:
          type: string
        description: application/json
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUsersResponse'
      x-evidence:
        kind: documentation
  /users/{id}:
    get:
      operationId: get_users_id
      tags:
      - Users
      summary: GET /users/:id
      x-source: https://frontendchecklist.io/rules/testing/contract-testing
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: false
        schema:
          type: string
        description: Bearer token for authentication
      - name: Accept
        in: header
        required: false
        schema:
          type: string
        description: application/json
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUsersIdResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiUsersRequest:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
      required:
      - name
      - email
    PostApiUsersResponse:
      type: object
      properties:
        '201':
          type: string
          description: User created successfully
        '400':
          type: string
          description: Duplicate email or validation error
    GetUserResponse:
      type: object
      properties:
        credentials:
          type: string
        headers:
          type: object
          properties:
            Content-Type:
              type: string
    GetUsersResponse:
      type: object
      properties:
        '200':
          type: string
          description: Successful response with paginated list of users
    GetUsersIdResponse:
      type: object
      properties:
        '200':
          type: string
          description: Successful response with user object
        '404':
          type: string
          description: User not found
tags:
- name: Api
- name: Lib
- name: User
- name: Users