Skip to content

docs: use SmartREST 2.0 external id terminology instead of name#3442

Merged
reubenmiller merged 1 commit intothin-edge:mainfrom
reubenmiller:docs-smartrest2-template-id-notes
Mar 3, 2025
Merged

docs: use SmartREST 2.0 external id terminology instead of name#3442
reubenmiller merged 1 commit intothin-edge:mainfrom
reubenmiller:docs-smartrest2-template-id-notes

Conversation

@reubenmiller
Copy link
Copy Markdown
Contributor

Proposed changes

Change the SmartREST 2.0 guide to refer to the external id of a template to avoid confusion for users using custom templates.

This PR was promopted by direct customer feedback where a custom template was being created where the name of the template differed from the external id, so when configuring thin-edge.io, the template's name was incorrectly refererned instead of the templates's external id.

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)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy 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

@reubenmiller reubenmiller temporarily deployed to Test Pull Request March 3, 2025 10:43 — with GitHub Actions Inactive
@reubenmiller reubenmiller added documentation Improvements or additions to documentation theme:c8y Theme: Cumulocity related topics labels Mar 3, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 3, 2025

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
583 0 3 583 100 1h37m15.872878s

Copy link
Copy Markdown
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

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

Approved

@reubenmiller reubenmiller added this pull request to the merge queue Mar 3, 2025
Merged via the queue into thin-edge:main with commit 980dcd2 Mar 3, 2025
31 checks passed
@reubenmiller reubenmiller deleted the docs-smartrest2-template-id-notes branch March 3, 2025 16:08
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:c8y Theme: Cumulocity related topics

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants