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

docs: Swagger docs #1352

Merged
merged 1 commit into from
Jun 14, 2022
Merged

docs: Swagger docs #1352

merged 1 commit into from
Jun 14, 2022

Conversation

bstasyszyn
Copy link
Contributor

@bstasyszyn bstasyszyn commented Jun 14, 2022

Added swagger docs for:

  • /acceptlist
  • /services/orb
  • /services/orb/activities
  • /services/orb/followers
  • /services/orb/following
  • /services/orb/inbox
  • /services/orb/keys
  • /services/orb/liked
  • /services/orb/outbox
  • /services/orb/shares
  • /services/orb/witnesses
  • /services/orb/witnessing
  • /cas
  • /log
  • /metrics
  • /nodeinfo
  • /policy
  • /vc

Also updated the Makefile 'checks' target to also validate the open-api-spec.

closes #575
closes #1351

Signed-off-by: Bob Stasyszyn Bob.Stasyszyn@securekey.com

Added swagger docs for

- /acceptlist
- /services/orb
- /services/orb/activities
- /services/orb/followers
- /services/orb/following
- /services/orb/inbox
- /services/orb/keys
- /services/orb/liked
- /services/orb/outbox
- /services/orb/shares
- /services/orb/witnesses
- /services/orb/witnessing
- /cas
- /log
- /metrics
- /nodeinfo
- /policy
- /vc

Also updated the Makefile 'checks' target to also validate the open-api-spec.

closes trustbloc#575
closes trustbloc#1351

Signed-off-by: Bob Stasyszyn <Bob.Stasyszyn@securekey.com>
@cla-bot cla-bot bot added the cla-signed label Jun 14, 2022
@codecov
Copy link

codecov bot commented Jun 14, 2022

Codecov Report

Merging #1352 (26143e1) into main (5e410c0) will decrease coverage by 0.09%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##             main    #1352      +/-   ##
==========================================
- Coverage   87.95%   87.85%   -0.10%     
==========================================
  Files         192      199       +7     
  Lines       18557    18582      +25     
==========================================
+ Hits        16321    16326       +5     
- Misses       1428     1448      +20     
  Partials      808      808              
Impacted Files Coverage Δ
cmd/orb-server/main.go 77.77% <ø> (ø)
pkg/activitypub/resthandler/openapi.go 0.00% <0.00%> (ø)
pkg/anchor/anchorlinkset/vcresthandler/openapi.go 0.00% <0.00%> (ø)
pkg/anchor/witness/policy/resthandler/openapi.go 0.00% <0.00%> (ø)
pkg/discovery/endpoint/restapi/operations.go 88.51% <ø> (ø)
pkg/metrics/openapi.go 0.00% <0.00%> (ø)
pkg/nodeinfo/openapi.go 0.00% <0.00%> (ø)
pkg/vct/resthandler/openapi.go 0.00% <0.00%> (ø)
pkg/webcas/openapi.go 0.00% <0.00%> (ø)
pkg/vct/proofmonitoring/monitoring.go 84.07% <0.00%> (-2.66%) ⬇️
... and 2 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5e410c0...26143e1. Read the comment docs.

@fqutishat fqutishat merged commit d310515 into trustbloc:main Jun 14, 2022
@bstasyszyn bstasyszyn deleted the 575 branch June 14, 2022 19:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Swagger docs for remaining endpoints Swagger docs for ActivityPub endpoints
3 participants