### Start the RDAP Server

Source: https://github.com/icann/icann-rdap/wiki/RDAP Server

Launch the RDAP server process.

```bash
./target/release/rdap-srv
```

--------------------------------

### Install Cargo Release Plugin

Source: https://github.com/icann/icann-rdap/blob/main/release.md

Install the `cargo-release` plugin if it's not already present. This tool automates release tasks.

```bash
cargo install cargo-release
```

--------------------------------

### Install ICANN RDAP CLI with Homebrew

Source: https://github.com/icann/icann-rdap/wiki/Home

Use this command to install the `rdap` and `rdap-test` CLI tools if you are a Homebrew user.

```bash
brew install icann-rdap
```

--------------------------------

### Install ICANN RDAP CLI from crates.io

Source: https://github.com/icann/icann-rdap/wiki/Home

Compile and install the `icann-rdap-cli` package if you have Rust and Cargo installed. Ensure OpenSSL development files are installed on Linux systems.

```bash
cargo install icann-rdap-cli
```

--------------------------------

### Get Help for rdap-srv-data Subcommands

Source: https://github.com/icann/icann-rdap/wiki/RDAP Server

Display help information for specific subcommands of the rdap-srv-data utility.

```bash
rdap-srv-data entity --help
rdap-srv-data nameserver --help
rdap-srv-data domain --help
rdap-srv-data autnum --help    
rdap-srv-data network --help
```

--------------------------------

### GIVEN-WHEN-THEN Test Pattern Example

Source: https://github.com/icann/icann-rdap/blob/main/README.md

Illustrates the GIVEN-WHEN-THEN pattern for writing tests. This pattern helps structure test cases for clarity.

```rust
// GIVEN a domain in the server
...

// WHEN queried
...

// THEN return 200 OK
```

--------------------------------

### Get RDAP Command Help

Source: https://github.com/icann/icann-rdap/wiki/RDAP-command

Access brief or extended help information for the `rdap` command. Use `-h` for a quick overview and `--help` for comprehensive details.

```bash
rdap -h
```

```bash
rdap --help
```

--------------------------------

### PR Check Command

Source: https://github.com/icann/icann-rdap/blob/main/README.md

Runs a series of checks before submitting a Pull Request. Requires 'just' to be installed.

```bash
just pr_check
```

--------------------------------

### Set up Environment Variables for RDAP Server

Source: https://github.com/icann/icann-rdap/wiki/RDAP Server

Configure server logging, data directory, and base URL by creating a .env file.

```bash
RDAP_SRV_LOG=debug
RDAP_SRV_DATA_DIR=/tmp/rdap-srv/data
RDAP_BASE_URL=http://localhost:3000/rdap
```

--------------------------------

### Create Initial RDAP Nameserver Data

Source: https://github.com/icann/icann-rdap/wiki/RDAP Server

Add a nameserver record, linking it to a registrant.

```bash
./target/release/rdap-srv-data nameserver --ldh ns1.example.com --registrant foo1234
```

--------------------------------

### Create Default Server Help Data

Source: https://github.com/icann/icann-rdap/wiki/RDAP Server

Generate the default help information for the RDAP server.

```bash
./target/release/rdap-srv-data srv-help --notice "this is a test server"
```

--------------------------------

### Add Domain Data and Update Server

Source: https://github.com/icann/icann-rdap/wiki/RDAP Server

Add a domain record and then update the server's data store.

```bash
./target/release/rdap-srv-data domain --ldh example.com --registrant foo1234 --ns ns1.example.com
./target/release/rdap-srv-store --update
```

--------------------------------

### Perform RDAP Query with Bootstrapping

Source: https://github.com/icann/icann-rdap/blob/main/icann-rdap-client/README.md

Use this snippet to query RDAP services by first bootstrapping to find the correct server. It requires setting up a query type, client configuration, and a bootstrap store. An optional callback can be provided to log fetching progress.

