Skip to content

Commit

Permalink
feat: first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
simenandre committed Sep 28, 2020
1 parent d57accd commit 15888fc
Show file tree
Hide file tree
Showing 357 changed files with 54,881 additions and 1 deletion.
Binary file added .github/header.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
*.dll
*.so
*.dylib
bin

# Test binary, built with `go test -c`
*.test
Expand Down
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing to crayon-api-go

:+1::tada: Thanks for taking the time to contribute! :tada::+1:

The following is a set of guidelines for contributing. These are just
guidelines, not rules, so use your best judgment and feel free to
propose changes to this document in a pull request.

## Issues and Pull Requests

* If you're not sure about adding something, [open an issue](https://github.com/bjerkio/crayon-api-go/issues/new) to discuss it.
* Feel free to open a Pull Request early so that a discussion can be had as changes are developed.

## Commit Messages and Pull Request Titles

We use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification to standardize our commit history. To enforce this convention on commit messages and/or pull request titles, we use the [Semantic Pull Requests](https://github.com/probot/semantic-pull-requests) bot.

The commit message summary (or pull request title) is constructed by prepending the type of change being made (e.g., feat, fix, refactor), followed by an imperative, present tense sentence (without a period).
Example: `fix: make header bold`.

If you are still working on your pull request, prepend `WIP:` to indicate that it's work in progress.

### Pull Request Title

Same as commit messages, prepend the type of change being made (refactor, fix, chore, feat, etc.)
Example: `docs: add linux setup instructions`

## Need Help?

If any of this information confusing, incorrect, or incomplete, feel free to
[open an issue](https://github.com/bjerkio/crayon-api-go/issues/new)
for help.
18 changes: 18 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
all: install_deps download_swagger generate

.PHONY: install_deps
install_deps:
# go get -u github.com/google/addlicense
docker pull quay.io/goswagger/swagger
go generate ./tools.go

.PHONY: download_swagger
download_swagger:
curl -o ./swagger.json https://api.crayon.com/swagger/v1/swagger.json

.PHONY: generate
generate:
alias swagger="docker run --rm -it -e GOPATH=$$HOME/go:/go -v $$HOME:$$HOME -w $$(pwd) quay.io/goswagger/swagger"
swagger generate client -f \
./swagger.json -t ./ --skip-validation
./bin/addlicense -c "Bjerk AS" **/*.go
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,34 @@
# crayon-api-go
![Crayon API Golang Client][banner]

![Build & Deploy][build-badge]
[![Total alerts][lgtm-badge]][lgtm-alerts]
[![Maintainability][codeclimate-badge]][codeclimate]

## About

The Crayon API (Cloud IQ) for Golang simplifies integrations against [Crayon CloudIQ API][apidocs]. The client is generated using [swagger-go][swagger-go].

# Documentation

Apart from this README, you can find details and examples of using the SDK in
the following places:

- [SDK Documentation][sdk-doc]
- [API Documentation][apidocs]
- [API Endpoints][apiendpoints]

## Contributing

We love contributions! 🙏 Bug reports and pull requests are welcome on [GitHub][github].

[banner]: ./.github/header.png
[build-badge]: https://github.com/bjerkio/crayon-api-go/workflows/build/badge.svg
[lgtm-badge]: https://img.shields.io/lgtm/alerts/g/bjerkio/crayon-api-go.svg?logo=lgtm&logoWidth=18
[lgtm-alerts]: https://lgtm.com/projects/g/bjerkio/crayon-api-go/alerts/
[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c72cb4454d9425e68b5f/maintainability
[codeclimate]: https://codeclimate.com/github/bjerkio/crayon-api-go/maintainability
[apidocs]: https://apidocs.crayon.com/
[apiendpoints]: https://apiv1.crayon.com/docs/
[swagger-go]: https://github.com/go-swagger/go-swagger
[github]: https://github.com/bjerkio/crayon-api-go
[sdk-doc]: https://pkg.go.dev/mod/github.com/bjerkio/crayon-api-go
147 changes: 147 additions & 0 deletions client/agreement_products/agreement_products_client.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

135 changes: 135 additions & 0 deletions client/agreement_products/get_as_excel_file_parameters.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 15888fc

Please sign in to comment.