65 lines
3.8 KiB
Markdown
65 lines
3.8 KiB
Markdown
|
# Rust API client for openapi
|
||
|
|
|
||
|
|
Browse and manage map submissions in the staging pipeline.
|
||
|
|
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) 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**](docs/SubmissionsApi.md#action_submission_publish) | **PATCH** /submissions/{SubmissionID}/status/publish | Role Validator changes status from Publishing -> Published
|
||
|
|
*SubmissionsApi* | [**action_submission_reject**](docs/SubmissionsApi.md#action_submission_reject) | **PATCH** /submissions/{SubmissionID}/status/reject | Role Reviewer changes status from Submitted -> Rejected
|
||
|
|
*SubmissionsApi* | [**action_submission_request_changes**](docs/SubmissionsApi.md#action_submission_request_changes) | **PATCH** /submissions/{SubmissionID}/status/request-changes | Role Reviewer changes status from Validated|Accepted|Submitted -> ChangesRequested
|
||
|
|
*SubmissionsApi* | [**action_submission_revoke**](docs/SubmissionsApi.md#action_submission_revoke) | **PATCH** /submissions/{SubmissionID}/status/revoke | Role Submitter changes status from Submitted|ChangesRequested -> UnderConstruction
|
||
|
|
*SubmissionsApi* | [**action_submission_submit**](docs/SubmissionsApi.md#action_submission_submit) | **PATCH** /submissions/{SubmissionID}/status/submit | Role Submitter changes status from UnderConstruction|ChangesRequested -> Submitted
|
||
|
|
*SubmissionsApi* | [**action_submission_trigger_publish**](docs/SubmissionsApi.md#action_submission_trigger_publish) | **PATCH** /submissions/{SubmissionID}/status/trigger-publish | Role Admin changes status from Validated -> Publishing
|
||
|
|
*SubmissionsApi* | [**action_submission_trigger_validate**](docs/SubmissionsApi.md#action_submission_trigger_validate) | **PATCH** /submissions/{SubmissionID}/status/trigger-validate | Role Reviewer triggers validation and changes status from Submitted|Accepted -> Validating
|
||
|
|
*SubmissionsApi* | [**action_submission_validate**](docs/SubmissionsApi.md#action_submission_validate) | **PATCH** /submissions/{SubmissionID}/status/validate | Role Validator changes status from Validating -> Validated
|
||
|
|
*SubmissionsApi* | [**create_submission**](docs/SubmissionsApi.md#create_submission) | **POST** /submissions | Create new submission
|
||
|
|
*SubmissionsApi* | [**get_submission**](docs/SubmissionsApi.md#get_submission) | **GET** /submissions/{SubmissionID} | Retrieve map with ID
|
||
|
|
*SubmissionsApi* | [**list_submissions**](docs/SubmissionsApi.md#list_submissions) | **GET** /submissions | Get list of submissions
|
||
|
|
*SubmissionsApi* | [**patch_submission_completed**](docs/SubmissionsApi.md#patch_submission_completed) | **PATCH** /submissions/{SubmissionID}/completed | Retrieve map with ID
|
||
|
|
*SubmissionsApi* | [**patch_submission_model**](docs/SubmissionsApi.md#patch_submission_model) | **PATCH** /submissions/{SubmissionID}/model | Update model following role restrictions
|
||
|
|
|
||
|
|
|
||
|
|
## Documentation For Models
|
||
|
|
|
||
|
|
- [Error](docs/Error.md)
|
||
|
|
- [Id](docs/Id.md)
|
||
|
|
- [Pagination](docs/Pagination.md)
|
||
|
|
- [Submission](docs/Submission.md)
|
||
|
|
- [SubmissionCreate](docs/SubmissionCreate.md)
|
||
|
|
- [SubmissionFilter](docs/SubmissionFilter.md)
|
||
|
|
- [User](docs/User.md)
|
||
|
|
|
||
|
|
|
||
|
|
To get access to the crate's generated documentation, use:
|
||
|
|
|
||
|
|
```
|
||
|
|
cargo doc --open
|
||
|
|
```
|
||
|
|
|
||
|
|
## Author
|
||
|
|
|
||
|
|
|
||
|
|
|