```rust
use icann_rdap_client::prelude::*;
use std::str::FromStr;
use tokio::main;

#[tokio::main]
async fn main() -> Result<(), RdapClientError> {

    // create a query
    let query = QueryType::from_str("192.168.0.1")?;
    // or
    let query = QueryType::from_str("icann.org")?;

    // create a client (from icann-rdap-common)
    let config = ClientConfig::default();
    // or let config = ClientConfig::builder().build();

    let client = create_client(&config)?;

    // ideally, keep store in same context as client
    let store = MemoryBootstrapStore::new();

    // issue the RDAP query
    let response =
        rdap_bootstrapped_request(
           &query,
           &client,
           &store,
           |reg| eprintln!("fetching {reg:?}")
    ).await?;

    Ok(())
}
```

--------------------------------

### Switch to Main Branch and Update

Source: https://github.com/icann/icann-rdap/blob/main/release.md

After the release process on the 'dev' branch, switch to the 'main' branch and update your local repository to reflect the latest changes.

```bash
git switch main
git pull
```

--------------------------------

### Configure RDAP Bootstrap Lookups

Source: https://github.com/icann/icann-rdap/wiki/RDAP-command

Specify alternative servers for TLD lookups using `--tld-lookup` and for IP/ASN lookups if normal bootstrapping fails using `--inr-backup-bootstrap`.

```bash
rdap --tld-lookup https://tld.example.com
```

```bash
rdap --inr-backup-bootstrap https://backup.arin.net
```

--------------------------------

### Create Initial RDAP Entity Data

Source: https://github.com/icann/icann-rdap/wiki/RDAP Server

Add an entity record to the server's data store.

```bash
./target/release/rdap-srv-data entity --handle foo1234 --email joe@example.com --full-name "Joe User"
```

--------------------------------

### Create Directory for Server Data

Source: https://github.com/icann/icann-rdap/wiki/RDAP Server

Ensure the directory for storing server data files exists.

```bash
mkdir -p /tmp/rdap-srv/data
```

--------------------------------

### Perform Basic RDAP Queries

Source: https://github.com/icann/icann-rdap/wiki/RDAP-command

Execute basic RDAP queries for domains, TLDs, IP addresses, CIDRs, ASNs, and URLs. Use flags to specify output or query specific data.

```bash
rdap icann.org
```

```bash
rdap -p registrar icann.org
```

```bash
rdap -O pretty-json -p registrar icann.org
```

```bash
rdap .com
```

```bash
rdap 192.0.2.1
```

```bash
rdap 10/8
```

```bash
rdap as64496
```

```bash
rdap https://rdap.iana.org/domain/com
```

```bash
rdap -O url icann.org
```

--------------------------------

### Publish to Crates.io

Source: https://github.com/icann/icann-rdap/blob/main/release.md

Publish the release build to crates.io using the `cargo-release` plugin. This command may require occasional monitoring.

```bash
cargo release publish -x
```

--------------------------------

### Tag Release Version

Source: https://github.com/icann/icann-rdap/blob/main/release.md

Create a Git tag for the new release version. The tag format should be 'vVERSION', e.g., 'v0.0.5'.

```bash
git tag vVERSION
```

--------------------------------

### Query RDAP Server with Client

Source: https://github.com/icann/icann-rdap/wiki/RDAP Server

Use the RDAP client to query the running server for nameserver information.

```bash
./target/release/rdap -T -B http://localhost:3000/rdap ns1.example.com
```

--------------------------------

### Direct RDAP Queries to Specific Servers

Source: https://github.com/icann/icann-rdap/wiki/RDAP-command

Override default IANA bootstrapping to query specific RDAP servers. Use `-b` with an object tag (e.g., 'arin') or `-B` with an explicit URL.

```bash
rdap -b arin
```

```bash
rdap -B https://foo.example/ip/10.0.0.0
```

--------------------------------

### Query Server for New Domain Data

Source: https://github.com/icann/icann-rdap/wiki/RDAP Server

Query the RDAP server for the recently added domain information.

```bash
./target/release/rdap -T -B http://localhost:3000/rdap example.com
```

--------------------------------

### Build ICANN RDAP Release Binaries

Source: https://github.com/icann/icann-rdap/wiki/Home

Compile the ICANN RDAP project in release mode. The resulting executable binaries will be located in the `target/release` directory.

