NoRFC REST API

The NoRFC web service allows you to search and view the noRFC documents holded in the noRFC documents database

The documents that marks "Private" status are available only after authorization. The documents with "Top Secret" status are not available for downloading. The rest of the documents are available for downloading without any restrictions

GET /info

Returns information about database status and shows total number documents

# curl -v --insecure https://127.0.0.1:8732/info

> GET /info HTTP/1.1
> Host: 127.0.0.1:8732
> User-Agent: curl/7.68.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Date: Tue, 17 Jan 2023 05:41:09 GMT
< Server: NoRFC/1.08
< Content-Length: 629
< Content-Type: application/json;charset=UTF-8
< X-Authorized: 0
<
{
  "categories": [
    "Informational",
    "Experimental",
    ...,
    "Etcetera"
  ],
  "datadir": "/var/lib/norfc",
  "dbdir": "/var/lib/norfc/db",
  "documentroot": "/usr/share/norfc",
  "dsn": "DBI:SQLite:dbname=/var/lib/norfc/norfc.db",
  "homedir": "/var/lib/norfc",
  "is_authorized": 0,
  "maxstorefilesize": 1024,
  "message": "OK",
  "name": "info",
  "status": 1,
  "tempdir": "/tmp/norfc/server",
  "total": 12,
  "version": "1.08"
}

Format of the JSON response:

categories is a list of available noRFC categories
datadir is a directory for holds the noRFC data
dbdir is a directory for holds the noRFC file database
documentroot is the root directory of web server
dsn is the database connect string
homedir is a directory for holds web server data
is_authorized is a boolean status of authorization on the web server. 0 - not authorized; 1 - authorized
message is a response message or text of error [optional]
name is a handler name [optional]
status is a boolean status of the response. 0 - error; 1 - ok
tempdir is a directory for holds a temporary data
total is a actual number of documents in the noRFC database
version is the current version of the installed noRFC project

GET /info/<NoRFCNUM>

Returns information about specified noRFC document by its number

# curl -v --insecure https://127.0.0.1:8732/info/Draft-R202301125

> GET /info/Draft-R202301125 HTTP/1.1
> Host: 127.0.0.1:8732
> User-Agent: curl/7.68.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Content-Type: application/json;charset=UTF-8
< Content-Length: 1500
< Server: NoRFC/1.08
< Date: Tue, 17 Jan 2023 08:15:15 GMT
<
{
  "attributes": "columns=80; external=1",
  "author": "Anonymous",
  "category": "Etcetera",
  "file": "/var/lib/norfc/db/2023/2023011/Draft-R202301125.raw",
  "id": 10,
  "md5": "ad988fc83f3d4c9ff4549a1a7c384440",
  "message": "Found",
  "num": "Draft-R202301125",
  "obsoletes": [
    "NoRFC-R202300945",
    "NoRFC-R202300977",
    "NoRFC-R202301011"
  ],
  "pub": 1673424823,
  "sha1": "...",
  "sha256": "...",
  "signature": "...",
  "size": 1234,
  "status": 1,
  "title": "Test document",
  "updates": [
    "NoRFC-R202300963",
    "NoRFC-R202301029"
  ]
}

Format of the JSON response:

attributes is attributes string of the noRFC document
author is author of the noRFC document
category is category of the noRFC document
file is full file path of the noRFC source
id is ID of the noRFC document
md5 is MD5 checksum of the noRFC source
message is a response message or text of error [optional]
num is a number of the noRFC document
obsoletes is a list of obsoletes documents (array)
pub is a publication date of the noRFC document
sha1 is SHA1 checksum of the noRFC source
sha256 is SHA256 checksum of the noRFC source
signature is a digital signature of the noRFC document
size is a file size of the noRFC source
status is a boolean status of the response. 0 - error; 1 - ok
title is title of the noRFC document
updates is a list of updates documents (array)

GET /<NoRFCNUM>

This method performs getting file of the noRFC document by noRFC number

# curl -v --insecure https://127.0.0.1:8732/Draft-R202301125

> GET /Draft-R202301125 HTTP/1.1
> Host: 127.0.0.1:8732
> User-Agent: curl/7.68.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Date: Tue, 17 Jan 2023 08:32:53 GMT
< Content-Type: text/plain; charset=utf-8
< Content-Length: 1539
< Server: NoRFC/1.08
<
Document    : Draft-R202301125
...

GET /<NoRFCNUM>.raw

This method performs getting source file of the noRFC document by noRFC number

# curl -v --insecure https://127.0.0.1:8732/Draft-R202301125.raw

