Go API client for codioapi

Documentation APIs v1.0

Overview

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: 1.0
• Package version: 1.0.0
• Generator version: 7.18.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

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 codioapi "github.com/codio/codio-api-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value codioapi.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), codioapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value codioapi.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), codioapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

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 codioapi.ContextOperationServerIndices and codioapi.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), codioapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), codioapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://octopus.codio.com

Class	Method	HTTP request	Description
AssessmentLibrariesAPIAPI	AssessmentLibraryCreateAssessment	Post /api/v1/assessment_library/{libraryId}/assessment	Create assessment
AssessmentLibrariesAPIAPI	AssessmentLibraryGetAssessment	Get /api/v1/assessment_library/{libraryId}/assessment/{id}	Get assessment
AssessmentLibrariesAPIAPI	AssessmentLibrarySearch	Get /api/v1/assessment_library/{libraryId}/assessment	Search assessments
AssessmentLibrariesAPIAPI	AssessmentLibraryUpdateAssessment	Put /api/v1/assessment_library/{libraryId}/assessment/{id}	Update assessment
AssessmentLibrariesAPIAPI	ListLibraries	Get /api/v1/assessment_library	List assessment libraries
CourseAPIAPI	ArchiveCourse	Post /api/v1/courses/{courseId}/archive	Archive Course
CourseAPIAPI	CourseStructure	Get /api/v1/courses/{courseId}	Fetch Course Structure
CourseAPIAPI	CoursesList	Get /api/v1/courses_list	List Organization Courses
CourseAPIAPI	CreateCourse	Post /api/v1/courses	Create Course
CourseAPIAPI	CreateCourseModule	Post /api/v1/courses/{courseId}/modules	Create Course Module
CourseAPIAPI	FilterLearnersForMentors	Post /api/v1/courses/{courseId}/filterLearnersForMentors	Filter Learners For Mentors
CourseAPIAPI	FindCourse	Get /api/v1/courses	Find Course
CourseAPIAPI	ListCourseStudents	Get /api/v1/courses/{courseId}/students	List Course Students
CourseAPIAPI	ListCourseTeachers	Get /api/v1/courses/{courseId}/teachers	List Course Teachers
CourseAPIAPI	StudentCourseProgress	Get /api/v1/courses/{courseId}/students/{studentId}/progress	Fetch Course Structure
CourseAPIAPI	UpdateBooks	Post /api/v1/courses/{courseId}/update_books	Update Course Books
CourseAssignmentsAPIAPI	AssignmentStudentsInfo	Get /api/v1/courses/{courseId}/assignments/{assignmentId}/students	Get assignment students info
CourseAssignmentsAPIAPI	AssignmentVersionPublish	Post /api/v1/courses/{courseId}/assignments/{assignmentId}/versions	Publish new assignment version
CourseAssignmentsAPIAPI	AssignmentVersionPublishesStatus	Get /api/v1/courses/{courseId}/assignments/{assignmentId}/publishes/{taskId}	Get assignment publish status
CourseAssignmentsAPIAPI	CreateProjectBasedAssignment	Post /api/v1/courses/{courseId}/assignments	Create Project Based Assignment
CourseAssignmentsAPIAPI	FetchAssignmentSettings	Get /api/v1/courses/{courseId}/assignments/{assignmentId}/settings	Fetch Assignment Settings
CourseAssignmentsAPIAPI	UpdateAssignmentSettings	Post /api/v1/courses/{courseId}/assignments/{assignmentId}/settings	Update Assignment Settings
CourseAssignmentsAPIAPI	UpdateStudentTimeExtensions	Post /api/v1/courses/{courseId}/assignments/{assignmentId}/students/{studentId}	Update Student Time Extensions
CourseBooksAPIAPI	BookVersionPublish	Post /api/v1/books/{bookId}/versions	Publish new book version
CourseBooksAPIAPI	BookVersionPublishesStatus	Get /api/v1/books/{bookId}/publishes/{taskId}	Get book publish status
CourseExportsAPIAPI	ExportAssessmentData	Get /api/v1/courses/{courseId}/export/assessments/csv	Export Assessment Data CSV
CourseExportsAPIAPI	ExportAssignmentCSV	Get /api/v1/courses/{courseId}/assignments/{assignmentId}/export/csv	Export Assignment CSV
CourseExportsAPIAPI	ExportCoachData	Post /api/v1/courses/{courseId}/export/coach	Export Coach Data
CourseExportsAPIAPI	ExportCoachDataByTask	Get /api/v1/courses/{courseId}/export/coach/progress/{taskId}	Fetch Export Coach Data Status
CourseExportsAPIAPI	ExportCourseSourceDataItemByTask	Get /api/v1/courses/{courseId}/export/sources/progress/{taskId}	Fetch Export Sources Status
CourseExportsAPIAPI	ExportCourseSourceDataItems	Get /api/v1/courses/{courseId}/export/sources	List Exports Course Sources Data
CourseExportsAPIAPI	ExportCourseSourcesData	Post /api/v1/courses/{courseId}/export/sources	Export Course Sources
CourseExportsAPIAPI	ExportCourseWorkData	Post /api/v1/courses/{courseId}/export/workdata	Export Course Work Data
CourseExportsAPIAPI	ExportCourseWorkDataItemByTask	Get /api/v1/courses/{courseId}/export/workdata/progress/{taskId}	Fetch Export Work Data Status
CourseExportsAPIAPI	ExportCourseWorkDataItems	Get /api/v1/courses/{courseId}/export/workdata	List Exports Course Work Data
CourseExportsAPIAPI	ExportLLMProxyData	Post /api/v1/courses/{courseId}/export/llmproxy	Export LLMProxy Data
CourseExportsAPIAPI	ExportLLMProxyDataByTaskRoute	Get /api/v1/courses/{courseId}/export/llmproxy/progress/{taskId}	Fetch Export LLMProxy Data Status
CourseExportsAPIAPI	ExportStudentCSV	Get /api/v1/courses/{courseId}/students/{studentId}/export/csv	Export Student CSV
CourseExportsAPIAPI	FetchDownloadStatus	Get /api/v1/courses/{courseId}/export/assessments/csv/download/{taskId}	Fetch Export Assessment Data CSV Status
CourseExportsAPIAPI	FetchDownloadStatusStudent	Get /api/v1/courses/{courseId}/assignments/{assignmentId}/students/{studentId}/download/{taskId}	Fetch Export Student Data CSV Status
CourseExportsAPIAPI	StartedAssignmentDownload	Get /api/v1/courses/{courseId}/assignments/{assignmentId}/students/{studentId}/download	Fetch Export Assessment Data CSV Status
CourseMembersAPIAPI	AddTeacher	Post /api/v1/courses/{courseId}/teachers	Add teacher to course
EventsAPIAPI	EventList	Get /api/v1/events	List Webhook Events
StackAPIAPI	StackInfo	Get /api/v1/stacks/{stackId}	Get stack information
StackAPIAPI	StackVersionsPublish	Post /api/v1/stacks/{stackId}/versions	Publish new stack version
StackAPIAPI	StackVersionsPublishStatus	Get /api/v1/stacks/{stackId}/tasks/{taskId}	Get stack version publish information

Documentation For Models

• AddTeacherToCourse
• AddTeacherToCourseAnswer
• ArchiveCourse
• Assignment
• AssignmentProgress
• AssignmentProgressItem
• AssignmentSettings
• AssignmentSettingsResult
• Course
• CreateAssignment
• CreateAssignmentAnswer
• CreateAssignmentSettings
• CreateCourse
• CreateCourseAnswer
• CreateCourseModule
• CreateCourseModuleAnswer
• DownloadStatus
• EventsList
• ExamMode
• FilterLearnersForMentorsAnswerExample
• GigaBoxSlot
• ListCourses
• Module
• PenaltySettings
• RestrictedIPRange
• SocrateAnswerExample
• SocrateTagSearchExample
• SocratesLibrary
• StackInfo
• StackPublishInfo
• StackVersionInfo
• StudentInformation
• StudentTimeExtension
• TaskProgress
• TaskStatus
• TimedExamMode
• User

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), codioapi.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

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

Author