```bash
cargo build --release
```

--------------------------------

### Rustfmt Code Formatting Check

Source: https://github.com/icann/icann-rdap/blob/main/README.md

Ensures code adheres to Rustfmt standards. Run this command to check if formatting changes are needed.

```bash
cargo fmt --check
```

--------------------------------

### Run Tests for ICANN RDAP

Source: https://github.com/icann/icann-rdap/wiki/Home

Execute all tests for the ICANN RDAP project using Cargo. This command should be run from the project's root directory.

```bash
cargo test
```

--------------------------------

### Create RDAP Domain Object

Source: https://github.com/icann/icann-rdap/blob/main/icann-rdap-common/README.md

Construct a Domain object using its builder pattern. Supports adding entities, extensions, and notices.

```rust
use icann_rdap_common::prelude::*;

// create a simple entity to be used inside other objects with builder().
let holder = Entity::builder().handle("foo-BAR").build();

// create an RDAP domain response object with response_obj()
let domain = Domain::response_obj()
  .ldh_name("example.com")
  .extension(ExtensionId::IcannRdapResponseProfile1.as_ref())
  .extension(ExtensionId::IcannRdapTechnicalImplementationGuide1.as_ref())
  .notice(Notice::builder()
    .title("Inaccuracy report")
    .description_entry("Things may be wrong. But it isn't our fault.")
    .description_entry("Read the policy for more information.")
    .build()
  )
  .entity(holder.clone())
  .build();
```

--------------------------------

### Navigate and Update Dev Branch

Source: https://github.com/icann/icann-rdap/blob/main/release.md

Switch to the 'dev' branch and pull the latest changes from the remote repository before proceeding with release tasks.

```bash
git switch dev
git pull
```

--------------------------------

### Push Tag to GitHub

Source: https://github.com/icann/icann-rdap/blob/main/release.md

Push the newly created version tag to GitHub. This action typically triggers a release build in GitHub Actions.

```bash
git push origin --tags
```

--------------------------------

### Trigger Full Data Reload via Command

Source: https://github.com/icann/icann-rdap/wiki/RDAP Server

Use the rdap-srv-store command to trigger a full data reload in the server.

```bash
rdap-srv-store --reload
```

--------------------------------

### Create RDAP IP Network Object

Source: https://github.com/icann/icann-rdap/blob/main/icann-rdap-common/README.md

Build an IP network object for use as an RDAP response. Requires CIDR notation and allows adding entities, extensions, and notices.

```rust
use icann_rdap_common::prelude::*;

// create an IP network to be used as a response with response_obj()
let net = Network::response_obj()
  .cidr("10.0.0.0/16")
  .entity(holder.clone())
  .extension(ExtensionId::NroRdapProfile0.as_ref())
  .notice(Notice::builder().title("test").build())
  .build()
  .unwrap();
```

--------------------------------

### Perform RDAP Query with Specific Base URL

Source: https://github.com/icann/icann-rdap/blob/main/icann-rdap-client/README.md

This snippet demonstrates how to perform an RDAP query by specifying a direct base URL for the RDAP server. It's useful when bootstrapping is not desired or when the server URL is already known. Ensure the base URL is correct for the target RDAP service.

```rust
use icann_rdap_client::prelude::*;
use std::str::FromStr;
use tokio::main;

#[tokio::main]
async fn main() -> Result<(), RdapClientError> {

    // create a query
    let query = QueryType::from_str("192.168.0.1")?;
    // or
    let query = QueryType::from_str("icann.org")?;

    // create a client (from icann-rdap-common)
    let config = ClientConfig::builder().build();
    // or let config = ClientConfig::default();
    
    let client = create_client(&config)?;

    // issue the RDAP query
    let base_url = "https://rdap-bootstrap.arin.net/bootstrap";
    let response = rdap_request(base_url, &query, &client).await?;

    Ok(())
}
```

--------------------------------

### Create IP Network Redirect

Source: https://github.com/icann/icann-rdap/wiki/RDAP Server

Create a redirect for an IP network using the `rdap-srv-data` command with the `--redirect` option. This allows mapping specific IP ranges to external URLs.

