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

chore(test) openai api type matching / conformance testing #299

Closed
2 of 12 tasks
gerred opened this issue Mar 21, 2024 · 2 comments · Fixed by #910
Closed
2 of 12 tasks

chore(test) openai api type matching / conformance testing #299

gerred opened this issue Mar 21, 2024 · 2 comments · Fixed by #910
Assignees
Labels
EPIC ⚔️ EPIC issue to consolidate several sub-issues tech-debt Not a feature, but still necessary

Comments

@gerred
Copy link
Member

gerred commented Mar 21, 2024

Chore: API Type Matching / OpenAI OpenAPI Conformance Testing

Context:
To ensure compatibility and consistency with the OpenAI API, it is essential to audit the types implemented in our API and verify that they match the types and request/response signatures defined in the OpenAI API. Additionally, we need to develop compliance testing against the official openai-openapi repository to detect any drift or deviations over time.

Tasks:

  • Obtain the latest version of the OpenAI OpenAPI specification from the official openai-openapi repository
  • Identify all the types and request/response signatures currently implemented in our API
  • Compare each type and signature in our API with the corresponding definitions in the OpenAI OpenAPI specification
  • Document any discrepancies or deviations found during the comparison
  • Update our API codebase to match the types and signatures defined in the OpenAI OpenAPI specification
  • Create a nightly workflow of conformance tests that validate our API against the OpenAI OpenAPI specification #986
  • Integrate the compliance tests into our CI/CD pipeline to automatically detect any drift or deviations
  • Set up automated alerts or notifications when the compliance tests fail, indicating a mismatch with the OpenAI API
  • Establish a regular schedule to sync our API with the latest version of the OpenAI OpenAPI specification
  • Document the process for updating our API to maintain compatibility with the OpenAI API
  • Provide clear instructions for running the compliance tests and interpreting the results
  • Regularly review and update the compliance tests as the OpenAI API evolves over time
@YrrepNoj YrrepNoj added this to the SPRINT+1 milestone Apr 4, 2024
@YrrepNoj YrrepNoj modified the milestones: SPRINT+1, v0.8.0 Apr 18, 2024
@barronstone barronstone changed the title chore: openai api type matching / conformance testing chore(test) openai api type matching / conformance testing May 31, 2024
@barronstone barronstone added the tech-debt Not a feature, but still necessary label Jul 8, 2024
@alekst23 alekst23 self-assigned this Aug 8, 2024
@alekst23 alekst23 linked a pull request Aug 14, 2024 that will close this issue
@alekst23 alekst23 reopened this Sep 4, 2024
@alekst23
Copy link
Contributor

alekst23 commented Sep 4, 2024

Reopening this issue to finish the full scope of conformance testing

@alekst23 alekst23 added the EPIC ⚔️ EPIC issue to consolidate several sub-issues label Sep 5, 2024
@justinthelaw
Copy link
Contributor

Ensure these tests cover the issue found and solved by #1031

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
EPIC ⚔️ EPIC issue to consolidate several sub-issues tech-debt Not a feature, but still necessary
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants