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:
[x] Obtain the latest version of the OpenAI OpenAPI specification from the official openai-openapi repository
[x] 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
[ ] #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
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:
openai-openapi
repository