Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: refactor api docs #628

Merged
merged 47 commits into from
Feb 23, 2024
Merged

Conversation

darrenvechain
Copy link
Member

These changes include

  • Updates to Open API Spec
    • Update examples to return actual results
    • Add error codes for each endpoints
    • Update & expand on descriptions
    • Fixing typos
    • Remove deprecated endpoints from spec
    • Deprecate /subscriptions/beat
  • Migration from swagger UI to Stoplight elements
    • UI is also modified such that examples are not shown for websocket endpoints

Changes tested by visiting this URL

@darrenvechain darrenvechain marked this pull request as draft December 19, 2023 12:32
@darrenvechain darrenvechain marked this pull request as ready for review December 19, 2023 14:54
Makefile Outdated Show resolved Hide resolved
.DS_Store Outdated Show resolved Hide resolved
api/doc/thor.yaml Outdated Show resolved Hide resolved
@darrenvechain
Copy link
Member Author

Hey @libotony I've made the updates you suggested

@libotony libotony mentioned this pull request Dec 25, 2023
api/doc/thor.yaml Outdated Show resolved Hide resolved
api/doc/thor.yaml Outdated Show resolved Hide resolved
api/doc/thor.yaml Outdated Show resolved Hide resolved
api/doc/thor.yaml Outdated Show resolved Hide resolved
api/doc/thor.yaml Outdated Show resolved Hide resolved
api/doc/thor.yaml Outdated Show resolved Hide resolved
api/doc/thor.yaml Outdated Show resolved Hide resolved
api/doc/thor.yaml Outdated Show resolved Hide resolved
api/doc/thor.yaml Outdated Show resolved Hide resolved
api/doc/thor.yaml Outdated Show resolved Hide resolved
api/doc/thor.yaml Outdated Show resolved Hide resolved
api/doc/thor.yaml Outdated Show resolved Hide resolved
api/doc/thor.yaml Outdated Show resolved Hide resolved
@darrenvechain
Copy link
Member Author

Hey @libotony I resolved your latest comments in the latest commit

@codecov-commenter
Copy link

codecov-commenter commented Dec 27, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (39ecf84) 57.40% compared to head (36494aa) 51.98%.
Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #628      +/-   ##
==========================================
- Coverage   57.40%   51.98%   -5.43%     
==========================================
  Files         179      156      -23     
  Lines       20678    17218    -3460     
==========================================
- Hits        11870     8950    -2920     
+ Misses       7922     7445     -477     
+ Partials      886      823      -63     

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

api/doc/thor.yaml Outdated Show resolved Hide resolved
api/doc/thor.yaml Outdated Show resolved Hide resolved
api/doc/thor.yaml Outdated Show resolved Hide resolved
@darrenvechain
Copy link
Member Author

Apologies @libotony, I missed those. I have pushed the changes now

@claytonneal
Copy link
Member

hi @darrenvechain for request:
/debug/storage-range
its not clear to me what the parameter "target" means - perhaps could do with an extra explanation? thanks

@darrenvechain
Copy link
Member Author

darrenvechain commented Jan 29, 2024

hi @darrenvechain for request: /debug/storage-range its not clear to me what the parameter "target" means - perhaps could do with an extra explanation? thanks

@claytonneal I made the changes:

63a9b32...darrenvechain:thor:api-doc-refactor

api/doc/thor.yaml Outdated Show resolved Hide resolved
api/doc/thor.yaml Show resolved Hide resolved
api/doc/thor.yaml Outdated Show resolved Hide resolved
api/doc/thor.yaml Show resolved Hide resolved
api/doc/thor.yaml Outdated Show resolved Hide resolved
api/doc/thor.yaml Show resolved Hide resolved
darrenvechain and others added 10 commits February 2, 2024 08:47
Co-authored-by: libotony <liboliqi@gmail.com>
Co-authored-by: libotony <liboliqi@gmail.com>
Co-authored-by: libotony <liboliqi@gmail.com>
Co-authored-by: libotony <liboliqi@gmail.com>
Co-authored-by: libotony <liboliqi@gmail.com>
api/doc/api-docs/window-observer.js Outdated Show resolved Hide resolved
api/doc/swagger-ui/window-observer.js Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
api/api.go Outdated Show resolved Hide resolved
@libotony
Copy link
Member

libotony commented Feb 5, 2024

Screenshot 2024-02-05 at 09 52 37-min

How about using this as the screenshot? The older one has a small shadow around the page that will show the frame of the image.

@libotony libotony merged commit 0997c25 into vechain:master Feb 23, 2024
10 checks passed
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.

4 participants