Skip to content

docs: Add JSON schema for MEA MQTT messages#3652

Merged
didier-wenzek merged 1 commit intothin-edge:mainfrom
didier-wenzek:docs/add-json-schema
Jun 10, 2025
Merged

docs: Add JSON schema for MEA MQTT messages#3652
didier-wenzek merged 1 commit intothin-edge:mainfrom
didier-wenzek:docs/add-json-schema

Conversation

@didier-wenzek
Copy link
Copy Markdown
Contributor

@didier-wenzek didier-wenzek commented May 28, 2025

Proposed changes

  • Add JSON schema for MEA MQTT messages
  • Add JSON schema for operations
  • Reference these schema from the docs For now, we simply keep these schemas under configuration/schema and we will see later where is the better place to reference them.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s. You can activate automatic signing by running just prepare-dev once)
  • I ran just format as mentioned in CODING_GUIDELINES
  • I used just check as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

@codecov
Copy link
Copy Markdown

codecov bot commented May 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@didier-wenzek didier-wenzek marked this pull request as ready for review June 2, 2025 13:42
@reubenmiller reubenmiller added documentation Improvements or additions to documentation theme:developer-exp Theme: improve developer experience labels Jun 3, 2025
"type": "string"
}
},
"$defs": {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about moving these shared types to a common.schema.json?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really prefer to keep things simple here, with independent schemas at the cost of a small redundancy.

Signed-off-by: Didier Wenzek <didier.wenzek@free.fr>
@github-actions
Copy link
Copy Markdown
Contributor

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
641 0 3 641 100 1h55m1.786669999s

@didier-wenzek didier-wenzek added this pull request to the merge queue Jun 10, 2025
Merged via the queue into thin-edge:main with commit 970cd6f Jun 10, 2025
34 checks passed
@didier-wenzek didier-wenzek deleted the docs/add-json-schema branch June 10, 2025 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation theme:developer-exp Theme: improve developer experience

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants