doc: wip: Add doc/specs.md specification file
Description
Description
Details
Details
- Provenance
ardumont Authored on May 22 2017, 4:27 PM ardumont Pushed on May 22 2017, 4:53 PM - Parents
- rDDEPef1fefdff50a: Add a skeleton server
- Branches
- Unknown
- Tags
Event Timeline
/doc/specs.md | ||
---|---|---|
18 | not sure what the URI list is or means here | |
34 | We need to have some form of authentication though, because we do not want to open the SWORD flood gates to every SWORD client out there. That can be done at different levels (IP, HTTP, SWORD native auth if there is such a thing), but we will need *something* | |
36 | i'm guessing less, maybe 100 MB? | |
55 | We need to decide where this URLs will be rooted, in the general space of SWH service URLs. I see you use sword.s.o below, but I don't quite like it. SWORD is an implementation detail, what we're implementing is a deposit service. So maybe it should be something under archive.s.o/deposit/, or something such. Aside from that, a nitpick: IIRC for the archive API we use /1/ to denote a version; using /v1/ here is incoherent with that. | |
92 | maybe just Software Heritage Archive here? | |
116–118 | this does not concern the HAL folks, but we will need to decide how to process these one-off loading jobs. It might be related to the distro loading discussion we're having on swh-devel | |
122 | we're a software archive, and software is the only thing we accept, why do we need to repeat "software" here? what is this endpoint doing? |
/doc/specs.md | ||
---|---|---|
18 | Well, my understanding of some part of the spec is not crystal clear. sword specs: The SWORD server MAY include zero or more sword:service [SWORD003] elements as children of the app:collection element containing references to nested service descriptions Of course, SWORD003 link is not clear either. I'm not sold on this though so i need to triple check (for example, i don't see what they mean by nested). | |
34 | Ok, we can we start with something basic as we did with the archive before it went public (http access restriction). | |
36 |
ok
Well, they don't have any idea yet. (I already asked them :) | |
55 | Yes, sword.s.o was something simple to avoid a hole in the spec.
This sounds reasonable.
Yes, fixed. | |
92 | Yes. | |
116–118 |
Indeed, the *spec* is HAL agnostic. HAL was merely mentioned as an example.
Well, as a first approximation, we could simply send a task to a specific queue and creating specific origin with type hal. But sure, I shall read the discussion again. | |
122 |
I'm trying to respect the specification.
This is the subtitle of the previous chapter. It needs to be completed. The only collection we have, 'software' being what we act upon. |