Shortcut API
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: 3.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/net/context
Put the package under your project folder and add the following in import:
import openapi "github.com/GIT_USER_ID/GIT_REPO_ID"
To use a proxy, set the environment variable HTTP_PROXY
:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
Default configuration comes with Servers
field that contains server objects as defined in the OpenAPI specification.
For using other server than the one defined on index 0 set context value sw.ContextServerIndex
of type int
.
ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)
Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables
of type map[string]string
.
ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
"basePath": "v2",
})
Note, enum values are always validated and all unused variables are silently ignored.
Each operation can use different server URL defined using OperationServers
map in the Configuration
.
An operation is uniquely identified by "{classname}Service.{nickname}"
string.
Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices
and sw.ContextOperationServerVariables
context maps.
ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
All URIs are relative to https://api.app.shortcut.com
Class | Method | HTTP request | Description |
---|---|---|---|
DefaultApi | CreateCategory | Post /api/v3/categories | Create Category |
DefaultApi | CreateEntityTemplate | Post /api/v3/entity-templates | Create Entity Template |
DefaultApi | CreateEpic | Post /api/v3/epics | Create Epic |
DefaultApi | CreateEpicComment | Post /api/v3/epics/{epic-public-id}/comments | Create Epic Comment |
DefaultApi | CreateEpicCommentComment | Post /api/v3/epics/{epic-public-id}/comments/{comment-public-id} | Create Epic Comment Comment |
DefaultApi | CreateGroup | Post /api/v3/groups | Create Group |
DefaultApi | CreateIteration | Post /api/v3/iterations | Create Iteration |
DefaultApi | CreateLabel | Post /api/v3/labels | Create Label |
DefaultApi | CreateLinkedFile | Post /api/v3/linked-files | Create Linked File |
DefaultApi | CreateMilestone | Post /api/v3/milestones | Create Milestone |
DefaultApi | CreateMultipleStories | Post /api/v3/stories/bulk | Create Multiple Stories |
DefaultApi | CreateProject | Post /api/v3/projects | Create Project |
DefaultApi | CreateStory | Post /api/v3/stories | Create Story |
DefaultApi | CreateStoryComment | Post /api/v3/stories/{story-public-id}/comments | Create Story Comment |
DefaultApi | CreateStoryLink | Post /api/v3/story-links | Create Story Link |
DefaultApi | CreateStoryReaction | Post /api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions | Create Story Reaction |
DefaultApi | CreateTask | Post /api/v3/stories/{story-public-id}/tasks | Create Task |
DefaultApi | DeleteCategory | Delete /api/v3/categories/{category-public-id} | Delete Category |
DefaultApi | DeleteCustomField | Delete /api/v3/custom-fields/{custom-field-public-id} | Delete Custom Field |
DefaultApi | DeleteEntityTemplate | Delete /api/v3/entity-templates/{entity-template-public-id} | Delete Entity Template |
DefaultApi | DeleteEpic | Delete /api/v3/epics/{epic-public-id} | Delete Epic |
DefaultApi | DeleteEpicComment | Delete /api/v3/epics/{epic-public-id}/comments/{comment-public-id} | Delete Epic Comment |
DefaultApi | DeleteFile | Delete /api/v3/files/{file-public-id} | Delete File |
DefaultApi | DeleteIteration | Delete /api/v3/iterations/{iteration-public-id} | Delete Iteration |
DefaultApi | DeleteLabel | Delete /api/v3/labels/{label-public-id} | Delete Label |
DefaultApi | DeleteLinkedFile | Delete /api/v3/linked-files/{linked-file-public-id} | Delete Linked File |
DefaultApi | DeleteMilestone | Delete /api/v3/milestones/{milestone-public-id} | Delete Milestone |
DefaultApi | DeleteMultipleStories | Delete /api/v3/stories/bulk | Delete Multiple Stories |
DefaultApi | DeleteProject | Delete /api/v3/projects/{project-public-id} | Delete Project |
DefaultApi | DeleteStory | Delete /api/v3/stories/{story-public-id} | Delete Story |
DefaultApi | DeleteStoryComment | Delete /api/v3/stories/{story-public-id}/comments/{comment-public-id} | Delete Story Comment |
DefaultApi | DeleteStoryLink | Delete /api/v3/story-links/{story-link-public-id} | Delete Story Link |
DefaultApi | DeleteStoryReaction | Delete /api/v3/stories/{story-public-id}/comments/{comment-public-id}/reactions | Delete Story Reaction |
DefaultApi | DeleteTask | Delete /api/v3/stories/{story-public-id}/tasks/{task-public-id} | Delete Task |
DefaultApi | DisableGroups | Put /api/v3/groups/disable | Disable Groups |
DefaultApi | DisableIterations | Put /api/v3/iterations/disable | Disable Iterations |
DefaultApi | DisableStoryTemplates | Put /api/v3/entity-templates/disable | Disable Story Templates |
DefaultApi | EnableGroups | Put /api/v3/groups/enable | Enable Groups |
DefaultApi | EnableIterations | Put /api/v3/iterations/enable | Enable Iterations |
DefaultApi | EnableStoryTemplates | Put /api/v3/entity-templates/enable | Enable Story Templates |
DefaultApi | GetCategory | Get /api/v3/categories/{category-public-id} | Get Category |
DefaultApi | GetCurrentMemberInfo | Get /api/v3/member | Get Current Member Info |
DefaultApi | GetCustomField | Get /api/v3/custom-fields/{custom-field-public-id} | Get Custom Field |
DefaultApi | GetEntityTemplate | Get /api/v3/entity-templates/{entity-template-public-id} | Get Entity Template |
DefaultApi | GetEpic | Get /api/v3/epics/{epic-public-id} | Get Epic |
DefaultApi | GetEpicComment | Get /api/v3/epics/{epic-public-id}/comments/{comment-public-id} | Get Epic Comment |
DefaultApi | GetEpicWorkflow | Get /api/v3/epic-workflow | Get Epic Workflow |
DefaultApi | GetExternalLinkStories | Get /api/v3/external-link/stories | Get External Link Stories |
DefaultApi | GetFile | Get /api/v3/files/{file-public-id} | Get File |
DefaultApi | GetGroup | Get /api/v3/groups/{group-public-id} | Get Group |
DefaultApi | GetIteration | Get /api/v3/iterations/{iteration-public-id} | Get Iteration |
DefaultApi | GetLabel | Get /api/v3/labels/{label-public-id} | Get Label |
DefaultApi | GetLinkedFile | Get /api/v3/linked-files/{linked-file-public-id} | Get Linked File |
DefaultApi | GetMember | Get /api/v3/members/{member-public-id} | Get Member |
DefaultApi | GetMilestone | Get /api/v3/milestones/{milestone-public-id} | Get Milestone |
DefaultApi | GetProject | Get /api/v3/projects/{project-public-id} | Get Project |
DefaultApi | GetRepository | Get /api/v3/repositories/{repo-public-id} | Get Repository |
DefaultApi | GetStory | Get /api/v3/stories/{story-public-id} | Get Story |
DefaultApi | GetStoryComment | Get /api/v3/stories/{story-public-id}/comments/{comment-public-id} | Get Story Comment |
DefaultApi | GetStoryLink | Get /api/v3/story-links/{story-link-public-id} | Get Story Link |
DefaultApi | GetTask | Get /api/v3/stories/{story-public-id}/tasks/{task-public-id} | Get Task |
DefaultApi | GetWorkflow | Get /api/v3/workflows/{workflow-public-id} | Get Workflow |
DefaultApi | ListCategories | Get /api/v3/categories | List Categories |
DefaultApi | ListCategoryMilestones | Get /api/v3/categories/{category-public-id}/milestones | List Category Milestones |
DefaultApi | ListCustomFields | Get /api/v3/custom-fields | List Custom Fields |
DefaultApi | ListEntityTemplates | Get /api/v3/entity-templates | List Entity Templates |
DefaultApi | ListEpicComments | Get /api/v3/epics/{epic-public-id}/comments | List Epic Comments |
DefaultApi | ListEpicStories | Get /api/v3/epics/{epic-public-id}/stories | List Epic Stories |
DefaultApi | ListEpics | Get /api/v3/epics | List Epics |
DefaultApi | ListFiles | Get /api/v3/files | List Files |
DefaultApi | ListGroupStories | Get /api/v3/groups/{group-public-id}/stories | List Group Stories |
DefaultApi | ListGroups | Get /api/v3/groups | List Groups |
DefaultApi | ListIterationStories | Get /api/v3/iterations/{iteration-public-id}/stories | List Iteration Stories |
DefaultApi | ListIterations | Get /api/v3/iterations | List Iterations |
DefaultApi | ListLabelEpics | Get /api/v3/labels/{label-public-id}/epics | List Label Epics |
DefaultApi | ListLabelStories | Get /api/v3/labels/{label-public-id}/stories | List Label Stories |
DefaultApi | ListLabels | Get /api/v3/labels | List Labels |
DefaultApi | ListLinkedFiles | Get /api/v3/linked-files | List Linked Files |
DefaultApi | ListMembers | Get /api/v3/members | List Members |
DefaultApi | ListMilestoneEpics | Get /api/v3/milestones/{milestone-public-id}/epics | List Milestone Epics |
DefaultApi | ListMilestones | Get /api/v3/milestones | List Milestones |
DefaultApi | ListProjects | Get /api/v3/projects | List Projects |
DefaultApi | ListRepositories | Get /api/v3/repositories | List Repositories |
DefaultApi | ListStories | Get /api/v3/projects/{project-public-id}/stories | List Stories |
DefaultApi | ListStoryComment | Get /api/v3/stories/{story-public-id}/comments | List Story Comment |
DefaultApi | ListWorkflows | Get /api/v3/workflows | List Workflows |
DefaultApi | Search | Get /api/v3/search | Search |
DefaultApi | SearchEpics | Get /api/v3/search/epics | Search Epics |
DefaultApi | SearchIterations | Get /api/v3/search/iterations | Search Iterations |
DefaultApi | SearchMilestones | Get /api/v3/search/milestones | Search Milestones |
DefaultApi | SearchStories | Get /api/v3/search/stories | Search Stories |
DefaultApi | SearchStoriesOld | Post /api/v3/stories/search | Search Stories (Old) |
DefaultApi | StoryHistory | Get /api/v3/stories/{story-public-id}/history | Story History |
DefaultApi | UnlinkProductboardFromEpic | Post /api/v3/epics/{epic-public-id}/unlink-productboard | Unlink Productboard from Epic |
DefaultApi | UpdateCategory | Put /api/v3/categories/{category-public-id} | Update Category |
DefaultApi | UpdateCustomField | Put /api/v3/custom-fields/{custom-field-public-id} | Update Custom Field |
DefaultApi | UpdateEntityTemplate | Put /api/v3/entity-templates/{entity-template-public-id} | Update Entity Template |
DefaultApi | UpdateEpic | Put /api/v3/epics/{epic-public-id} | Update Epic |
DefaultApi | UpdateEpicComment | Put /api/v3/epics/{epic-public-id}/comments/{comment-public-id} | Update Epic Comment |
DefaultApi | UpdateFile | Put /api/v3/files/{file-public-id} | Update File |
DefaultApi | UpdateGroup | Put /api/v3/groups/{group-public-id} | Update Group |
DefaultApi | UpdateIteration | Put /api/v3/iterations/{iteration-public-id} | Update Iteration |
DefaultApi | UpdateLabel | Put /api/v3/labels/{label-public-id} | Update Label |
DefaultApi | UpdateLinkedFile | Put /api/v3/linked-files/{linked-file-public-id} | Update Linked File |
DefaultApi | UpdateMilestone | Put /api/v3/milestones/{milestone-public-id} | Update Milestone |
DefaultApi | UpdateMultipleStories | Put /api/v3/stories/bulk | Update Multiple Stories |
DefaultApi | UpdateProject | Put /api/v3/projects/{project-public-id} | Update Project |
DefaultApi | UpdateStory | Put /api/v3/stories/{story-public-id} | Update Story |
DefaultApi | UpdateStoryComment | Put /api/v3/stories/{story-public-id}/comments/{comment-public-id} | Update Story Comment |
DefaultApi | UpdateStoryLink | Put /api/v3/story-links/{story-link-public-id} | Update Story Link |
DefaultApi | UpdateTask | Put /api/v3/stories/{story-public-id}/tasks/{task-public-id} | Update Task |
DefaultApi | UploadFiles | Post /api/v3/files | Upload Files |
- BasicWorkspaceInfo
- Branch
- Category
- Commit
- CreateCategory
- CreateCategoryParams
- CreateCommentComment
- CreateEntityTemplate
- CreateEpic
- CreateEpicComment
- CreateGroup
- CreateIteration
- CreateLabelParams
- CreateLinkedFile
- CreateMilestone
- CreateOrDeleteStoryReaction
- CreateProject
- CreateStories
- CreateStoryComment
- CreateStoryCommentParams
- CreateStoryContents
- CreateStoryLink
- CreateStoryLinkParams
- CreateStoryParams
- CreateTask
- CreateTaskParams
- CustomField
- CustomFieldEnumValue
- CustomFieldValueParams
- DataConflictError
- DeleteStories
- EntityTemplate
- EntityTemplateTask
- Epic
- EpicAssociatedGroup
- EpicSearchResult
- EpicSearchResults
- EpicSlim
- EpicState
- EpicStats
- EpicWorkflow
- GetEpicStories
- GetExternalLinkStoriesParams
- GetIterationStories
- GetLabelStories
- GetMember
- GetProjectStories
- Group
- History
- HistoryActionBranchCreate
- HistoryActionBranchMerge
- HistoryActionBranchPush
- HistoryActionLabelCreate
- HistoryActionLabelDelete
- HistoryActionLabelUpdate
- HistoryActionProjectUpdate
- HistoryActionPullRequest
- HistoryActionStoryCommentCreate
- HistoryActionStoryCreate
- HistoryActionStoryDelete
- HistoryActionStoryLinkCreate
- HistoryActionStoryLinkDelete
- HistoryActionStoryLinkUpdate
- HistoryActionStoryUpdate
- HistoryActionTaskCreate
- HistoryActionTaskDelete
- HistoryActionTaskUpdate
- HistoryActionWorkspace2BulkUpdate
- HistoryChangesStory
- HistoryChangesStoryLink
- HistoryChangesTask
- HistoryReferenceBranch
- HistoryReferenceCommit
- HistoryReferenceCustomFieldEnumValue
- HistoryReferenceEpic
- HistoryReferenceGeneral
- HistoryReferenceGroup
- HistoryReferenceIteration
- HistoryReferenceLabel
- HistoryReferenceProject
- HistoryReferenceStory
- HistoryReferenceStoryTask
- HistoryReferenceWorkflowState
- Icon
- Identity
- Iteration
- IterationAssociatedGroup
- IterationSearchResults
- IterationSlim
- IterationStats
- Label
- LabelSlim
- LabelStats
- LinkedFile
- ListEpics
- ListGroupStories
- ListLabels
- ListMembers
- MaxSearchResultsExceededError
- Member
- MemberInfo
- Milestone
- MilestoneSearchResult
- MilestoneSearchResults
- MilestoneStats
- Profile
- Project
- ProjectStats
- PullRequest
- PullRequestLabel
- Repository
- Search
- SearchResults
- SearchStories
- Story
- StoryComment
- StoryContents
- StoryContentsTask
- StoryCustomField
- StoryHistoryChangeAddsRemovesInt
- StoryHistoryChangeAddsRemovesUuid
- StoryHistoryChangeOldNewBool
- StoryHistoryChangeOldNewInt
- StoryHistoryChangeOldNewStr
- StoryHistoryChangeOldNewUuid
- StoryLink
- StoryReaction
- StorySearchResult
- StorySearchResults
- StorySlim
- StoryStats
- SyncedItem
- Task
- ThreadedComment
- TypedStoryLink
- UnusableEntitlementError
- UpdateCategory
- UpdateComment
- UpdateCustomField
- UpdateCustomFieldEnumValue
- UpdateEntityTemplate
- UpdateEpic
- UpdateFile
- UpdateGroup
- UpdateIteration
- UpdateLabel
- UpdateLinkedFile
- UpdateMilestone
- UpdateProject
- UpdateStories
- UpdateStory
- UpdateStoryComment
- UpdateStoryContents
- UpdateStoryLink
- UpdateTask
- UploadedFile
- Workflow
- WorkflowState
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: Shortcut-Token
- Location: HTTP header
Note, each API key must be added to a map of map[string]APIKey
where the key is: Shortcut-Token and passed in as the auth context for each request.
Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:
PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime