How camaraproject/devicestatus works
Project type and purpose
• This is an “Incubating API Repository” for the “DeviceStatus” service, focused on evolving and maintaining OpenAPI definitions, test specs, documentation, and CI validations for DeviceStatus Service APIs.
• It does not contain runtime server or client code; rather it holds YAML API definitions, BDD test feature files, documentation, and linter scripts, all orchestrated via GitHub Actions.
File structure
• Top-level folders:
• code/API_definitions – OpenAPI YAML files for each API and subscription topic
• code/Test_definitions – Cucumber (.feature) files and test README
• documentation – API-readiness checklists, user stories, supporting docs, meeting minutes
• lint_function – custom JavaScript rules for Spectral & MegaLinter
• .github/workflows – CI pipelines for linting and schema checks
• Config files: .spectral.yml, yamllint.yaml, GitHub Actions workflows, lint scripts.
README for additional insights
• Describes scope (reachable status, roaming status, subscription notifications)
• Points to staging, release cadence, governance links
• Emphasizes continuous validation (no runtime binaries).
Final advice
• Be thorough but focused: capture the spec-validation lifecycle end to end