Aiaeap-583 - code generated clients for php and python#61
Closed
eddiesholl wants to merge 8 commits into
Closed
Conversation
|
This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation. |
eddiesholl
commented
Oct 27, 2025
|
|
||
| npm -g install @openapitools/openapi-generator-cli | ||
| openapi-generator-cli generate \ | ||
| -i https://d2awla29kxgk7i.cloudfront.net/api/$API_VERSION/openapi.json \ |
Collaborator
Author
There was a problem hiding this comment.
We don't know the final documentation URL yet
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Not that we are able to host openapi.json files in a docs site, I have tested out the openapi generator tool against the v3.0.0 openapi file for real. Through this process I was able to get a client generated, althoguh for now it has some caveats on it.
I first found some missing fields in the json files themselves, these hav already been addressed and republished.
The default openapi generators have spotty support for mtls configuration. Basically you just need ot be able to supply a path to a cert and key file and pass this through to the raw http client. I have patched up this issue in the api-client folders for php and python here in this PR.
Long term I've submitted this PR which would mean the php and python clients could execute fresh out of the box: OpenAPITools/openapi-generator#22229
The folders also have runner scripts that include a basic snippet for a beef API request. The readme files in each example should make it pretty easy for a user to get going.