> GET /Draft-R202301125.raw HTTP/1.1
> Host: 127.0.0.1:8732
> User-Agent: curl/7.68.0
> Accept: */*
>
< HTTP/1.1 200 OK
< ETag: "6b27eb9135ccb9acf82154e53427620c"
< Last-Modified: Tue, 17 Jan 2023 08:35:48 GMT
< Date: Tue, 17 Jan 2023 08:35:48 GMT
< Content-Length: 1240
< Server: NoRFC/1.08
< Content-Type: application/octet-stream
< Accept-Ranges: bytes
<
... content of the source file ...

GET /search

Performs searching the noRFC documents by noRFC number

# curl -v --insecure https://127.0.0.1:8732/search?text=Test

> GET /search?text=Test HTTP/1.1
> Host: 127.0.0.1:8732
> User-Agent: curl/7.68.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Date: Tue, 17 Jan 2023 08:42:08 GMT
< Content-Length: 1406
< Server: NoRFC/1.08
< Content-Type: application/json;charset=UTF-8
<
{
  "count": 12,
  "found": [
    {
      "category": "Etcetera",
      "id": 3,
      "n": 1,
      "num": "NoRFC-R202300945",
      "pub": 1673296160,
      "title": "Test document"
    },
    ...
  ],
  "in": {
    "category": "",
    "text": "Test"
  },
  "message": "Found",
  "page": 1,
  "pages": 1,
  "status": 1,
  "total": 12
}

URL parameters of the query string (search criterias):

category is a text fragment or the noRFC document number for search
limit is a maximal number of documents on page of search results
page is a page number of search results
text is a text

Format of the JSON response:

count is summary number of found noRFC documents by search criterias
found is a list of noRFC documents (array)
in is search criterias
message is a response message or text of error [optional]
page is current page of search results
pages is number of pages of search results
status is a boolean status of the response. 0 - error; 1 - ok
total is number of found noRFC documents on the current page of search results

This GET method have the POST alternative:

# curl -v --insecure -F "text=Test" https://127.0.0.1:8732/search

GET /gendocnum

This method performs generation a new noRFC document number. This method basic authentication required

# curl -v --insecure -u test:test "https://127.0.0.1:8732/gendocnum?year=2023&yday=123&type=NoRFC&status=R&nn=1"

> GET /gendocnum?year=2023&yday=123&type=NoRFC&status=R&nn=1 HTTP/1.1
> Host: 127.0.0.1:8732
> Authorization: Basic dGVzdDp0ZXN0
> User-Agent: curl/7.68.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Date: Tue, 17 Jan 2023 09:45:35 GMT
< Content-Type: application/json;charset=UTF-8
< Content-Length: 124
< Server: NoRFC/1.08
<
{
  "dkey": "2023-01-17",
  "dotted": "2023.123.1.0",
  "message": "OK",
  "nn": 1,
  "number": "NoRFC-R202312310",
  "short": "202312310",
  "status": "R",
  "type": "NoRFC",
  "yday": "123",
  "year": 2023
}

URL parameters of the query string:

nn is sequence number in the current day, in the range 1..999999
status is document status letter - R (Regular, default), P (Private), X (Extra), Z (Top secret)
type is document type - Draft or NoRFC (default is NoRFC)
yday is the day of the year, in the range 001..365 (or 001..366 in leap years)
year is four digits of the year (e.g., 2020)

Format of the JSON response:

dkey is the key for exporting of the noRFC documents
dotted is a dotted form of generated noRFC document number
message is a response message or text of error [optional]
nn is sequence number in the current day
number is a canonical form of generated noRFC document number
short is a short form of generated noRFC document number
status is a boolean status of the response. 0 - error; 1 - ok
type is document type - Draft or NoRFC
yday is the day of the year, in the range 001..365 (or 001..366 in leap years)
year is four digits of the year

PUT /<NoRFCNUM>

This method performs add the noRFC document to database. This method basic authentication required

# echo "Content of test document" > test.txt
# stat -c "%s" test.txt
# md5sum test.txt
# curl -v --insecure -X PUT -F "published=1673950709" -F "category=Test" -F "title=Test document" \
-F "author=Anonymous" -F "attributes=test=foo" -F "size=25" -F "md5=761e9f7b8769a84ad89c110871c3cf2f" \
-F "fileraw=@test.txt" -u test:test https://127.0.0.1:8732/NoRFC-R202312310

> PUT /NoRFC-R202312310 HTTP/1.1
> Host: 127.0.0.1:8732
> Authorization: Basic dGVzdDp0ZXN0
> User-Agent: curl/7.68.0
> Accept: */*
> Content-Length: 960
> Content-Type: multipart/form-data; boundary=...
>
< HTTP/1.1 200 OK
< Content-Type: application/json;charset=UTF-8
< Content-Length: 218
< Server: NoRFC/1.08
< Date: Tue, 17 Jan 2023 10:59:56 GMT
<
{
  "attributes": "test=foo",
  "author": "Anonymous",
  "category": "Test",
  "md5": "761e9f7b8769a84ad89c110871c3cf2f",
  "message": "",
  "number": "NoRFC-R202312310",
  "published": "1673950709",
  "size": "25",
  "status": 1,
  "title": "Test document"
}

PUT request form parameters:

attributes is attributes string of the noRFC document
author is author of the noRFC document
category is category of the noRFC document
fileraw is file of source
filesig is file of signature
md5 is MD5 checksum of the noRFC source
published is a publication date and time of the noRFC document in unix time form
size is a file size of the noRFC source

Format of the JSON response:

