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

MODOKAPFAC-2 Implement stub implementation of the okapi interface #3

Merged

Conversation

dmtkachenko
Copy link
Collaborator

@dmtkachenko dmtkachenko commented Aug 15, 2024

Purpose

Implement all endpoints in the okapi interface, but for now returns 501 not implemented. Real implementations of endpoints will be selectively added after this is in place.
US: MODOKAPFAC-2

Approach

  • migrate Okapi API from RAML to OAS using OAS RAML Converter. Adjust the result to group endpoints by responsibility
  • implement stub controllers to return 501 as result
  • add controller tests with auto-generated test data (by instancio lib)

Pre-Merge Checklist:

Before merging this PR, please go through the following list and take appropriate actions.

  • Does this PR meet or exceed the expected quality standards?
    • Code coverage on new code is 80% or greater
    • Duplications on new code is 3% or less
    • There are no major code smells or security issues
  • Does this introduce breaking changes?
    • Were any API paths or methods changed, added, or removed?
    • Were there any schema changes?
    • Did any of the interface versions change?
    • Were permissions changed, added, or removed?
    • Are there new interface dependencies?
    • There are no breaking changes in this PR.

If there are breaking changes, please STOP and consider the following:

  • What other modules will these changes impact?
  • Do Rally stories exist to update the impacted modules?
    • If not, please create them
    • Do they contain the appropriate level of detail? Which endpoints/schemas changed, etc.
    • Do they have all the appropriate links to blocked/related issues?
  • Are the Rally stories under active development?
    • If not, contact the project's PO and make sure they're aware of the urgency.
  • Do PRs exist for these changes?
    • If so, have they been approved?

Ideally, all the PRs involved in breaking changes would be merged on the same day to avoid breaking the folio-testing
environment. Communication is paramount if that is to be achieved, especially as the number of inter-module and
inter-team dependencies increase.

While it's helpful for reviewers to help identify potential problems, ensuring that it's safe to merge is ultimately the
responsibility of the PR assignee.

@dmtkachenko dmtkachenko requested a review from a team as a code owner August 15, 2024 11:46
Copy link

@dmtkachenko dmtkachenko merged commit b451244 into master Aug 16, 2024
6 checks passed
@dmtkachenko dmtkachenko deleted the MODOKAPFAC-2-stub-implementation-of-okapi-interface branch August 16, 2024 09:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants