3.8 KiB
3.8 KiB
Rust API client for openapi
Browse and manage map submissions in the staging pipeline.
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: 0.1.0
- Package version: 0.1.0
- Generator version: 7.10.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 https://submissions.strafes.net/v1
Class | Method | HTTP request | Description |
---|---|---|---|
SubmissionsApi | action_submission_publish | PATCH /submissions/{SubmissionID}/status/publish | Role Validator changes status from Publishing -> Published |
SubmissionsApi | action_submission_reject | PATCH /submissions/{SubmissionID}/status/reject | Role Reviewer changes status from Submitted -> Rejected |
SubmissionsApi | action_submission_request_changes | PATCH /submissions/{SubmissionID}/status/request-changes | Role Reviewer changes status from Validated |
SubmissionsApi | action_submission_revoke | PATCH /submissions/{SubmissionID}/status/revoke | Role Submitter changes status from Submitted |
SubmissionsApi | action_submission_submit | PATCH /submissions/{SubmissionID}/status/submit | Role Submitter changes status from UnderConstruction |
SubmissionsApi | action_submission_trigger_publish | PATCH /submissions/{SubmissionID}/status/trigger-publish | Role Admin changes status from Validated -> Publishing |
SubmissionsApi | action_submission_trigger_validate | PATCH /submissions/{SubmissionID}/status/trigger-validate | Role Reviewer triggers validation and changes status from Submitted |
SubmissionsApi | action_submission_validate | PATCH /submissions/{SubmissionID}/status/validate | Role Validator changes status from Validating -> Validated |
SubmissionsApi | create_submission | POST /submissions | Create new submission |
SubmissionsApi | get_submission | GET /submissions/{SubmissionID} | Retrieve map with ID |
SubmissionsApi | list_submissions | GET /submissions | Get list of submissions |
SubmissionsApi | patch_submission_completed | PATCH /submissions/{SubmissionID}/completed | Retrieve map with ID |
SubmissionsApi | patch_submission_model | PATCH /submissions/{SubmissionID}/model | Update model following role restrictions |
Documentation For Models
To get access to the crate's generated documentation, use:
cargo doc --open