This describes the resources that make up the CircleCI API v2. API v2 is currently in Preview. Additional documentation for this API can be found in the API Preview Docs. Breaking changes to the API will be announced in the Breaking Changes log.
$ docker run -v ${PWD}:/local \
openapitools/openapi-generator-cli:v4.2.3 \
generate \
--invoker-package github.com/suzuki-shunsuke/go-circleci-v2-openapi-client \
--package-name circleci \
-i https://circleci.com/api/v2/openapi.yml \
-g go \
--git-user-id suzuki-shunsuke \
--git-repo-id go-circleci-v2-openapi-client \
-o /local
Unfortunately, it is failed to compile generated code, so we fix the bug manually.
$ go vet ./...
vet: ./api_preview.go:1409:6: GetProjectWorkflowMetricsOpts redeclared in this block
$ go vet ./...
vet: ./api_preview.go:1530:6: GetProjectWorkflowRunsOpts redeclared in this block
$ go vet ./...
vet: ./api_project.go:30:6: CreateCheckoutKeyOpts redeclared in this block
$ go vet ./...
vet: ./api_project.go:153:6: CreateEnvVarOpts redeclared in this block
Please let us know if you find the cause of this bug.
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: v2
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
Please see examples.
All URIs are relative to https://circleci.com/api/v2
| Class | Method | HTTP request | Description |
|---|---|---|---|
| InsightsApi | GetProjectWorkflowMetrics | Get /insights/{project-slug}/workflows | Get summary metrics for a project's workflows |
| InsightsApi | GetProjectWorkflowRuns | Get /insights/{project-slug}/workflows/{workflow-name} | Get recent runs of a workflow |
| JobApi | CancelJob | Post /project/{project-slug}/job/{job-number}/cancel | Cancel job |
| JobApi | GetJobArtifacts | Get /project/{project-slug}/{job-number}/artifacts | Get a job's artifacts |
| JobApi | GetJobDetails | Get /project/{project-slug}/job/{job-number} | Get job details |
| JobApi | GetTests | Get /project/{project-slug}/{job-number}/tests | Get test metadata |
| PipelineApi | GetPipelineById | Get /pipeline/{pipeline-id} | Get a pipeline |
| PipelineApi | GetPipelineByNumber | Get /project/{project-slug}/pipeline/{pipeline-number} | Get a pipeline |
| PipelineApi | GetPipelineConfigById | Get /pipeline/{pipeline-id}/config | Get a pipeline's configuration |
| PipelineApi | ListMyPipelines | Get /project/{project-slug}/pipeline/mine | Get your pipelines |
| PipelineApi | ListPipelinesForProject | Get /project/{project-slug}/pipeline | Get all pipelines |
| PipelineApi | ListWorkflowsByPipelineId | Get /pipeline/{pipeline-id}/workflow | Get a pipeline's workflows |
| PipelineApi | TriggerPipeline | Post /project/{project-slug}/pipeline | Trigger a new pipeline |
| PreviewApi | CancelJob | Post /project/{project-slug}/job/{job-number}/cancel | Cancel job |
| PreviewApi | CreateCheckoutKey | Post /project/{project-slug}/checkout-key | Create a new checkout key |
| PreviewApi | CreateEnvVar | Post /project/{project-slug}/envvar | Create an environment variable |
| PreviewApi | DeleteCheckoutKey | Delete /project/{project-slug}/checkout-key/{fingerprint} | Delete a checkout key |
| PreviewApi | DeleteEnvVar | Delete /project/{project-slug}/envvar/{name} | Delete an environment variable |
| PreviewApi | GetCheckoutKey | Get /project/{project-slug}/checkout-key/{fingerprint} | Get a checkout key |
| PreviewApi | GetCollaborations | Get /me/collaborations | Collaborations |
| PreviewApi | GetCurrentUser | Get /me | User Information |
| PreviewApi | GetEnvVar | Get /project/{project-slug}/envvar/{name} | Get a masked environment variable |
| PreviewApi | GetJobArtifacts | Get /project/{project-slug}/{job-number}/artifacts | Get a job's artifacts |
| PreviewApi | GetJobDetails | Get /project/{project-slug}/job/{job-number} | Get job details |
| PreviewApi | GetProjectBySlug | Get /project/{project-slug} | Get a project |
| PreviewApi | GetProjectWorkflowMetrics | Get /insights/{project-slug}/workflows | Get summary metrics for a project's workflows |
| PreviewApi | GetProjectWorkflowRuns | Get /insights/{project-slug}/workflows/{workflow-name} | Get recent runs of a workflow |
| PreviewApi | GetTests | Get /project/{project-slug}/{job-number}/tests | Get test metadata |
| PreviewApi | GetUser | Get /user/{id} | User Information |
| PreviewApi | ListCheckoutKeys | Get /project/{project-slug}/checkout-key | Get all checkout keys |
| PreviewApi | ListEnvVars | Get /project/{project-slug}/envvar | List all environment variables |
| ProjectApi | CreateCheckoutKey | Post /project/{project-slug}/checkout-key | Create a new checkout key |
| ProjectApi | CreateEnvVar | Post /project/{project-slug}/envvar | Create an environment variable |
| ProjectApi | DeleteCheckoutKey | Delete /project/{project-slug}/checkout-key/{fingerprint} | Delete a checkout key |
| ProjectApi | DeleteEnvVar | Delete /project/{project-slug}/envvar/{name} | Delete an environment variable |
| ProjectApi | GetCheckoutKey | Get /project/{project-slug}/checkout-key/{fingerprint} | Get a checkout key |
| ProjectApi | GetEnvVar | Get /project/{project-slug}/envvar/{name} | Get a masked environment variable |
| ProjectApi | GetProjectBySlug | Get /project/{project-slug} | Get a project |
| ProjectApi | ListCheckoutKeys | Get /project/{project-slug}/checkout-key | Get all checkout keys |
| ProjectApi | ListEnvVars | Get /project/{project-slug}/envvar | List all environment variables |
| UserApi | GetCollaborations | Get /me/collaborations | Collaborations |
| UserApi | GetCurrentUser | Get /me | User Information |
| UserApi | GetUser | Get /user/{id} | User Information |
| WorkflowApi | CancelWorkflow | Post /workflow/{id}/cancel | Cancel a workflow |
| WorkflowApi | GetWorkflowById | Get /workflow/{id} | Get a workflow |
| WorkflowApi | ListWorkflowJobs | Get /workflow/{id}/job | Get a workflow's jobs |
| WorkflowApi | RerunWorkflow | Post /workflow/{id}/rerun | Rerun a workflow |
- Artifact
- ArtifactListResponse
- CheckoutKey
- CheckoutKeyInput
- CheckoutKeyListResponse
- Collaboration
- EnvironmentVariableListResponse
- EnvironmentVariablePair
- EnvironmentVariablePair1
- InlineResponse200
- InlineResponse2001
- InlineResponse2001Items
- InlineResponse200Items
- InlineResponse200Metrics
- InlineResponse200MetricsDurationMetrics
- Job
- JobDetails
- JobDetailsContexts
- JobDetailsExecutor
- JobDetailsLatestWorkflow
- JobDetailsMessages
- JobDetailsOrganization
- JobDetailsParallelRuns
- JobDetailsPipeline
- JobDetailsProject
- MessageResponse
- Pipeline
- PipelineConfig
- PipelineErrors
- PipelineLight
- PipelineListResponse
- PipelineTrigger
- PipelineTriggerActor
- PipelineVcs
- PipelineVcsCommit
- Project
- ProjectVcsInfo
- RerunWorkflowParameters
- TestsResponse
- TestsResponseItems
- TriggerPipelineParameters
- User
- Workflow
- WorkflowJobListResponse
- WorkflowListResponse
About the license of code generated by OpenAPI Generator, please see the document of OpenAPI Generator.