|
1 | 1 | # Internet Computer Reference |
2 | 2 |
|
3 | | -**A preview of the latest `master` branch can be found [here](https://khsfq-wqaaa-aaaak-qckvq-cai.icp0.io/docs).** |
4 | | - |
5 | | -**The latest *released* version can be found [here](https://internetcomputer.org/docs/current/references/ic-interface-spec).** |
6 | | - |
7 | | -This repository contains the source files of the Interface Spec, which describes the externally visible behaviour of the Internet Computer. |
8 | | -The language-independent description of this IC interface is available in [ic.did](./spec/_attachments/ic.did). |
9 | | - |
10 | | -It used to contain a reference implementation and acceptance test suite; these can now be found at [https://github.com/dfinity/ic-hs](https://github.com/dfinity/ic-hs). |
11 | | - |
12 | | -## About the Interface Spec |
13 | | - |
14 | | -This document describes the external interface of the Internet Computer. It is the authoritative source for interface details (request and function names, parameters, encodings). The goal is to have a document that is authoritative, and provides a place and a language to discuss external features of the Internet Computer in a hopefully concrete way. However, this document intentionally does not address _how_ to implement this behavior, and cannot be used as an implementation spec. |
15 | | - |
16 | | -## Versioning |
17 | | - |
18 | | -The Interface Spec is versioned, using a three-component version like |
19 | | - |
20 | | - 0.2.1 |
21 | | - |
22 | | -Releases from this repository are tagged using a three-component _code |
23 | | -version_ number: |
24 | | - |
25 | | - 0.8.1 |
26 | | - ┬ ┬ ┬ |
27 | | - │ │ └ The third component is bumped upon non-breaking changes to the spec. |
28 | | - │ └ The second component is bumped with a breaking change to the spec |
29 | | - └ Always zero for now. |
30 | | - |
31 | | -Each major spec version has a release branch (e.g. `release-0.8`) that only sees |
32 | | -non-breaking changes and bugfixes. A release branch should typically be “ahead” of all previous release branches. |
33 | | - |
34 | | -The `master` branch contains finished designs, but is not directly scheduled |
35 | | -for implementation. It lists version version number `∞`. The reference |
36 | | -implementation on this branch typically does _not_ fully implement the spec. This branch should always be “ahead” of all the release branches. |
37 | | - |
38 | | -## Contributing |
39 | | - |
40 | | -This repository accepts external contributions, conditioned on acceptance of the [Contributor Lincense Agreement](https://github.com/dfinity/cla/). |
| 3 | +**The Interface Specification has been moved to the [`dfinity/portal` repository](https://github.com/dfinity/portal).** |
| 4 | + |
| 5 | +The relevant files include: |
| 6 | + |
| 7 | +```bash |
| 8 | +docs/references/http-gateway-protocol-spec.md |
| 9 | +docs/references/ic-interface-spec.md |
| 10 | +docs/references/_attachments/certificates.cddl |
| 11 | +docs/references/_attachments/http-gateway.did |
| 12 | +docs/references/_attachments/ic.did |
| 13 | +docs/references/_attachments/interface-spec-changelog.md |
| 14 | +docs/references/_attachments/requests.cddl |
| 15 | +``` |
0 commit comments