Deployed 67c2872 with MkDocs version: 1.3.0

DANS-KNAW · Dec 3, 2024 · 70c3bda · 70c3bda
commit 70c3bda
Show file tree

Hide file tree

Showing 65 changed files with 7,641 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/404.html b/404.html
@@ -0,0 +1,114 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+    <meta charset="utf-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+      <link rel="shortcut icon" href="/img/favicon.ico" />
+    <title>dd-validate-dans-bag</title>
+    <link rel="stylesheet" href="/css/theme.css" />
+    <link rel="stylesheet" href="/css/theme_extra.css" />
+        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
+
+    <script src="/js/jquery-3.6.0.min.js" defer></script>
+    <!--[if lt IE 9]>
+      <script src="/js/html5shiv.min.js"></script>
+    <![endif]-->
+      <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
+      <script>hljs.initHighlightingOnLoad();</script> 
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
+    <div class="wy-side-scroll">
+      <div class="wy-side-nav-search">
+          <a href="/." class="icon icon-home"> dd-validate-dans-bag
+        </a><div role="search">
+  <form id ="rtd-search-form" class="wy-form" action="//search.html" method="get">
+      <input type="text" name="q" placeholder="Search docs" title="Type search term here" />
+  </form>
+</div>
+      </div>
+
+      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="/.">Manual</a>
+                </li>
+              </ul>
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="/to-api/">API</a>
+                </li>
+              </ul>
+              <ul>
+                <li class="toctree-l1"><a class="reference internal" href="/arch/">⇒ DANS Data Station Architecture</a>
+                </li>
+              </ul>
+      </div>
+    </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+      <nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="/.">dd-validate-dans-bag</a>
+
+      </nav>
+      <div class="wy-nav-content">
+        <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
+  <ul class="wy-breadcrumbs">
+    <li><a href="/." class="icon icon-home" alt="Docs"></a> &raquo;</li>
+    <li class="wy-breadcrumbs-aside">
+    </li>
+  </ul>
+  <hr/>
+</div>
+
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+            <div class="section" itemprop="articleBody">
+
+
+  <h1 id="404-page-not-found">404</h1>
+
+  <p><strong>Page not found</strong></p>
+
+
+            </div>
+          </div><footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <!-- Copyright etc -->
+  </div>
+
+  Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+  <div class="rst-versions" role="note" aria-label="Versions">
+  <span class="rst-current-version" data-toggle="rst-current-version">
+
+
+
+  </span>
+</div>
+    <script>var base_url = '/';</script>
+    <script src="/js/theme_extra.js" defer></script>
+    <script src="/js/theme.js" defer></script>
+      <script src="/search/main.js" defer></script>
+    <script defer>
+        window.onload = function () {
+            SphinxRtdTheme.Navigation.enable(true);
+        };
+    </script>
+
+</body>
+</html>
diff --git a/api.yml b/api.yml
@@ -0,0 +1,180 @@
+#
+# Copyright (C) 2022 DANS - Data Archiving and Networked Services ([email protected])
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+openapi: 3.0.1
+
+servers:
+  - url: http://localhost:20330/
+
+info:
+  description: Service for validating DANS bags.
+  version: 1.0.0
+  title: dd-validate-dans-bag
+  contact:
+    email: [email protected]
+  license:
+    name: Apache 2.0
+    url: http://www.apache.org/licenses/LICENSE-2.0.html
+
+paths:
+  /:
+    get:
+      summary: Returns a description of the service.
+      responses:
+        200:
+          description: description of the service
+          content:
+            text/plain:
+              schema:
+                type: string
+                description: a plain text, human readable description of the service
+                example: |
+                  Validate DANS Bag Running (v1.0.0)
+
+  /validateZip:
+    post:
+      summary:
+        Validates the bag specified or sent in the message body against the
+        DANS BagIt Profile v1 rules.
+      requestBody:
+        content:
+          application/zip:
+            schema:
+              $ref: '#/components/schemas/ZipFile'
+      responses:
+        200:
+          $ref: "#/components/responses/Ok"
+        400:
+          $ref: "#/components/responses/BagNotFound"
+        500:
+          $ref: "#/components/responses/InternalServerError"
+
+  /validateLocalDir:
+    post:
+      summary:
+        Validates the bag specified or sent in the message body against the
+        DANS BagIt Profile v1 rules.
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ValidateCommand'
+      responses:
+        200:
+          $ref: "#/components/responses/Ok"
+        400:
+          $ref: "#/components/responses/BagNotFound"
+        500:
+          $ref: "#/components/responses/InternalServerError"
+
+
+
+components:
+  responses:
+    Ok:
+      description: Ok. The bag was successfully validated. Note that this may still mean the bag was
+        not VALID according to the DANS BagIt Profile.
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/ValidateOk"
+
+    InternalServerError:
+      description: Internal Server Error.
+
+    BagNotFound:
+      description: Bad request. The bag was not found in the location indicated in the request, or it
+        could not be read (if the service had insufficient permissions to read an
+        externally located bag).
+
+  schemas:
+    ZipFile:
+      description: the bag packaged as ZIP file. The ZIP file must contain exactly one directory (and not other files)
+        in its root and directory must be the bag to validate.
+      type: string
+      format: binary
+
+    ValidateCommand:
+      type: object
+      description: Information about where to find the bag (in the message body or externally) and
+        how to validate it (as DEPOSIT or migration). If bagLocation is not provided, the bag is
+        assumed to be included as a ZIP file in the second part of the message body.
+      example:
+        bagLocation: /path/to/bag/directory
+        packageType: DEPOSIT
+      properties:
+        bagLocation:
+          type: string
+        packageType:
+          type: string
+          enum:
+            - DEPOSIT
+            - MIGRATION
+          default: DEPOSIT
+
+    ValidateOk:
+      type: object
+      example:
+        bagLocation: /path/to/myBag
+        name: myBag
+        profileVersion: 1.0.1
+        infoPackageType: DEPOSIT
+        isCompliant: false
+        ruleViolations:
+          - rule: '1.2.2 (a)'
+            violation: 'bag-info.txt has no element Created'
+          - rule: '1.3.1'
+            violation: 'bag MUST have at least one other payload manifest next to optional MD5 manifest'
+      required:
+        - name
+        - profileVersion
+        - informationPackageType
+        - isCompliant
+        - ruleViolations
+      properties:
+        Bag location:
+          description: the local path to the bag; if not provided, the bag was sent as ZIP file in the
+            message body
+          type: string
+          format: path
+        Name:
+          description: the name of the top directory of the bag
+          type: string
+          format: url
+        Profile version:
+          description: the exact version of DANS BagIt Profile that was used to validate
+          type: string
+        Information package type:
+          description: how the bag was validated (as DEPOSIT or MIGRATION)
+          type: string
+          enum:
+            - DEPOSIT
+            - MIGRATION
+        Is compliant:
+          description: true if the bag was compliant, false otherwise
+          type: boolean
+        Rule violations:
+          description: list of violations, if isCompliant is true, an empty list
+          type: array
+          items:
+            type: object
+            properties:
+              rule:
+                description: the rule number
+                type: string
+              violation:
+                description: description of how the bag violated this rule
+                type: string