chain_api_plugin swagger file - develop

[dskvr]

Work in progress

Change Description

• Adds Chain API Swagger File.
• Consumes OAS 3.0 compatible json-schema from remote canonical to limit build complexity and testing surface of EOSIO/eos repository.

TODO

• ~Depends on several adjustments to existing schemata. ~
• Alignment with 2.0 APIs
• Some descriptions are missing Pending
• To preserve type signatures in generators (applies to both swagger-codegen and openapi-generator though more so for the latter) move request and responses to definitions.
• Begin to identify the describable status codes in the error ranges (the response format is currently too inconsistent for definition on many status codes)
• Add example requests to each end-point.

Needs attention

• get_required_keys - No response has been defined
• get_currency_stats - A response with a wildcard key can be defined * (where * is the symbol)

Preview
https://eosio.github.io/eos/latest/nodeos/plugins/chain_api_plugin/api-reference/index#tag/Chain

Assignees
@iamveritas - Give @lparisc some good pointers and consider adding descriptions, look for NEEDS DESCRIPTION
@lparisc - Prepare for handoff and add remaining descriptions

Review criteria
@b1bart - Technical accuracy (time permits)
@arhag - Technical accuracy (time permits)
@lparisc - Technical accuracy (supplemental) and documentation
@iamveritas - Technical accuracy (supplemental) and documentation
@jlamarr22 - Specification adherence and compatibility with generators

Consensus Changes

• Consensus Changes

API Changes

• API Changes

Documentation Additions

• Documentation Additions

[jlamarr22]

LGTM, just some comments on things that can be removed and things that we could add. This could go in as-is though aside from updating https://github.com/EOSIO/eos/pull/8494/files#diff-137adfd5ab958db3399bcbe30e57fb53R40

[lparisc]

Tests pass locally; approving now until remaining descriptions can be added