Skip to content

Commit

Permalink
Update the wasmer_registry::queries docs to mention backwards compati…
Browse files Browse the repository at this point in the history
…bility and its low level nature
  • Loading branch information
Michael-F-Bryan committed Nov 23, 2022
1 parent ea77173 commit 2b9f623
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
1 change: 0 additions & 1 deletion lib/registry/src/graphql.rs
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,6 @@ pub(crate) mod proxy {
}
}


#[cfg(target_os = "wasi")]
pub fn whoami_distro() -> String {
whoami::os().to_lowercase()
Expand Down
20 changes: 16 additions & 4 deletions lib/registry/src/queries.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
//! The GraphQL queries used by this crate.
//! Low-level GraphQL queries used by this crate.
//!
//! This module can be useful if you want to query the WAPM backend directly
//! because the crate's high-level functions don't provide the exact
//! operations/data you need.
//! If possible, users should prefer the high-level functions exposed under
//! [`crate`].
//!
//! This module is primarily used in combination with
//! [`crate::graphql::execute_query()`] as an "escape hatch" for accessing
//! information that may not be exposed via the high-level functions.
//!
//! # Backwards Compatibility
//!
//! Queries won't be deleted or have breaking changes to their inputs during
//! patch releases, however new fields may be added to the response types
//! generated by `graphql_client` at any time.
//!
//! Users should treat all response types as if they had the `#[non_exhaustive]`
//! attribute.
use graphql_client::*;

Expand Down

0 comments on commit 2b9f623

Please sign in to comment.