api_client

Rust API client for openapi

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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: 2.0.0
• Package version: 2.0.0
• Generator version: 7.16.0
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:

openapi = { path = "./openapi" }

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AuthApi	check_system_auth	GET /api/auth/check	Check system auth
AuthApi	get_user	GET /api/user	Get user details
AuthApi	log_in	GET /api/login	Log in
ChallengeApi	extend_challenge	POST /api/challenges/{challenge_slug}/extend	Extend a challenge
ChallengeApi	get_challenge	GET /api/challenges/{challenge_slug}	Get challenge
ChallengeApi	start_challenge	POST /api/challenges/{challenge_slug}/start	Start a challenge
ChallengeApi	stop_challenge	POST /api/challenges/{challenge_slug}/stop	Stop a challenge
ChallengeApi	submit_flag	POST /api/challenges/{challenge_slug}/submit	Submit a flag
ChallengeApi	update_challenge	PUT /api/challenges/{challenge_slug}	Update challenge
CourseApi	get_course	GET /api/courses/{course_slug}	Get course
CourseApi	get_course_lesson	GET /api/courses/{course_slug}/lessons/{lesson_slug}	Get lesson
CourseApi	save_last	PUT /api/courses/{course_slug}/last	Save last viewed item
CourseApi	update_course	PUT /api/courses/{course_slug}	Update course
CourseApi	update_course_lesson	PUT /api/courses/{course_slug}/lessons/{lesson_slug}	Update lesson
CoursesApi	get_courses	GET /api/courses	Get all courses
OtherApi	get_health	GET /api/health	Check server health
SchemaApi	get_challenge_schema	GET /api/schema/challenge	Challenge schema
SchemaApi	get_contest_batch_schema	GET /api/schema/contest-batch	Batch schema
SchemaApi	get_contest_schema	GET /api/schema/contest	Contest schema
SchemaApi	get_course_schema	GET /api/schema/course	Course schema
SchemaApi	get_lesson_schema	GET /api/schema/lesson	Lesson schema
WebSocketApi	websocket	GET /api/ws	WebSocket

Documentation For Models

• AuthCheckSuccess
• Challenge
• ChallengeContainer
• ChallengeFlag
• ChallengeFlagMeta
• ChallengeFlagMetaOneOf
• ChallengeFlagMetaOneOf1
• ChallengeMetadata
• ChallengeSpec
• ChallengeSpecOneOf
• ChallengeSpecOneOf1
• ChallengeSpecOneOf2
• ConnectionHint
• ConnectionHintOneOf
• ConnectionHintOneOf1
• ConnectionHintOneOf2
• ConnectionHintOneOf3
• ConnectionHintOneOf4
• Course
• CourseDifficulty
• CourseItemType
• CourseMetadataCourseItemString
• CourseMetadataCourseItemStringItemsInner
• CourseMetadataCourseItemStringItemsInnerOneOf
• CourseMetadataCourseItemStringItemsInnerOneOf1
• CourseMetadataDetailedCourseItem
• CourseMetadataDetailedCourseItemItemsInner
• CourseMetadataDetailedCourseItemItemsInnerOneOf
• CourseMetadataDetailedCourseItemItemsInnerOneOf1
• CreateSuccess
• DetailedCourse
• DetailedCourseChallenge
• DetailedCourseLesson
• FlagSubmissionRequest
• FlagSubmissionResult
• GenericError
• KubernetesActionResult
• LastItem
• Lesson
• LessonMetadata
• NotFoundError
• UnauthorizedError
• UpdateChallengeRequest
• UpdateCourseRequest
• UpdateLessonRequest
• User

To get access to the crate's generated documentation, use:

cargo doc --open

Author