Skip to content

Revert "Move the openapi source of truth" #44

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Feb 21, 2024
Merged

Revert "Move the openapi source of truth" #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/speakeasy_sdk_generation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
create_release: true
openapi_doc_auth_header: x-api-key
openapi_docs: |
- https://api.unstructured.io/general/openapi.json
- https://raw.githubusercontent.com/Unstructured-IO/unstructured-api/main/openapi.json
Copy link
Contributor

@hubert-rutkowski85 hubert-rutkowski85 Feb 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

We don't want to point at the file in repo? https://github.com/marketplace/actions/speakeasy-client-sdk-generation-action#openapi_docs

      openapi_docs: |
        - ../../openapi.json

Spares us having to manually update it every time something changes (and risking forgetting). Btw, right now it's 404.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hopefully should work now that Unstructured-IO/unstructured-api#369 is merged. My thinking is that the source of truth for params should live with the server code, and we'll update whenever we add a new param in unstructured-api. (It will allow both clients to use the same source.) Although, I didn't realize we could supply multiple files - I wonder if we want to keep client specific params in a local openapi.json and let them merge, rather than having to generate a special overlay file.

Copy link
Contributor

@hubert-rutkowski85 hubert-rutkowski85 Feb 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Yes, url is 200 now :) I also think that unstructured-api should contain source of truth for clients, but we can't use it now directly as there are too big changes in client from it. So we will have to update the openapi.json in this repo whenever backend changes for some time. My point was that we could use the file from repo because I thought the link points to manually uploaded file. I mistaken it for github gists, but it actually points to the file in repo. So it's perfect (EDIT: except maybe for that it points to file on main branch, so changing the file in other branches would not be visibile to CI, but it seems SDK by this file is generated only from main, so should be ok). Anyway, approving to not prolong this discussion.

Re overlays: because there are big differences between server and client openapis, we probably can't do direct comparison like I planned here: 579f2eb Then overlays don't help but add complexity. In such case for simplicity I think to just have a single openapi.json with hand edited changes, plus a well documented .txt doc with list of those changes.

Re js client: didn't look inside yet. Will look after finishing pdf splitting.

publish_python: true
speakeasy_version: latest
secrets:
Expand Down