Skip to content

docs: Update CoreData API doc#5127

Merged
judehung merged 1 commit intoedgexfoundry:mainfrom
weichou1229:update-doc
Apr 8, 2025
Merged

docs: Update CoreData API doc#5127
judehung merged 1 commit intoedgexfoundry:mainfrom
weichou1229:update-doc

Conversation

@weichou1229
Copy link
Copy Markdown
Member

Update CoreData API doc and fix format

If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/edgex-go/blob/main/.github/Contributing.md

PR Checklist

Please check if your PR fulfills the following requirements:

  • I am not introducing a breaking change (if you are, flag in conventional commit message with BREAKING CHANGE: describing the break)
  • I am not introducing a new dependency (add notes below if you are)
  • I have added unit tests for the new feature or bug fix (if not, why?) not impact
  • I have fully tested (add details below) this the new feature or bug fix (if not, why?) not impact
  • I have opened a PR for the related docs change (if not, why?) not impact

Testing Instructions

New Dependency Instructions (If applicable)

@weichou1229 weichou1229 changed the title doc: Update CoreData API doc docs: Update CoreData API doc Apr 8, 2025
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Apr 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 26.59%. Comparing base (cb94a90) to head (22d0a11).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5127   +/-   ##
=======================================
  Coverage   26.59%   26.59%           
=======================================
  Files         277      277           
  Lines       19927    19927           
=======================================
  Hits         5299     5299           
  Misses      13373    13373           
  Partials     1255     1255           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

Comment thread openapi/core-data.yaml Outdated
required: false
schema:
type: integer
minimum: 0
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

If API allows offset to be -1, should we specify the minimum to be -1 instead of 0 here?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

You're right, updated.

Update CoreData API doc and fix format

Signed-off-by: bruce <weichou1229@gmail.com>
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Apr 8, 2025

Copy link
Copy Markdown
Member

@judehung judehung left a comment

Choose a reason for hiding this comment

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

LGTM

@judehung judehung merged commit 285c460 into edgexfoundry:main Apr 8, 2025
7 checks passed
FelixTing pushed a commit to FelixTing/edgex-go that referenced this pull request Oct 15, 2025
Update CoreData API doc and fix format

Signed-off-by: bruce <weichou1229@gmail.com>
FelixTing pushed a commit to FelixTing/edgex-go that referenced this pull request Oct 15, 2025
Update CoreData API doc and fix format

Signed-off-by: Bruce Huang <weichou1229@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants