Motivation

• Provide a machine-readable OpenAPI 3.0.3 specification for the v1 REST surface so API consumers and tooling can discover and validate endpoints implemented in the Spring controllers under src/main/java/com/crawlerApi/api.
• Represent legacy $variable route notation as standards-compliant path parameters so the spec is compatible with OpenAPI tooling.

Description

• Added docs/openapi.yaml containing API metadata, server info, JWT bearerAuth security scheme, tags, reusable path/query parameter components, and base schemas (Object, Account).
• Documented the v1 endpoints discovered in controllers (accounts, audits, auditrecords, auditor, competitors, designsystem, domains, elements, ide-test-export, integrations, pages, testrecords, testusers, userinfo) including HTTP methods, key path/query parameters, request bodies, and binary report responses (Excel/PDF).
• Converted controller route patterns into OpenAPI paths (e.g. controller $key -> {key}) and added representative request/response shapes so tools can generate clients or docs.

Testing

• Verified the file exists and committed it (git status / commit) which succeeded.
• Attempted to lint the spec with npx --yes @redocly/cli lint docs/openapi.yaml which failed due to npm registry access policy (403 Forbidden).
• Attempted to parse the YAML with Python (import yaml; yaml.safe_load('docs/openapi.yaml')) which failed because PyYAML is not installed in the environment.
• Manually inspected the generated spec (nl -ba docs/openapi.yaml) to confirm endpoint coverage and parameter definitions (inspection succeeded).

Codex Task