ICRC icon indicating copy to clipboard operation
ICRC copied to clipboard

ICRC-23: http_request_namespacing

Open skilesare opened this issue 2 years ago • 1 comments

This ICRC is reserved to discuss the need for and definition of a standard for ICRC standards to reserve a path in http_request to deliver content, data, certification, and other items that may need to be accessible via https.

for example:

https://canister-id.icp0.io/-/icrc-3/ledger/{skip}/{take}

More later.

skilesare avatar Jul 01 '23 16:07 skilesare

With a bit of investigation, I'm proposing the following syntax for reserving a path for ICRC HTTP designations:

https://{canisterid}.icp0.io/---/icrc{x}/{*}

Where:

  • x is the ICRC number.
    • is any available path is made available to the ICRC standard for designation

The triple dash is:

  1. Distinctive and easy to recognize.
  2. Unlikely to be used by other application
  3. The dash is separated so you can clearly see there are three of them.
  4. Provides an anchor point for developers on the platform to recognize that "something icrc-like is happening here, I should be able to look it up";

Example: https://{canisterid}.icp0.io/---/icrc3/block/53 for retrieving a representation of block 53 on an ICRC3 ledger.

Others considered:

  1. Single dash - we use this in perpetualOS so I went with something longer
  2. Triple or single underscore - it is a bit harder to see that there are multiple items.

skilesare avatar Oct 31 '23 14:10 skilesare