attributes is attributes string of the noRFC document
author is author of the noRFC document
category is category of the noRFC document
md5 is MD5 checksum of the noRFC source
message is a response message or text of error [optional]
number is the noRFC document number
published is a publication date and time of the noRFC document in unix time form
size is a file size of the noRFC source
status is a boolean status of the response. 0 - error; 1 - ok
title is title of the noRFC document

DELETE /<NoRFCNUM>

This method performs delete the noRFC document from database. This method basic authentication required

# curl -v --insecure -X DELETE -u test:test https://127.0.0.1:8732/NoRFC-R202312310

> DELETE /NoRFC-R202312310 HTTP/1.1
> Host: 127.0.0.1:8732
> Authorization: Basic dGVzdDp0ZXN0
> User-Agent: curl/7.68.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Server: NoRFC/1.08
< Content-Length: 55
< Content-Type: application/json;charset=UTF-8
< Date: Tue, 17 Jan 2023 11:30:43 GMT
<
{
  "message": "Ok",
  "number": "NoRFC-R202312310",
  "status": 1
}

Format of the JSON response:

message is a response message or text of error [optional]
number is the noRFC document number
status is a boolean status of the response. 0 - error; 1 - ok

POST /rel/<NoRFCNUM>

This method performs add new relation to the noRFC document. This method basic authentication required

# curl -v --insecure -F "external=Draft-R202301125" -F "name=Updates" -u test:test https://127.0.0.1:8732/rel/NoRFC-R202312310

> POST /rel/NoRFC-R202312310 HTTP/1.1
> Host: 127.0.0.1:8732
> Authorization: Basic dGVzdDp0ZXN0
> User-Agent: curl/7.68.0
> Accept: */*
> Content-Length: 259
> Content-Type: multipart/form-data; boundary=...
>
< HTTP/1.1 200 OK
< Date: Tue, 17 Jan 2023 11:39:40 GMT
< Content-Type: application/json;charset=UTF-8
< Content-Length: 91
< Server: NoRFC/1.08
<
{
  "external": "Draft-R202301125",
  "id": 21,
  "message": "",
  "number": "NoRFC-R202312310",
  "status": 1
}

Format of the JSON response:

external is the external noRFC document number
id is ID of the relation
message is a response message or text of error [optional]
number is the noRFC document number
status is a boolean status of the response. 0 - error; 1 - ok

GET /rel/<NoRFCNUM>

This method returns relations of the noRFC document. This method basic authentication required

# curl -v --insecure -u test:test https://127.0.0.1:8732/rel/NoRFC-R202312310

> GET /rel/NoRFC-R202312310 HTTP/1.1
> Host: 127.0.0.1:8732
> Authorization: Basic dGVzdDp0ZXN0
> User-Agent: curl/7.68.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Date: Tue, 17 Jan 2023 11:45:31 GMT
< Content-Length: 171
< Server: NoRFC/1.08
< Content-Type: application/json;charset=UTF-8
<
{
  "external": "",
  "message": "Found",
  "number": "NoRFC-R202312310",
  "relations": [
    {
      "external": "Draft-R202301125",
      "id": 21,
      "name": "Updates",
      "number": "NoRFC-R202312310"
    }
  ],
  "status": 1
}

URL parameters of the query string:

external is the external noRFC document number [optional]

Format of the JSON response:

external is the external noRFC document number
message is a response message or text of error [optional]
number is the noRFC document number
relations is list of relations (array)
status is a boolean status of the response. 0 - error; 1 - ok

DELETE /rel/<NoRFCNUM>

This method performs delete relations of the noRFC document. This method basic authentication required

# curl -v --insecure -X DELETE -u test:test https://127.0.0.1:8732/rel/NoRFC-R202312310

> DELETE /rel/NoRFC-R202312310 HTTP/1.1
> Host: 127.0.0.1:8732
> Authorization: Basic dGVzdDp0ZXN0
> User-Agent: curl/7.68.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Date: Tue, 17 Jan 2023 11:54:09 GMT
< Content-Type: application/json;charset=UTF-8
< Server: NoRFC/1.08
< Content-Length: 69
<
{
  "external": "",
  "message": "Ok",
  "number": "NoRFC-R202312310",
  "status": 1
}

URL parameters of the query string:

external is the external noRFC document number [optional]

Format of the JSON response:

external is the external noRFC document number
message is a response message or text of error [optional]
number is the noRFC document number
status is a boolean status of the response. 0 - error; 1 - ok

GET /env

Returns current server environment variables in perl-dump format. This method available in debug mode of server only. Also this method basic authentication required

# curl -v --insecure -u test:test https://127.0.0.1:8732/env

> GET /env HTTP/1.1
> Host: 127.0.0.1:8732
> Authorization: Basic dGVzdDp0ZXN0
> User-Agent: curl/7.68.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Content-Length: 2682
< Content-Type: text/plain; charset=utf-8
< Server: NoRFC/1.08
< Date: Tue, 17 Jan 2023 08:03:06 GMT
<
{
  "HOME" => "/root",
  "MOJO_LOG_LEVEL" => "debug",
  "MOJO_MODE" => "development",
  ...
}