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

Add endpoint documentation with swagger #13

Merged
merged 5 commits into from
Aug 16, 2022
Merged

Conversation

ErlendHaa
Copy link
Contributor

No description provided.

cmd/query/main.go Show resolved Hide resolved
api/query.go Outdated Show resolved Hide resolved
api/query.go Outdated Show resolved Hide resolved
api/query.go Show resolved Hide resolved
api/query.go Outdated Show resolved Hide resolved
api/query.go Outdated Show resolved Hide resolved
api/query.go Show resolved Hide resolved
api/query.go Outdated Show resolved Hide resolved
internal/vds/vds.go Show resolved Hide resolved
cmd/query/main.go Show resolved Hide resolved
api/query.go Outdated Show resolved Hide resolved
As well as being usefull for testing, these are also usefull for
documentation generation. Because they are used for testing the return
value from CGO (which ultimatly becomes the response body), we can safely
use them for documentation generation. Even tho they are never actually
used in the request handlers. Any out-of-sync issues when changing the
json format will be captured by tests.
@ErlendHaa
Copy link
Contributor Author

Closes #6

Copy link
Contributor

@achaikou achaikou left a comment

Choose a reason for hiding this comment

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

OK, lets leave fetch docs for later

go.mod Show resolved Hide resolved
api/query.go Outdated Show resolved Hide resolved
api/query.go Outdated Show resolved Hide resolved
docs/slice.md Outdated Show resolved Hide resolved
api/query.go Outdated Show resolved Hide resolved
docs/slice.md Outdated Show resolved Hide resolved
docs/slice.md Outdated Show resolved Hide resolved
@ErlendHaa ErlendHaa mentioned this pull request Aug 16, 2022
@ErlendHaa ErlendHaa merged commit f33d887 into equinor:master Aug 16, 2022
@ErlendHaa ErlendHaa deleted the swagger branch August 16, 2022 10:59
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.

2 participants