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

Generate OpenAPI v2 and v3 specs #146

Merged
merged 12 commits into from
Feb 23, 2024
Merged

Conversation

tdeebswihart
Copy link
Contributor

@tdeebswihart tdeebswihart commented Feb 5, 2024

What changed?

We now generate openapi v2 (swagger) and v3 specs as a part of proto compilation.

Why?

So that we can serve these on our HTTP API

How did you test it?

Build and run temporalio/temporal#5393 (make start-dependencies + make start)

$ curl localhost:7243/api/v1/swagger.json
$ curl localhost:7243/api/v1/openapi.yaml

Potential risks

@Quinn-With-Two-Ns
Copy link
Contributor

Should this be in the next server RC?

@tdeebswihart tdeebswihart force-pushed the tds/openapi-spec-generation branch from 56ab32d to 711793f Compare February 6, 2024 17:56
@tdeebswihart
Copy link
Contributor Author

Should this be in the next server RC?

No. We plan to release this in a point release

openapi/spec.go Outdated Show resolved Hide resolved
cmd/encode-openapi-spec/main.go Outdated Show resolved Hide resolved
openapi/openapiv3.go Outdated Show resolved Hide resolved
openapi/swagger.go Outdated Show resolved Hide resolved
@tdeebswihart tdeebswihart force-pushed the tds/openapi-spec-generation branch from 88d0674 to 56ec19b Compare February 23, 2024 22:30
@tdeebswihart tdeebswihart merged commit 6dc0f17 into master Feb 23, 2024
4 checks passed
@tdeebswihart tdeebswihart deleted the tds/openapi-spec-generation branch February 23, 2024 22:52
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.

3 participants