Skip to content

rocket-okapi v0.8.0

Latest
Compare
Choose a tag to compare
@ralpha ralpha released this 14 Jan 22:49
· 2 commits to master since this release
rocket-okapi-v0.8.0
e53cc9b

Okapi v0.7.0

Added

  • Added Eq trait for various structures.

Changed

  • merge_paths does correctly handle the merging of paths with double / in the combined path.
  • Updated to Rust 2021 edition.

Rocket Okapi v0.8.0

Added

  • Added support for new Responder
    types (implemented OpenApiResponderInner):
    • Box<T>
  • Added support for new FromRequest
    types (implemented OpenApiFromRequest):
    • rocket::request::Outcome<T, T::Error>
  • New feature flag rocket_sync_db_pools for compatibility with
    rocket_sync_db_pools.
  • New feature flag rocket_ws for compatibility with rocket_ws.
  • Added new example for WebSockets.
  • Added support for new Responder
    types (implemented OpenApiResponderInner):
    • rocket_ws::Channel<'o> (when rocket_ws feature is enabled)
    • rocket_ws::stream::MessageStream<'o, S> (when rocket_ws feature is enabled)
  • Added support for new FromRequest
    types (implemented OpenApiFromRequest):
    • rocket_dyn_templates::Metadata<'r> (when rocket_dyn_templates feature is enabled)
    • rocket_sync_db_pools::example::ExampleDb (when rocket_sync_db_pools feature is enabled)
    • rocket_ws::WebSocket (when rocket_ws feature is enabled)
  • Added get_nested_endpoints_and_docs to support more module based APIs. (#137, #138)

Changed

  • rocket-okapi and rocket-okapi-codegen require rocket v0.5.0. (#132)
  • Updated RapiDoc to v9.3.4 and updated settings, including changed defaults in RapiDocs.
    • Schema settings moved to SchemaConfig.
    • GeneralConfig added: update_route, route_prefix and persist_auth.
    • UiConfig added: css_file and css_classes.
    • NavConfig added: show_method_in_nav_bar, nav_accent_text_color, nav_active_item_marker
      and on_nav_tag_click.
    • NavConfig removed: nav_bg_image, nav_bg_image_size and nav_bg_image_repeat.
    • HideShowConfig added: allow_spec_file_download, allow_advanced_search and show_curl_before_try.
    • ApiConfig changed: api_key_name, api_key_location and fetch_credentials.
    • SlotsConfig added: operations_top.
    • Note: The default RenderStyle changed from View to Read.
    • Note: schema_hide_read_only and schema_hide_write_only changed behavior.
  • Updated Swagger UI to v5.11.0.
  • Updated all crates to Rust 2021 edition.
  • Renamed uuid example to uuid_usage, so it does not collide with uuid crate.

This version also includes all the changes from 0.8.0-rc.1, 0.8.0-rc.2 and 0.8.0-rc.3.
See below for more info on the changes made in these versions.