Changes in schema & guide

[Imod7]

Description

The goal of this PR was mainly to close the issue #1076 but added some other minor changes too.

Changes

In the OpenAPI specs :

• Moved the /accounts/{accountId}/convert path under /accounts/{accountId}/balance-info so it is in alphabetical order.
• Added the AccountConvert schema (which was missing as mentioned in the issue 1076).
• Added items of type: string under the PalletStorageItem schema because otherwise it was showing the following error in the Swagger Editor

  Semantic error at components.schemas.PalletStorageItem.properties.keys
  Schemas with 'type: array', require a sibling 'items: ' field
  

In the CONTRIBUTING guide :

• Added the step of verifying with the swagger editor before rebuilding the docs. It is already mentioned in the docs README but maybe it is useful to have it also in the contributing page assuming that potential contributors will mainly check the contributing guide.

Todos

[x] Verify changes with the swagger editor
[x] Rebuild the docs

[jsdw]

Moved the /accounts/{accountId}/convert path under /accounts/{accountId}/balance-info so it is in alphabetical order.

Much like we do with code formatting, we could run something like https://www.npmjs.com/package/openapi-format in CI to complain if it's not formatted (and possibly catch a few issues; not sure). Committers would then be expected to run something likenpm run openapi-format to fix it if it's an issue.

Just a thought though :)

[Imod7]

Much like we do with code formatting, we could run something like https://www.npmjs.com/package/openapi-format in CI to complain if it's not formatted (and possibly catch a few issues; not sure). Committers would then be expected to run something likenpm run openapi-format to fix it if it's an issue.

Just a thought though :)

I think that is a great idea! 💯 I will check what commands/jobs we need to add in the .gitlab-ci.yml file to have this check/fix in CI.

[jsdw]

That aside, looks good to me! I'd suggest that the above changes be a new PR anyway; no need to stop this fix from merging :)