```bash
rdap-srv-data --redirect http://other.example/ip/11.0.0.0/16 network --cidr 11.0.0.0/16
```

--------------------------------

### Trigger Data Update via Command

Source: https://github.com/icann/icann-rdap/wiki/RDAP Server

Use the rdap-srv-store command to trigger a data update in the server.

```bash
rdap-srv-store --update
```

--------------------------------

### Create RDAP Nameserver Object

Source: https://github.com/icann/icann-rdap/blob/main/icann-rdap-common/README.md

Generate a Nameserver object for an RDAP response. Includes fields for LDH name and allows for extensions and notices.

```rust
use icann_rdap_common::prelude::*;

// create a nameserver for a response
let ns = Nameserver::response_obj()
  .ldh_name("ns1.example.com")
  .entity(holder.clone())
  .extension(ExtensionId::IcannRdapResponseProfile1.as_ref())
  .extension(ExtensionId::IcannRdapTechnicalImplementationGuide1.as_ref())
  .notice(Notice::builder().title("Inaccuracy report").build())
  .build()
  .unwrap();
```

--------------------------------

### Bump Version with Cargo Release

Source: https://github.com/icann/icann-rdap/blob/main/release.md

Use the `cargo-release` plugin to increment the version number of the project. Choose 'patch', 'minor', or 'major' as needed. The '-x' flag ensures that tests are run.

```bash
cargo release version patch -x
```

```bash
cargo release version minor -x
```

```bash
cargo release version major -x
```

--------------------------------

### Convert Contact to vCard and Serialize to JSON

Source: https://github.com/icann/icann-rdap/blob/main/icann-rdap-common/README.md

Convert a Contact struct to its vCard representation and then serialize it into a JSON string. Requires `serde::Serialize` and `serde_json::Value`.

```rust
use icann_rdap_common::contact::Contact;
use serde::Serialize;
use serde_json::Value;

let contact = Contact::builder()
  .kind("individual")
  .full_name("Bob Smurd")
  .build();

let v = contact.to_vcard();
let json = serde_json::to_string(&v);
```

--------------------------------

### Build Contact Struct

Source: https://github.com/icann/icann-rdap/blob/main/icann-rdap-common/README.md

Create a Contact struct using the builder pattern. This struct models jCard/vCard contact information.

```rust
use icann_rdap_common::contact::Contact;

let contact = Contact::builder()
  .kind("individual")
  .full_name("Bob Smurd")
  .build();
```

--------------------------------

### Create Entity Template

Source: https://github.com/icann/icann-rdap/wiki/RDAP Server

Use the `rdap-srv-data` command with the `--template` option to create a template for an entity object. This is useful for generating multiple RDAP objects by modifying IDs within the template.

```bash
rdap-srv-data --template entity --handle foo --full-name "Bob Smurd"
```

--------------------------------

### Configure RDAP Paging

Source: https://github.com/icann/icann-rdap/wiki/RDAP-command

Control the built-in pager for RDAP output using the `RDAP_PAGING` environment variable or the `-P` command argument. Options include 'embedded', 'auto', and 'none'.

```bash
rdap -P embedded
```

--------------------------------

### Store Custom RDAP Data

Source: https://github.com/icann/icann-rdap/wiki/RDAP Server

Use the `rdap-srv-store` command with the `--update` option to load your own RDAP-compliant data into the server's data directory. This command performs validation checks during the data transfer.

```bash
rdap-srv-store --update /my_data/rdap
```

--------------------------------

### Control RDAP Output Format

Source: https://github.com/icann/icann-rdap/wiki/RDAP-command

Explicitly set the output format using the `-O` command argument or the `RDAP_OUTPUT` environment variable. Defaults to 'rendered-markdown' for interactive shells and JSON otherwise.

```bash
rdap -O pretty-json icann.org
```

--------------------------------

### Deserialize JSON to Contact from vCard Format

Source: https://github.com/icann/icann-rdap/blob/main/icann-rdap-common/README.md

Deserialize a JSON string representing vCard data into a Contact struct. Requires `serde::Deserialize` and `serde_json::Value`.

