-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Octokit Bot <[email protected]>
- Loading branch information
1 parent
c4d84e2
commit 3188c88
Showing
2,682 changed files
with
389,835 additions
and
0 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| ## How to contribute | ||
|
|
||
| Please note that this project is released with a [Contributor Code of Conduct](./CODE_OF_CONDUCT.md). By participating you agree to abide by its terms. | ||
|
|
||
| We appreciate you taking the time to contribute to Octokit or any of the projects in Octokit's ecosystem. Especially as a new contributor, you have a valuable perspective: you will find things confusing and run into problems that no longer occur to the maintainers. Please share them with us so we can make the experience for future contributors the best it can be. | ||
|
|
||
| Thank you 💖 | ||
|
|
||
| There are two types of contributions: issues and pull requests (PRs). Issues are used to track bugs and feature requests, while PRs contribute new content to the repository. | ||
|
|
||
| ## Creating an issue | ||
|
|
||
| Before you create a new issue: | ||
| 1. Search the [project's issues](https://github.com/octokit/go-sdk-enterprise-cloud/issues) to see if a similar issue already exists. If so, please add onto that issue rather than creating a new one. | ||
| 1. If submitting a bug report, include steps and a minimal code sample that will reproduce the issue. | ||
| 1. If submitting a feature request, please share the motivation for the new feature, what alternatives you considered, and any implementation suggestions. | ||
|
|
||
| ## Creating a pull request | ||
|
|
||
| First, is your code a change to the generated source code present in `pkg/github`? If so, you'll want to go to [octokit/source-generator](https://github.com/octokit/source-generator) to modify the generation process. | ||
|
|
||
| If your changes do need to be made here, fork the repository. If you're not sure how to do so, please read [the linked docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo). Then clone your fork and `cd` to that directory locally. | ||
|
|
||
| Ensure that the `go build ./...` and `go test ./...` commands each succeed and result in no changes to the repository. Make your code changes (adding tests and documentation as necessary) and confirm the above validation steps still pass. If you'd like to debug the project, you can use VSCode's tooling to do so. When you're satisfied with your changes, follow [GitHub's docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to create your PR. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,78 @@ | ||
| # github.com/octokit/go-sdk-enterprise-cloud | ||
|
|
||
| An "alpha" version of a generated Go SDK from [GitHub's OpenAPI spec](https://github.com/github/rest-api-description), built on [Kiota](https://github.com/microsoft/kiota). | ||
|
|
||
| ## How do I use it? | ||
|
|
||
| See example client instantiations and requests in [example_test.go](pkg/example_test.go) or in the [cmd/ directory](cmd/). | ||
|
|
||
| ⚠️ **Note**: This SDK is not yet stable. Breaking changes may occur at any time. | ||
|
|
||
| ### Building and testing | ||
|
|
||
| - Build the SDK: `go build ./...` | ||
| - Test the SDK: `go test ./...` | ||
| - Measure test coverage by package (e.g. `authentication`): `go test -v -coverpkg=./pkg/authentication -coverprofile=auth.cov ./pkg/authentication` | ||
| - Test coverage may be viewed in VS Code by running the command `Go: Toggle Test Coverage In Current Package` | ||
| - Alternately, you may run `go tool cover -html auth.cov -o auth.html` and open the generated `auth.html` file in a browser to view test coverage | ||
|
|
||
| ### Authentication | ||
|
|
||
| This SDK supports [Personal Access Tokens (classic)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic), [fine-grained Personal Access Tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#fine-grained-personal-access-tokens), and [GitHub Apps](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app) authentication. | ||
|
|
||
| In order to use either type of Personal Access token, you can use the `WithTokenAuthentication("YOUR_TOKEN_HERE")` functional option when constructing a client, like so: | ||
|
|
||
| ```go | ||
| client, err := pkg.NewApiClient( | ||
| pkg.WithTokenAuthentication(os.Getenv("GITHUB_TOKEN")), | ||
| ) | ||
| if err != nil { | ||
| log.Fatalf("error creating client: %v", err) | ||
| } | ||
| ``` | ||
|
|
||
| In order to authenticate as a GitHub App, you can use the `WithGitHubAppAuthentication` functional option: | ||
|
|
||
| ```go | ||
| client, err := pkg.NewApiClient( | ||
| pkg.WithGitHubAppAuthentication("/path/to/your/pem/file.pem", "your-client-ID", yourInstallationIDInt), | ||
| ) | ||
| if err != nil { | ||
| log.Fatalf("error creating client: %v", err) | ||
| } | ||
| ``` | ||
|
|
||
| To see more detailed examples, view [the cmd/ directory in this repo](cmd/). | ||
|
|
||
| ⚠️ **Note**: There are [three types](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/about-authentication-with-a-github-app) of GitHub App authentication: | ||
| 1. [As the App itself (meta endpoints)](https://docs.github.com/en/rest/apps/apps?apiVersion=2022-11-28) | ||
| 1. [As an App installation](https://docs.github.com/en/rest/authentication/endpoints-available-for-github-app-installation-access-tokens?apiVersion=2022-11-28) | ||
| 1. On behalf of a user | ||
|
|
||
| Authenticating on behalf of a user is not supported in an SDK, as it requires a UI authentication flow with redirects. This SDK supports authenticating as the App itself and as an App installation. | ||
|
|
||
| Note that the SDK **does not yet** support authenticating as the App itself and as an App installation using the same client transparently to the user. Authenticating as the App itself requires [creating a JSON Web Token (JWT)](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app) and using that as token authentication. For helpers to create and sign a JWT in Go, you may use the [golang-jwt/jwt](https://github.com/golang-jwt/jwt) library. | ||
|
|
||
| Authenticating as an App installation can be done using the `WithGitHubAppAuthentication` functional option. Future work is planned to make the App meta endpoints vs. App installation endpoints auth schemes transparent to the user and only require one client setup. | ||
|
|
||
| ## Why a generated SDK? | ||
|
|
||
| We want to... | ||
| 1. provide 100% coverage of the API in our SDK | ||
| 2. use this as a building block for future SDK tooling. | ||
|
|
||
| ## Why Go? | ||
|
|
||
| We don't currently support a Go SDK and we wanted a narrow scope for the initial effort without worrying about cutting over users of an existing SDK. | ||
|
|
||
| ## How can I report on my experience or issues with the SDK? | ||
|
|
||
| Please use this project's [issues](https://github.com/octokit/go-sdk-enterprise-cloud/issues)! | ||
|
|
||
| ## Releasing this project | ||
|
|
||
| Periodically (based on the frequency of [this workflow](https://github.com/octokit/source-generator/blob/main/.github/workflows/build-go.yml)), the source-generator repository will ingest the latest version of [GitHub's OpenAPI spec](https://github.com/github/rest-api-description) and generate a new version of this SDK. If there is a diff, a PR (similar to [this one](https://github.com/octokit/go-sdk-enterprise-cloud/pull/22)) will be generated. | ||
|
|
||
| When reviewing the PR, analyze the diff and determine whether the changes are breaking (for which a major version number must be incremented), feature additions (for which a minor version number must be incremented), or bug fixes or docs changes (for which a patch number must be incremented). For more details about how to select an appropriate semantic version, see [semver.org](https://semver.org/). In many/most cases, due to the scale of GitHub's specification and the rate of change on it, the diff will be large and the changes will be technically breaking. This will mean incrementing a major version number. If a major version is being incremented, it must be changed in the [go.mod](./go.mod) file as described in [these docs](https://go.dev/doc/modules/release-workflow#breaking). | ||
|
|
||
| When changes are analyzed, change the PR title appropriately (see [this PR](https://github.com/octokit/go-sdk-enterprise-cloud/pull/40) for an example) and merge it. Then go to [repository releases](https://github.com/octokit/go-sdk-enterprise-cloud/releases), tag the release with the chosen version, title it with the chosen version, use the "Generate release notes" button to see what PRs will be included in the release, and manually edit the release notes grouping the changes under the headings `Features`, `Fixes`, `Maintenance`, and `Documentation` when appropriate. After clicking "Publish Release", the new version will be available for use! |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
| "log" | ||
| "os" | ||
| "strconv" | ||
| "time" | ||
|
|
||
| abs "github.com/microsoft/kiota-abstractions-go" | ||
| "github.com/octokit/go-sdk-enterprise-cloud/pkg" | ||
| "github.com/octokit/go-sdk-enterprise-cloud/pkg/github/installation" | ||
| ) | ||
|
|
||
| func main() { | ||
| installationID, err := strconv.ParseInt(os.Getenv("INSTALLATION_ID"), 10, 64) | ||
| if err != nil { | ||
| log.Fatalf("error parsing installation ID from string to int64: %v", err) | ||
| } | ||
|
|
||
| client, err := pkg.NewApiClient( | ||
| pkg.WithUserAgent("my-user-agent"), | ||
| pkg.WithRequestTimeout(5*time.Second), | ||
| pkg.WithBaseUrl("https://api.github.com"), | ||
| pkg.WithGitHubAppAuthentication(os.Getenv("PATH_TO_PEM_FILE"), os.Getenv("CLIENT_ID"), installationID), | ||
| ) | ||
|
|
||
| // equally valid: | ||
| //client, err := pkg.NewApiClient() | ||
| if err != nil { | ||
| log.Fatalf("error creating client: %v", err) | ||
| } | ||
|
|
||
| queryParams := &installation.RepositoriesRequestBuilderGetQueryParameters{} | ||
| requestConfig := &abs.RequestConfiguration[installation.RepositoriesRequestBuilderGetQueryParameters]{ | ||
| QueryParameters: queryParams, | ||
| } | ||
| repos, err := client.Installation().Repositories().Get(context.Background(), requestConfig) | ||
| if err != nil { | ||
| log.Fatalf("error getting repositories: %v", err) | ||
| } | ||
|
|
||
| if len(repos.GetRepositories()) > 0 { | ||
| log.Printf("Repositories:\n") | ||
| for _, repo := range repos.GetRepositories() { | ||
| log.Printf("%v\n", *repo.GetFullName()) | ||
| } | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "log" | ||
| "os" | ||
| "time" | ||
|
|
||
| abs "github.com/microsoft/kiota-abstractions-go" | ||
| "github.com/octokit/go-sdk-enterprise-cloud/pkg" | ||
| ) | ||
|
|
||
| func main() { | ||
| client, err := pkg.NewApiClient( | ||
| pkg.WithUserAgent("my-user-agent"), | ||
| pkg.WithRequestTimeout(5*time.Second), | ||
| pkg.WithBaseUrl("https://api.github.com"), | ||
| pkg.WithTokenAuthentication(os.Getenv("GITHUB_TOKEN")), | ||
| ) | ||
|
|
||
| // equally valid: | ||
| //client, err := pkg.NewApiClient() | ||
| if err != nil { | ||
| log.Fatalf("error creating client: %v", err) | ||
| } | ||
|
|
||
| queryParams := &abs.DefaultQueryParameters{} | ||
| requestConfig := &abs.RequestConfiguration[abs.DefaultQueryParameters]{ | ||
| QueryParameters: queryParams, | ||
| } | ||
| zen, err := client.Zen().Get(context.Background(), requestConfig) | ||
| if err != nil { | ||
| log.Fatalf("error getting repositories: %v", err) | ||
| } | ||
| fmt.Printf("GitHub Zen principle: %v\n", *zen) | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| module github.com/octokit/go-sdk-enterprise-cloud | ||
|
|
||
| go 1.21.5 | ||
|
|
||
| require ( | ||
| github.com/kfcampbell/ghinstallation v0.0.6 | ||
| github.com/microsoft/kiota-abstractions-go v1.6.0 | ||
| github.com/microsoft/kiota-http-go v1.3.3 | ||
| github.com/microsoft/kiota-serialization-form-go v1.0.0 | ||
| github.com/microsoft/kiota-serialization-json-go v1.0.7 | ||
| github.com/microsoft/kiota-serialization-multipart-go v1.0.0 | ||
| github.com/microsoft/kiota-serialization-text-go v1.0.0 | ||
| ) | ||
|
|
||
| require ( | ||
| github.com/cjlapao/common-go v0.0.39 // indirect | ||
| github.com/davecgh/go-spew v1.1.1 // indirect | ||
| github.com/go-logr/logr v1.4.1 // indirect | ||
| github.com/go-logr/stdr v1.2.2 // indirect | ||
| github.com/golang-jwt/jwt/v5 v5.2.1 // indirect | ||
| github.com/google/uuid v1.6.0 // indirect | ||
| github.com/octokit/go-sdk v0.0.13 // indirect | ||
| github.com/pmezard/go-difflib v1.0.0 // indirect | ||
| github.com/std-uritemplate/std-uritemplate/go v0.0.55 // indirect | ||
| github.com/stretchr/testify v1.9.0 // indirect | ||
| go.opentelemetry.io/otel v1.24.0 // indirect | ||
| go.opentelemetry.io/otel/metric v1.24.0 // indirect | ||
| go.opentelemetry.io/otel/trace v1.24.0 // indirect | ||
| gopkg.in/yaml.v3 v3.0.1 // indirect | ||
| ) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| github.com/cjlapao/common-go v0.0.39 h1:bAAUrj2B9v0kMzbAOhzjSmiyDy+rd56r2sy7oEiQLlA= | ||
| github.com/cjlapao/common-go v0.0.39/go.mod h1:M3dzazLjTjEtZJbbxoA5ZDiGCiHmpwqW9l4UWaddwOA= | ||
| github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= | ||
| github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= | ||
| github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= | ||
| github.com/go-logr/logr v1.4.1 h1:pKouT5E8xu9zeFC39JXRDukb6JFQPXM5p5I91188VAQ= | ||
| github.com/go-logr/logr v1.4.1/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= | ||
| github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag= | ||
| github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE= | ||
| github.com/golang-jwt/jwt/v5 v5.2.1 h1:OuVbFODueb089Lh128TAcimifWaLhJwVflnrgM17wHk= | ||
| github.com/golang-jwt/jwt/v5 v5.2.1/go.mod h1:pqrtFR0X4osieyHYxtmOUWsAWrfe1Q5UVIyoH402zdk= | ||
| github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= | ||
| github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= | ||
| github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= | ||
| github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= | ||
| github.com/kfcampbell/ghinstallation v0.0.6 h1:L4QkjRqNosJ6Kyetymq7FswY1wUxMQO+fyYXJAWl0WY= | ||
| github.com/kfcampbell/ghinstallation v0.0.6/go.mod h1:UXWfCKaLwF+AiyCo8gxE5oA0VMQsAmCdRXgTyyRdUnA= | ||
| github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI= | ||
| github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= | ||
| github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= | ||
| github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= | ||
| github.com/microsoft/kiota-abstractions-go v1.6.0 h1:qbGBNMU0/o5myKbikCBXJFohVCFrrpx2cO15Rta2WyA= | ||
| github.com/microsoft/kiota-abstractions-go v1.6.0/go.mod h1:7YH20ZbRWXGfHSSvdHkdztzgCB9mRdtFx13+hrYIEpo= | ||
| github.com/microsoft/kiota-http-go v1.3.3 h1:FKjK5BLFONu5eIBxtrkirkixFQmcPwitZ8iwZHKbESo= | ||
| github.com/microsoft/kiota-http-go v1.3.3/go.mod h1:IWw/PwtBs/GYz+Pa75gPW7MFNFv0aKPFsLw5WqzL1SE= | ||
| github.com/microsoft/kiota-serialization-form-go v1.0.0 h1:UNdrkMnLFqUCccQZerKjblsyVgifS11b3WCx+eFEsAI= | ||
| github.com/microsoft/kiota-serialization-form-go v1.0.0/go.mod h1:h4mQOO6KVTNciMF6azi1J9QB19ujSw3ULKcSNyXXOMA= | ||
| github.com/microsoft/kiota-serialization-json-go v1.0.7 h1:yMbckSTPrjZdM4EMXgzLZSA3CtDaUBI350u0VoYRz7Y= | ||
| github.com/microsoft/kiota-serialization-json-go v1.0.7/go.mod h1:1krrY7DYl3ivPIzl4xTaBpew6akYNa8/Tal8g+kb0cc= | ||
| github.com/microsoft/kiota-serialization-multipart-go v1.0.0 h1:3O5sb5Zj+moLBiJympbXNaeV07K0d46IfuEd5v9+pBs= | ||
| github.com/microsoft/kiota-serialization-multipart-go v1.0.0/go.mod h1:yauLeBTpANk4L03XD985akNysG24SnRJGaveZf+p4so= | ||
| github.com/microsoft/kiota-serialization-text-go v1.0.0 h1:XOaRhAXy+g8ZVpcq7x7a0jlETWnWrEum0RhmbYrTFnA= | ||
| github.com/microsoft/kiota-serialization-text-go v1.0.0/go.mod h1:sM1/C6ecnQ7IquQOGUrUldaO5wj+9+v7G2W3sQ3fy6M= | ||
| github.com/octokit/go-sdk v0.0.13 h1:DdJfWFeGUoFRHY82dxquRdBl9GvE1Vk7g2dVOjMyGpQ= | ||
| github.com/octokit/go-sdk v0.0.13/go.mod h1:T65KGdB1QQvRbvd9MmuNGieldRyxMj45omX1vizOUu4= | ||
| github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= | ||
| github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= | ||
| github.com/std-uritemplate/std-uritemplate/go v0.0.55 h1:muSH037g97K7U2f94G9LUuE8tZlJsoSSrPsO9V281WY= | ||
| github.com/std-uritemplate/std-uritemplate/go v0.0.55/go.mod h1:rG/bqh/ThY4xE5de7Rap3vaDkYUT76B0GPJ0loYeTTc= | ||
| github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= | ||
| github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= | ||
| go.opentelemetry.io/otel v1.24.0 h1:0LAOdjNmQeSTzGBzduGe/rU4tZhMwL5rWgtp9Ku5Jfo= | ||
| go.opentelemetry.io/otel v1.24.0/go.mod h1:W7b9Ozg4nkF5tWI5zsXkaKKDjdVjpD4oAt9Qi/MArHo= | ||
| go.opentelemetry.io/otel/metric v1.24.0 h1:6EhoGWWK28x1fbpA4tYTOWBkPefTDQnb8WSGXlc88kI= | ||
| go.opentelemetry.io/otel/metric v1.24.0/go.mod h1:VYhLe1rFfxuTXLgj4CBiyz+9WYBA8pNGJgDcSFRKBco= | ||
| go.opentelemetry.io/otel/trace v1.24.0 h1:CsKnnL4dUAr/0llH9FKuc698G04IrpWV0MQA/Y1YELI= | ||
| go.opentelemetry.io/otel/trace v1.24.0/go.mod h1:HPc3Xr/cOApsBI154IU0OI0HJexz+aw5uPdbs3UCjNU= | ||
| gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= | ||
| gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY= | ||
| gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= | ||
| gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= | ||
| gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| package authentication | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| abs "github.com/microsoft/kiota-abstractions-go" | ||
| "github.com/octokit/go-sdk-enterprise-cloud/pkg/headers" | ||
| ) | ||
|
|
||
| // Request provides a wrapper around Kiota's abs.RequestInformation type | ||
| type Request struct { | ||
| *abs.RequestInformation | ||
| } | ||
|
|
||
| // WithTokenAuthentication sets the Authorization header to the given token, | ||
| // prepended by the AuthType | ||
| func (r *Request) WithTokenAuthentication(token string) { | ||
| if r.Headers.ContainsKey(headers.AuthorizationKey) { | ||
| r.Headers.Remove(headers.AuthorizationKey) | ||
| } | ||
| r.Headers.Add(headers.AuthorizationKey, fmt.Sprintf("%v %v", headers.AuthType, token)) | ||
| } | ||
|
|
||
| // WithUserAgent allows the caller to set the User-Agent string for each request | ||
| func (r *Request) WithUserAgent(userAgent string) { | ||
| if r.Headers.ContainsKey(headers.UserAgentKey) { | ||
| r.Headers.Remove(headers.UserAgentKey) | ||
| } | ||
| r.Headers.Add(headers.UserAgentKey, userAgent) | ||
| } | ||
|
|
||
| // WithDefaultUserAgent sets the default User-Agent string for each request | ||
| func (r *Request) WithDefaultUserAgent() { | ||
| r.WithUserAgent(headers.UserAgentValue) | ||
| } | ||
|
|
||
| // WithAPIVersion sets the API version header for each request | ||
| func (r *Request) WithAPIVersion(version string) { | ||
| if r.Headers.ContainsKey(headers.APIVersionKey) { | ||
| r.Headers.Remove(headers.APIVersionKey) | ||
| } | ||
| r.Headers.Add(headers.APIVersionKey, version) | ||
| } | ||
|
|
||
| // WithDefaultAPIVersion sets the API version header to the default (the version used | ||
| // to generate the code) for each request | ||
| func (r *Request) WithDefaultAPIVersion() { | ||
| r.WithAPIVersion(headers.APIVersionValue) | ||
| } |
Oops, something went wrong.