CyCAT
/
cycat-project-website
mirror of https://github.com/CyCat-project/cycat-project-website
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

chg: [concept] UUID definition + non-referenced URL generation

main
Alexandre Dulaunoy 2021-02-24 08:08:24 +01:00
parent 85b72456df
commit 0b0fa554fa
No known key found for this signature in database
GPG Key ID: 09E2CD4944E6CBCD
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
_services/concept.md
View File

@ -13,6 +13,12 @@ by this publisher under a specific project. The CyCAT url is composed of two nam
`publisher-short-name`:`project-short-name`:`UUID` `publisher-short-name`:`project-short-name`:`UUID`
## What is an UUID?
A [universally unique identifier (UUID)](https://en.wikipedia.org/wiki/Universally_unique_identifier) is a 128-bit number used to identify information in computer systems also known as GUID.
CyCAT use such UUID to reference items produced in a collection. CyCAT, by default, will use any existing UUID already assigned by the publisher. If not present or there is no item present,
a fixed value is then calculated from the UUID namespace of CyCAT combined with `publisher-short-name:project-short-name`.
## Publisher namespace ## Publisher namespace
A publisher can be any organisation, project or individual requesting a publisher to CyCAT. A publisher can be any organisation, project or individual requesting a publisher to CyCAT.
@ -46,3 +52,13 @@ A publisher can request one or more project to CyCAT associated to the publisher
| `timestamp` | Last update of the project record (unix timestamp)| :heavy_check_mark: | | `timestamp` | Last update of the project record (unix timestamp)| :heavy_check_mark: |
| `maintainer` | owner, external, cycat | - | | `maintainer` | owner, external, cycat | - |
## URL example
## How to generate a CyCAT url for non-registered url or missing item in a collection
CyCAT has a fixed UUID namespace `690b3b43-d689-481c-aa61-5351963a36f2`.
```shell
% uuidgen --sha1 -n "690b3b43-d689-481c-aa61-5351963a36f2" -N "samratashok:nishang:"
2605ff5e-342c-5326-8744-96a34b7e581e
```