Generates openapi spec from annotated routes #402
Merged
Conversation
This file contains 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
Contributor
invaliduser
commented
May 8, 2024
•
invaliduser
commented
- annotates routes with gen-openapi
- combines with annotations from similarly-annotated lrs routes
- serves generated openAPI spec in JSON form at /admin/openapi
invaliduser
force-pushed
the
openapi-generate
branch
from
6d6c52d to
788afda
Compare
invaliduser
force-pushed
the
openapi-generate
branch
from
788afda to
b6686b7
Compare
invaliduser
changed the title
invaliduser
changed the title
invaliduser
changed the title
milt
reviewed
Jul 22, 2024
invaliduser
changed the title
milt
reviewed
Jul 22, 2024
milt
reviewed
Jul 22, 2024
|
It would be nice to have the endpoints alphabetically sorted. This is especially important to visually separate the |
src/main/lrsql/system/openapi.clj
Outdated
| (def oa-routes (atom nil)) | ||
| (def general-map {:openapi "3.0.0" | ||
| :info {:title "LRSQL" | ||
| :version "0.7.2"} |
There was a problem hiding this comment.
is this supposed to be the release version? It's kinda rough when the release version needs to be manually updated on each push. There ARE solutions where we can introspect git repo on build for this, but they can be hairy.
invaliduser
force-pushed
the
openapi-generate
branch
from
3bc0065 to
a7a213b
Compare
milt
reviewed
Jul 25, 2024
milt
reviewed
Jul 25, 2024
milt
reviewed
Jul 25, 2024
invaliduser
force-pushed
the
openapi-generate
branch
from
a7a213b to
7d5bc15
Compare
milt
reviewed
Jul 25, 2024
invaliduser
force-pushed
the
openapi-generate
branch
from
0f09a85 to
093c2e1
Compare
src/main/lrsql/init/git_data.clj
Outdated
| (defn read-version [] | ||
| (try (edn/read-string (slurp "lrsql/config/git-details.edn")) | ||
| (catch Exception _ | ||
| (try (clojure.string/trim (str "DEV-" (:out (sh "git" "describe" "--tags")))) |
There was a problem hiding this comment.
i suspect in this case since you are attempting to have a fallback in the case of a non-exact tag that this is where you would want the hash (sh "git" "rev-parse" "HEAD"). If we try here at all, that seems more useful than "last tag"
milt
reviewed
Jul 26, 2024
milt
reviewed
Jul 26, 2024
milt
approved these changes
Jul 26, 2024
cliffcaseyyet
approved these changes
Jul 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.