```rust
use icann_rdap_common::contact::Contact;
use serde::Deserialize;
use serde_json::Value;

let json = r#"[
  "vcard",
  [
    ["version", {}, "text", "4.0"],
    ["fn", {}, "text", "Joe User"],
    ["kind", {}, "text", "individual"],
    ["org",
      {"type":"work"}
    , "text", "Example"],
    ["title", {}, "text", "Research Scientist"],
    ["role", {}, "text", "Project Lead"],
    ["adr",
      { "type":"work" },
      "text",
      [
        "",
        "Suite 1234",
        "4321 Rue Somewhere",
        "Quebec",
        "QC",
        "G1V 2M2",
        "Canada"
      ]
    ],
    ["tel",
      { "type":["work", "voice"], "pref":"1" },
      "uri", "tel:+1-555-555-1234;ext=102"
    ],
    ["email",
      { "type":"work" },
      "text", "joe.user@example.com"
    ]
  ]
]"#;

// Note: The actual deserialization code is missing in the source, but this represents the input JSON.
```

--------------------------------

### Create RDAP Autnum Object

Source: https://github.com/icann/icann-rdap/blob/main/icann-rdap-common/README.md

Construct an Autnum object for an RDAP response. Supports specifying the autonomous system number range and adding related entities, extensions, and notices.

```rust
use icann_rdap_common::prelude::*;

// create an autnum for a response
let autnum = Autnum::response_obj()
  .autnum_range(700..700)
  .entity(holder)
  .extension(ExtensionId::NroRdapProfile0.as_ref())
  .notice(Notice::builder().title("test").build())
  .build();
```

--------------------------------

### Deserialize JSON to Contact Object

Source: https://github.com/icann/icann-rdap/blob/main/icann-rdap-common/README.md

Deserialize a JSON string into a vector of Value, then convert it into a Contact object using the from_vcard method. Ensure the input JSON is valid.

```rust
let data: Vec<Value> = serde_json::from_str(json).unwrap();
let contact = Contact::from_vcard(&data);
```

--------------------------------

### Set Maximum Cache Age

Source: https://github.com/icann/icann-rdap/wiki/RDAP-command

Control the maximum duration for which items remain in the cache using the `--max-cache-age` argument. Specify age in seconds.

```bash
rdap --max-cache-age 3600
```

--------------------------------

### Commit Message Structure

Source: https://github.com/icann/icann-rdap/blob/main/README.md

Defines the structure for commit messages, including type, optional scope, and a concise description. Breaking changes are indicated with '!'.

```git
type(scope): description
```

```git
feat(common)!: all output is now toml
```

```git
fix: #137
```

--------------------------------

### Disable RDAP Caching

Source: https://github.com/icann/icann-rdap/wiki/RDAP-command

Turn off client-side caching using the `-N` command parameter or by setting the `RDAP_NO_CACHE` environment variable to 'true'.

```bash
rdap -N
```

```bash
export RDAP_NO_CACHE=true
```

--------------------------------

### Parse RDAP JSON Response

Source: https://github.com/icann/icann-rdap/blob/main/icann-rdap-common/README.md

Deserialize a JSON string into an RdapResponse object. Ensure the JSON structure matches expected RDAP formats.

```rust
use icann_rdap_common::prelude::*;

let json = r#"
  {
    "objectClassName": "ip network",
    "links": [
      {
        "value": "http://localhost:3000/rdap/ip/10.0.0.0/16",
        "rel": "self",
        "href": "http://localhost:3000/rdap/ip/10.0.0.0/16",
        "type": "application/rdap+json"
      }
    ],
    "events": [
      {
        "eventAction": "registration",
        "eventDate": "2023-06-16T22:56:49.594173356+00:00"
      },
      {
        "eventAction": "last changed",
        "eventDate": "2023-06-16T22:56:49.594189140+00:00"
      }
    ],
    "startAddress": "10.0.0.0",
    "endAddress": "10.0.255.255",
    "ipVersion": "v4"
  }
"#;

let rdap: RdapResponse = serde_json::from_str(json).unwrap();
assert!(matches!(rdap, RdapResponse::Network(_)));
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.