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

RES-1843 Add OpenAPI coverage testing #623

Merged
merged 15 commits into from Mar 10, 2023
Merged

Conversation

edwh
Copy link
Collaborator

@edwh edwh commented Feb 27, 2023

This builds in automatic testing of the OpenAPI specification to our tests.

We have some cases where we use anyOf to return a group/group summary or similar. For the code to work out which one it is and validate it, we need to add in fields which force the models to be different (not just a subset) and make it required.

Fixes quite a fix issues with the way the API was documented which I hadn't noticed.

Copy link
Contributor

@ngm ngm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me.

Comprehensive documentation of the schema of all resources that might be returned via the API - and each call links to that schema so you can see what you'd expect back inline from any particular call.

Bravo!

# Conflicts:
#	app/Http/Resources/Party.php
#	app/Http/Resources/PartySummary.php
@sonarcloud
Copy link

sonarcloud bot commented Mar 10, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 1 Code Smell

No Coverage information No Coverage information
0.0% 0.0% Duplication

@edwh edwh merged commit 18d1048 into develop Mar 10, 2023
4 checks passed
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.

None yet

2 participants