Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
DLCM-Backend
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
DLCM
Community
DLCM-Backend
Commits
f1e6425c
Commit
f1e6425c
authored
5 years ago
by
Hugues.Cazeaux
Committed by
Florent Poittevin
5 years ago
Browse files
Options
Downloads
Patches
Plain Diff
feat: add OpenApi JSON file in documentation
parent
b804e78b
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!267
Hca reorganize doc
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
DLCM-ResourceServerCommon/src/main/docs/DLCM-IntegrationGuide.adoc
+15
-5
15 additions, 5 deletions
...urceServerCommon/src/main/docs/DLCM-IntegrationGuide.adoc
with
15 additions
and
5 deletions
DLCM-ResourceServerCommon/src/main/docs/DLCM-IntegrationGuide.adoc
+
15
−
5
View file @
f1e6425c
...
@@ -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 Operations
see
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:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment