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

Refactor swagger definitions to factor out reusable components #183

Open
dsbivan opened this issue May 19, 2022 · 1 comment
Open

Refactor swagger definitions to factor out reusable components #183

dsbivan opened this issue May 19, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@dsbivan
Copy link

dsbivan commented May 19, 2022

Description
As part of the OAS 3 migration, all reusable components were inlined into the various objects that use them.

This includes:

  • responses
  • parameters
  • headers

A tightening up of the schema definitions will make it easier to read and may help code generators

Related Work Items
Those swagger definitions which went through the OAS3 migration

- cds_admin
- cds_banking
- cds_common
- cds_dcr
- cds_register
@dsbivan dsbivan added documentation Improvements or additions to documentation enhancement New feature or request labels May 19, 2022
@CDR-API-Stream CDR-API-Stream changed the title Refactor swagger definitions to take re-add reusable components Refactor swagger definitions to factor out reusable components May 26, 2022
@nils-work
Copy link
Member

Repetitive (common) headers in the Banking spec., like x-v could reference a single structure in components.parameters, like RequestHeader_x-v

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants