bee icon indicating copy to clipboard operation
bee copied to clipboard

fix: openapi changes - remove defunct 'delete stake' entry - add descriptions - fix typos

Open NoahMaizels opened this issue 1 year ago • 2 comments

Checklist

  • [ x] I have read the coding guide.
  • [ x] My change requires a documentation update, and I have done it.
  • [ ] I have added tests to cover my changes.
  • [x ] I have filled out the description and linked the related issues.

Description

Made multiple small changes to OpenAPI specs.

  1. openapi/SwarmCommon.yaml
    • Line 38 - "exceeds" corrected to exceed
  2. openapi/SwarmDebug.yaml
    • Line 678 - "xDai" changed to "xDAI" for consistency
    • Line 703 - Added "description" field to explain "amount"
    • Line 709 - Added "description" field to explain "address"
    • Line 715 - Added "description" field to explain "{coin}"
    • Line 1064 Removed entire "delete" section

Motivation and Context (Optional)

General improvement of OpenAPI specs

NoahMaizels avatar Apr 17 '24 17:04 NoahMaizels

@NoahMaizels what's the motivation for this change? The /stake endpoint is one that is currently being used.

nikipapadatou avatar Aug 19 '24 10:08 nikipapadatou

closing because this API is needed

istae avatar Aug 24 '24 16:08 istae

@gacevicljubisa can you help @NoahMaizels merge this PR? btw we should not remove the stake "Delete" endpoint as this is needed

istae avatar Nov 29 '24 00:11 istae