Skip to content
Snippets Groups Projects
Commit f1e6425c authored by Hugues.Cazeaux's avatar Hugues.Cazeaux Committed by Florent Poittevin
Browse files

feat: add OpenApi JSON file in documentation

parent b804e78b
No related branches found
No related tags found
1 merge request!267Hca reorganize doc
...@@ -36,26 +36,36 @@ endif::preingest,ingest,access[] ...@@ -36,26 +36,36 @@ endif::preingest,ingest,access[]
ifdef::preingest,ingest[] ifdef::preingest,ingest[]
[[ingest-integration-points]] [[ingest-integration-points]]
=== Ingest === For Submission
There are three ways to deposit data files into the DLCM system: There are three ways to deposit data files into the DLCM system:
. By submitting individual data files . By submitting individual data files
. By using a package containing one or several data files . By using a package containing one or several data files
. Based on a SIP (Submission Information Package) . Based on a SIP (Submission Information Package)
See the details in <<submission-integration>> section.
endif::preingest,ingest[] endif::preingest,ingest[]
ifdef::access[] ifdef::access[]
[[access-integration-points]] [[access-integration-points]]
=== Access === For Dissemination
Once the data files have been submitted and archived, the research community can access them: Once the data files have been submitted and archived, the research community can access them:
. Directly as an AIP (Archive Information Package) . By getting directly an archive with its ID
. By searching on archive metadata . By searching on archive metadata
. By exporting the AIP through a DIP (Distribution Information Package) . By exporting the AIP (Archival Information Package) through a DIP (Dissemination Information Package)
. By exporting metadata with OAI-PMH protocol
See the details in <<dissemination-integration>> section.
endif::access[] endif::access[]
=== For Developers
* All web services are detailed in link:DLCM-APIs.html[API Documentation].
* The API are available in https://openapi.tools/[OpenApi v3] format. The definition is available in link:openapi/dlcm-api.json[DLCM API JSON file].
[[rest-web-services]] [[rest-web-services]]
== REST Web Services == REST Web Services
...@@ -99,7 +109,7 @@ The naming convention, applied only for `<things>`, respects the https://en.wiki ...@@ -99,7 +109,7 @@ The naming convention, applied only for `<things>`, respects the https://en.wiki
TIP: There are some examples of root contexts in the https://sandbox.dlcm.ch[_demo_ environment] TIP: There are some examples of root contexts in the https://sandbox.dlcm.ch[_demo_ environment]
[[crud-operations]] [[crud-operations]]
==== CRUD Operations ==== CRUD Operationssee
By default, for each REST resource, the CRUD actions are available like this: By default, for each REST resource, the CRUD actions are available like this:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment