Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ You can solve this by implementing it manually, like this:

```rust
use rocket_okapi::request::{OpenApiFromRequest, RequestHeaderInput};
use rocket_okapi::gen::OpenApiGenerator;
use rocket_okapi::generator::OpenApiGenerator;
use rocket_sync_db_pools::{diesel, database};

#[database("sqlite_logs")]
Expand Down
2 changes: 1 addition & 1 deletion examples/custom_schema/src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use rocket::{
};
use rocket_okapi::okapi::openapi3::Responses;
use rocket_okapi::okapi::schemars::{self, Map};
use rocket_okapi::{gen::OpenApiGenerator, response::OpenApiResponderInner, OpenApiError};
use rocket_okapi::{generator::OpenApiGenerator, response::OpenApiResponderInner, OpenApiError};

/// Error messages returned to user
#[derive(Debug, serde::Serialize, schemars::JsonSchema)]
Expand Down
2 changes: 1 addition & 1 deletion examples/nested/src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use rocket::{
};
use rocket_okapi::okapi::openapi3::Responses;
use rocket_okapi::okapi::schemars::{self, Map};
use rocket_okapi::{gen::OpenApiGenerator, response::OpenApiResponderInner, OpenApiError};
use rocket_okapi::{generator::OpenApiGenerator, response::OpenApiResponderInner, OpenApiError};

/// Error messages returned to user
#[derive(Debug, serde::Serialize, schemars::JsonSchema)]
Expand Down
2 changes: 1 addition & 1 deletion examples/secure_request_guard/src/api_key.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ use rocket_okapi::okapi::openapi3::{
Object, Responses, SecurityRequirement, SecurityScheme, SecuritySchemeData,
};
use rocket_okapi::{
gen::OpenApiGenerator,
generator::OpenApiGenerator,
openapi,
request::{OpenApiFromRequest, RequestHeaderInput},
};
Expand Down
2 changes: 1 addition & 1 deletion examples/secure_request_guard/src/cookies.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use rocket::{
};
use rocket_okapi::okapi::openapi3::{Object, Parameter, ParameterValue};
use rocket_okapi::{
gen::OpenApiGenerator,
generator::OpenApiGenerator,
openapi,
request::{OpenApiFromRequest, RequestHeaderInput},
};
Expand Down
2 changes: 1 addition & 1 deletion examples/secure_request_guard/src/http_auth.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ use rocket_okapi::okapi::openapi3::{
Object, SecurityRequirement, SecurityScheme, SecuritySchemeData,
};
use rocket_okapi::{
gen::OpenApiGenerator,
generator::OpenApiGenerator,
openapi,
request::{OpenApiFromRequest, RequestHeaderInput},
};
Expand Down
2 changes: 1 addition & 1 deletion examples/secure_request_guard/src/main.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use rocket::config::Config;
use rocket::Request;
use rocket::{catch, catchers, response, response::Responder, Response};
use rocket_okapi::gen::OpenApiGenerator;
use rocket_okapi::generator::OpenApiGenerator;
use rocket_okapi::okapi;
use rocket_okapi::okapi::openapi3::{MediaType, Responses};
use rocket_okapi::okapi::schemars;
Expand Down
2 changes: 1 addition & 1 deletion examples/secure_request_guard/src/oauth2.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ use rocket_okapi::okapi::openapi3::{
OAuthFlows, Object, SecurityRequirement, SecurityScheme, SecuritySchemeData,
};
use rocket_okapi::{
gen::OpenApiGenerator,
generator::OpenApiGenerator,
openapi,
request::{OpenApiFromRequest, RequestHeaderInput},
};
Expand Down
2 changes: 1 addition & 1 deletion examples/secure_request_guard/src/open_id.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use rocket_okapi::okapi::openapi3::{
Object, SecurityRequirement, SecurityScheme, SecuritySchemeData,
};
use rocket_okapi::{
gen::OpenApiGenerator,
generator::OpenApiGenerator,
openapi,
request::{OpenApiFromRequest, RequestHeaderInput},
};
Expand Down
1 change: 1 addition & 0 deletions okapi/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ This project follows the [Semantic Versioning standard](https://semver.org/).
### Added

### Changed
- Changed usages of the `gen` module to `generator` for Edition 2025 compatibility

### Deprecated

Expand Down
4 changes: 2 additions & 2 deletions rocket-okapi-codegen/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ pub fn openapi_spec(input: TokenStream) -> TokenStream {
/// This code is equivalent to:
/// ```rust,ignore
/// use rocket_okapi::request::{OpenApiFromRequest, RequestHeaderInput};
/// use rocket_okapi::gen::OpenApiGenerator;
/// use rocket_okapi::generator::OpenApiGenerator;
///
/// pub struct MyStructName;
///
Expand All @@ -125,7 +125,7 @@ pub fn open_api_from_request_derive(input: TokenStream) -> TokenStream {
let gen = quote! {
impl<'r> rocket_okapi::request::OpenApiFromRequest<'r> for #name {
fn from_request_input(
_gen: &mut rocket_okapi::gen::OpenApiGenerator,
_gen: &mut rocket_okapi::generator::OpenApiGenerator,
_name: String,
_required: bool,
) -> rocket_okapi::Result<rocket_okapi::request::RequestHeaderInput> {
Expand Down
4 changes: 2 additions & 2 deletions rocket-okapi-codegen/src/openapi_attr/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ fn create_empty_route_operation_fn(route_fn: ItemFn) -> TokenStream {
TokenStream::from(quote! {
#[doc(hidden)]
pub fn #fn_name(
_gen: &mut ::rocket_okapi::gen::OpenApiGenerator,
_gen: &mut ::rocket_okapi::generator::OpenApiGenerator,
_op_id: String,
) -> ::rocket_okapi::Result<()> {
Ok(())
Expand Down Expand Up @@ -323,7 +323,7 @@ fn create_route_operation_fn(
TokenStream::from(quote! {
#[doc(hidden)]
pub fn #fn_name(
gen: &mut ::rocket_okapi::gen::OpenApiGenerator,
gen: &mut ::rocket_okapi::generator::OpenApiGenerator,
operation_id: String,
) -> ::rocket_okapi::Result<()> {
let mut responses = <#return_type as ::rocket_okapi::response::OpenApiResponder>::responses(gen)?;
Expand Down
2 changes: 1 addition & 1 deletion rocket-okapi-codegen/src/openapi_spec.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ pub fn create_openapi_spec(routes: TokenStream) -> Result<TokenStream2> {
let add_operations = create_add_operations(paths);
Ok(quote! {
|settings: &::rocket_okapi::settings::OpenApiSettings| -> ::rocket_okapi::okapi::openapi3::OpenApi {
let mut gen = ::rocket_okapi::gen::OpenApiGenerator::new(settings);
let mut gen = ::rocket_okapi::generator::OpenApiGenerator::new(settings);
#add_operations
let mut spec = gen.into_openapi();
let mut info = ::rocket_okapi::okapi::openapi3::Info {
Expand Down
1 change: 1 addition & 0 deletions rocket-okapi/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ This project follows the [Semantic Versioning standard](https://semver.org/).
### Added

### Changed
- Renamed `gen` module to `generator` for Edition 2025 compatibility

### Deprecated

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion rocket-okapi/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ mod error;

/// Contains the `Generator` struct, which you can use to manually control the way a struct is
/// represented in the documentation.
pub mod gen;
pub mod generator;
/// Contains several `Rocket` `Handler`s, which are used for serving the json files and the swagger
/// interface.
pub mod handlers;
Expand Down
2 changes: 1 addition & 1 deletion rocket-okapi/src/request/from_data_impls.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
use super::OpenApiFromData;
use crate::gen::OpenApiGenerator;
use crate::generator::OpenApiGenerator;
use okapi::{
openapi3::{MediaType, RequestBody},
Map,
Expand Down
2 changes: 1 addition & 1 deletion rocket-okapi/src/request/from_form_multi_param_impls.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use crate::gen::OpenApiGenerator;
use crate::generator::OpenApiGenerator;
use okapi::openapi3::{Object, Parameter, ParameterValue};
use schemars::schema::{InstanceType, Schema, SchemaObject, SingleOrVec};
use schemars::JsonSchema;
Expand Down
2 changes: 1 addition & 1 deletion rocket-okapi/src/request/from_form_param_impls.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
//! <https://docs.rs/rocket/latest/rocket/form/trait.FromForm.html#foreign-impls>

use super::{get_nested_form_parameters, OpenApiFromForm, OpenApiFromFormField};
use crate::gen::OpenApiGenerator;
use crate::generator::OpenApiGenerator;
use okapi::openapi3::{Object, Parameter, ParameterValue};
use schemars::JsonSchema;

Expand Down
2 changes: 1 addition & 1 deletion rocket-okapi/src/request/from_param_impls.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
//! <https://docs.rs/rocket/latest/rocket/request/trait.FromParam.html#foreign-impls>

use super::OpenApiFromParam;
use crate::gen::OpenApiGenerator;
use crate::generator::OpenApiGenerator;
use okapi::openapi3::{Object, Parameter, ParameterValue};
use schemars::JsonSchema;

Expand Down
2 changes: 1 addition & 1 deletion rocket-okapi/src/request/from_request_impls.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
use super::{OpenApiFromRequest, RequestHeaderInput};
use crate::gen::OpenApiGenerator;
use crate::generator::OpenApiGenerator;
use okapi::openapi3::*;
use std::result::Result as StdResult;

Expand Down
2 changes: 1 addition & 1 deletion rocket-okapi/src/request/from_segments_impls.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
//! <https://docs.rs/rocket/latest/rocket/request/trait.FromSegments.html#foreign-impls>

use super::OpenApiFromSegments;
use crate::gen::OpenApiGenerator;
use crate::generator::OpenApiGenerator;
use okapi::openapi3::{Object, Parameter, ParameterValue};
use schemars::JsonSchema;

Expand Down
2 changes: 1 addition & 1 deletion rocket-okapi/src/request/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ mod from_param_impls;
mod from_request_impls;
mod from_segments_impls;

use super::gen::OpenApiGenerator;
use super::generator::OpenApiGenerator;
use super::Result;
use okapi::openapi3::{Parameter, RequestBody, Responses, SecurityRequirement, SecurityScheme};

Expand Down
2 changes: 1 addition & 1 deletion rocket-okapi/src/response/mod.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
mod responder_impls;

use super::gen::OpenApiGenerator;
use super::generator::OpenApiGenerator;
use super::Result;
use okapi::openapi3::Responses;

Expand Down
2 changes: 1 addition & 1 deletion rocket-okapi/src/response/responder_impls.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use super::OpenApiResponderInner;
use crate::{
gen::OpenApiGenerator,
generator::OpenApiGenerator,
util::{
add_default_response_code, add_schema_response, change_all_responses_to_default,
ensure_status_code_exists, produce_any_responses, set_content_type, set_status_code,
Expand Down
2 changes: 1 addition & 1 deletion rocket-okapi/tests/db_pool.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
//! This test should just compile.

use rocket_okapi::gen::OpenApiGenerator;
use rocket_okapi::generator::OpenApiGenerator;
use rocket_okapi::request::{OpenApiFromRequest, RequestHeaderInput};
use rocket_sync_db_pools::{database, diesel};

Expand Down