lockss-pyclient 0.1.0.dev2__py3-none-any.whl → 0.1.0.dev3__py3-none-any.whl

lockss/pyclient/rs/swagger.yaml

@@ -0,0 +1,1306 @@
+# Copyright (c) 2000-2026, Board of Trustees of Leland Stanford Jr. University
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the copyright holder nor the names of its contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+openapi: 3.0.3
+info:
+  title: LOCKSS Repository Service REST API
+  description: REST API of the LOCKSS Repository Service
+  version: 2.0.0
+  contact:
+    name: LOCKSS Support
+    url: https://www.lockss.org/
+    email: lockss-support@lockss.org
+  license:
+    name: BSD-3-Clause
+    url: https://opensource.org/licenses/BSD-3-Clause
+servers:
+  - url: "{proto}://{hostname}:{port}/"
+    description: LOCKSS Respository Service
+    variables:
+      proto:
+        description: "The protocol (default: http)."
+        enum:
+          - http
+          - https
+        default: http
+      hostname:
+        description: The service host name (or IP address).
+        default: localhost
+      port:
+        description: "The service port (default: 24611)."
+        default: 24611
+security:
+- basicAuth: []
+tags:
+  - name: artifacts
+    description: Artifact operations
+  - name: aus
+    description: Archival unit (AU) operations
+  - name: repo
+    description: Repository operations
+  - name: status
+    description: Status operations
+  - name: wayback
+    description: Replay operations
+paths:
+  /namespaces:
+    get:
+      tags:
+        - repo
+      summary: Get namespaces of the committed artifacts in the repository
+      operationId: getNamespaces
+      # new roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      responses:
+        '200':
+          description: Status 200
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+  /archives:
+    post:
+      tags:
+        - artifacts
+      summary: Imports artifacts from an archive
+      operationId: addArtifacts
+      # new roles: ROLE_AU_ADMIN
+      parameters:
+        - name: namespace
+          in: query
+          description: Namespace of the artifacts
+          schema:
+            type: string
+            default: lockss
+        - name: storeDuplicate
+          in: query
+          description: 'If true, artifacts with duplicate content will be stored, otherwise suppressed'
+          schema:
+            type: boolean
+            default: false
+        - name: excludeStatusPattern
+          in: query
+          description: 'If supplied, WARC records whose HTTP response status code matches the regular expression will not be imported'
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          multipart/form-data:
+            schema:
+              required:
+                - archive
+                - auid
+              type: object
+              properties:
+                auid:
+                  description: Archival Unit ID (AUID) of new artifact
+                  type: string
+                archive:
+                  description: Archive data containing artifacts
+                  type: string
+                  format: binary
+      responses:
+        '200':
+          description: 'Status of artifacts imported from the archive, maybe partially. Return body is a sequence of JSON ImportStatus objects.'
+          content:
+            application/json:
+              schema:
+                type: string
+                format: binary
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+  /artifacts:
+    get:
+      tags:
+        - artifacts
+      summary: Returns all artifacts that match a given a URL or URL prefix and/or version.
+      operationId: getArtifactsFromAllAus
+      # new roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: namespace
+          in: query
+          description: Namespace of the artifacts
+          schema:
+            type: string
+            default: lockss
+        - name: url
+          in: query
+          description: The URL contained by the artifacts
+          schema:
+            type: string
+        - name: urlPrefix
+          in: query
+          description: The prefix to be matched by the artifact URLs
+          schema:
+            type: string
+        - name: versions
+          in: query
+          description: Versions of the artifacts to return
+          schema:
+            $ref: '#/components/schemas/versionsEnum'
+        - name: limit
+          in: query
+          description: The requested maximum number of artifacts per response
+          schema:
+            type: integer
+        - name: continuationToken
+          in: query
+          description: The continuation token of the next page of artifacts to be returned
+          schema:
+            type: string
+      responses:
+        '200':
+          description: The requested artifacts
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/artifactPageInfo'
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+    post:
+      tags:
+        - artifacts
+      summary: Create an artifact
+      operationId: createArtifact
+      # new roles: ROLE_AU_ADMIN
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              required:
+                - artifactProps
+                - payload
+              type: object
+              properties:
+                artifactProps:
+                  description: Artifact properties (JSON)
+                  type: string
+                payload:
+                  description: Artifact payload data
+                  type: string
+                  format: binary
+                httpResponseHeader:
+                  type: string
+                  description: HTTP response status and headers (optional)
+      responses:
+        '201':
+          description: Artifact created
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/artifact'
+        '302':
+          description: Duplicate content; artifact not created
+          headers:
+            Location:
+              description: Repository query URL to duplicate artifacts
+              schema:
+                type: string
+          content: { }
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+  '/artifacts/{uuid}':
+    get:
+      tags:
+        - artifacts
+      summary: Get artifact and metadata
+      operationId: getArtifactDataByMultipart
+      # new roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: namespace
+          in: query
+          description: Namespace of the artifacts
+          schema:
+            type: string
+            default: lockss
+        - name: uuid
+          in: path
+          description: Identifier of the artifact
+          required: true
+          schema:
+            type: string
+        - name: includeContent
+          in: query
+          description: Controls whether to include the artifact content part in the multipart response
+          schema:
+            $ref: '#/components/schemas/includeContentEnum'
+      responses:
+        '200':
+          description: "Multipart/form-data containing the following parts:
+           The artifact properties, HTTP status and headers if present, and the artifact's payload if requested.
+           See POST /artifacts for more information."
+          content:
+            multipart/form-data:
+              schema:
+                type: string
+                format: binary
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+    put:
+      tags:
+        - artifacts
+      summary: Update the property of an artifact
+      operationId: updateArtifact
+      # new roles: ROLE_AU_ADMIN
+      parameters:
+        - name: namespace
+          in: query
+          description: Namespace of the artifacts
+          schema:
+            type: string
+            default: lockss
+        - name: committed
+          in: query
+          description: Committed status of the artifact
+          required: true
+          schema:
+            type: boolean
+        - name: uuid
+          in: path
+          description: Identifier of the artifact
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Artifact updated
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/artifact'
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+    delete:
+      tags:
+        - artifacts
+      summary: Remove an artifact from the repository
+      operationId: deleteArtifact
+      # new roles: ROLE_AU_ADMIN
+      parameters:
+        - name: namespace
+          in: query
+          description: Namespace of the artifacts
+          schema:
+            type: string
+            default: lockss
+        - name: uuid
+          in: path
+          description: Identifier of the artifact
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Successfully removed artifact
+          content: { }
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+  /artifacts/{uuid}/payload:
+    get:
+      tags:
+        - artifacts
+      summary: Get artifact payload
+      operationId: getArtifactDataByPayload
+      # new roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: namespace
+          in: query
+          description: Namespace of the artifacts
+          schema:
+            type: string
+            default: lockss
+        - name: uuid
+          in: path
+          description: Identifier of the artifact
+          required: true
+          schema:
+            type: string
+        - name: includeContent
+          in: query
+          description: Controls whether to include the artifact content part in the multipart response
+          schema:
+            $ref: '#/components/schemas/includeContentEnum'
+      responses:
+        '200':
+          description: Artifact's payload
+          content:
+            application/octet-stream:
+              schema:
+                type: string
+                format: binary
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+  /artifacts/{uuid}/response:
+    get:
+      tags:
+        - artifacts
+      summary: Get artifact data as HTTP response
+      operationId: getArtifactDataByResponse
+      # new roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: namespace
+          in: query
+          description: Namespace of the artifacts
+          schema:
+            type: string
+            default: lockss
+        - name: uuid
+          in: path
+          description: Identifier of the artifact
+          required: true
+          schema:
+            type: string
+        - name: includeContent
+          in: query
+          description: Controls whether to include the artifact content part in the multipart response
+          schema:
+            $ref: '#/components/schemas/includeContentEnum'
+      responses:
+        '200':
+          description: Artifact's payload
+          content:
+            application/http;msgtype=response:
+              schema:
+                type: string
+                format: binary
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+  /aus:
+    get:
+      tags:
+        - aus
+      summary: Get Archival Unit IDs (AUIDs) in a namespace
+      description: Get a list of all Archival Unit identifiers in a namespace or a
+        pageful of the list defined by the continuation token and size
+      operationId: getAus
+      # new roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: namespace
+          in: query
+          description: Namespace of the artifacts
+          schema:
+            type: string
+            default: lockss
+        - name: limit
+          in: query
+          description: The requested maximum number of Archival Unit identifiers per
+            response
+          schema:
+            type: integer
+        - name: continuationToken
+          in: query
+          description: The continuation token of the next page of Archival Unit identifiers
+            to be returned
+          schema:
+            type: string
+      responses:
+        '200':
+          description: The requested Archival Unit identifiers
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/auidPageInfo'
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+  /aus/{auid}/bulk:
+    post:
+      tags:
+        - aus
+      summary: Marks the AUID for bulk artifact transfer
+      operationId: handleBulkAuOp
+      # new roles: ROLE_AU_ADMIN
+      parameters:
+        - name: namespace
+          in: query
+          description: Namespace of the artifacts
+          schema:
+            type: string
+            default: lockss
+        - name: auid
+          in: path
+          description: Archival Unit ID
+          required: true
+          schema:
+            type: string
+        - name: op
+          in: query
+          description: Bulk AU operation
+          required: true
+          schema:
+            $ref: '#/components/schemas/bulkAuOpEnum'
+      responses:
+        '200':
+          description: Bulk operation succeeded
+          content: { }
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+  /aus/{auid}/artifacts:
+    get:
+      tags:
+        - artifacts
+      summary: Get artifacts in an Archival Unit
+      description: Get a list of all artifacts in a namespace and Archival Unit or
+        a pageful of the list defined by the continuation token and size
+      operationId: getArtifacts
+      # new roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: namespace
+          in: query
+          description: Namespace of the artifacts
+          schema:
+            type: string
+            default: lockss
+        - name: auid
+          in: path
+          description: Identifier of the Archival Unit containing the artifacts
+          required: true
+          schema:
+            type: string
+        - name: url
+          in: query
+          description: The URL contained by the artifacts
+          schema:
+            type: string
+        - name: urlPrefix
+          in: query
+          description: The prefix to be matched by the artifact URLs
+          schema:
+            type: string
+        - name: version
+          in: query
+          description: The version of the artifact
+          schema:
+            type: string
+        - name: includeUncommitted
+          in: query
+          description: Indication of whether uncommitted artifacts should be returned
+          schema:
+            type: boolean
+        - name: limit
+          in: query
+          description: The requested maximum number of artifacts per response
+          schema:
+            type: integer
+        - name: continuationToken
+          in: query
+          description: The continuation token of the next page of artifacts to be returned
+          schema:
+            type: string
+      responses:
+        '200':
+          description: The requested artifacts
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/artifactPageInfo'
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+  /aus/{auid}/size:
+    get:
+      tags:
+        - aus
+      summary: Get the size of Archival Unit artifacts in a namespace
+      operationId: getArtifactsSize
+      # new roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: namespace
+          in: query
+          description: Namespace of the artifacts
+          schema:
+            type: string
+            default: lockss
+        - name: auid
+          in: path
+          description: Identifier of the Archival Unit containing the artifacts
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Returns an AuSize containing the sizes of all the artifacts,
+            only the latest artifact version of all URLs, and the sum of the size
+            of all the underlying WARC files, of an AU.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/auSize'
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+  /status:
+    get:
+      tags:
+        - status
+      summary: Get the status of the service
+      description: Get the status of the service
+      operationId: getStatus
+      # no credentials required
+      responses:
+        '200':
+          description: The status of the service
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/apiStatus'
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+  /wayback/cdx/owb/{namespace}:
+    get:
+      tags:
+        - wayback
+      summary: Get OpenWayback CDX records
+      description: Get the OpenWayback CDX records of a URL in a namespace
+      operationId: getCdxOwb
+      # new roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: namespace
+          in: path
+          description: Namespace of the artifacts
+          required: true
+          schema:
+            type: string
+            default: lockss
+        - name: q
+          in: query
+          description: 'Query string. Supported fields are url, type (urlqueryprefixquery), offset and limit.'
+          schema:
+            type: string
+        - name: count
+          in: query
+          description: "."
+          schema:
+            type: integer
+        - name: start_page
+          in: query
+          description: "."
+          schema:
+            type: integer
+        - name: Accept
+          in: header
+          description: The Accept header
+          schema:
+            type: string
+        - name: Accept-Encoding
+          in: header
+          description: The Accept-Encoding header
+          schema:
+            type: string
+      responses:
+        '200':
+          description: The OpenWayback CDX records of the URL in the namespace
+          content:
+            application/xml:
+              schema:
+                type: string
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+  /wayback/cdx/pywb/{namespace}:
+    get:
+      tags:
+        - wayback
+      summary: Get PyWayback CDX records
+      description: Get the PyWayback CDX records of a URL in a namespace
+      operationId: getCdxPywb
+      # new roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: namespace
+          in: path
+          description: Namespace of the artifacts
+          required: true
+          schema:
+            type: string
+            default: lockss
+        - name: url
+          in: query
+          description: The URL for which the CDX records are requested
+          schema:
+            type: string
+        - name: limit
+          in: query
+          description: "."
+          schema:
+            type: integer
+        - name: matchType
+          in: query
+          description: Match type
+          schema:
+            $ref: '#/components/schemas/pywbMatchEnum'
+        - name: sort
+          in: query
+          description: Sorting behavior
+          schema:
+            $ref: '#/components/schemas/pywbSortEnum'
+        - name: closest
+          in: query
+          description: Timestamp for sort=closest mode
+          schema:
+            type: string
+        - name: output
+          in: query
+          description: Output format
+          schema:
+            $ref: '#/components/schemas/pywbOutputEnum'
+        - name: fl
+          in: query
+          description: Comma-separated list of fields to include in output
+          schema:
+            type: string
+        - name: Accept
+          in: header
+          description: The Accept header
+          schema:
+            type: string
+        - name: Accept-Encoding
+          in: header
+          description: The Accept-Encoding header
+          schema:
+            type: string
+      responses:
+        '200':
+          description: The PyWayback CDX records of the URL in the namespace
+          content:
+            text/plain:
+              schema:
+                type: string
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+  /wayback/warcs/{fileName}:
+    get:
+      tags:
+        - wayback
+      summary: Get a WARC archive
+      description: Get the contents of a single WARC record as a WARC archive
+      operationId: getWarcArchive
+      # new roles: ROLE_CONTENT_ACCESS, ROLE_AU_ADMIN
+      parameters:
+        - name: fileName
+          in: path
+          description: Name of the WARC archive
+          required: true
+          schema:
+            type: string
+        - name: Accept
+          in: header
+          description: The Accept header
+          schema:
+            type: string
+        - name: Accept-Encoding
+          in: header
+          description: The Accept-Encoding header
+          schema:
+            type: string
+        - name: Range
+          in: header
+          description: The Range header
+          schema:
+            type: string
+      responses:
+        '200':
+          description: The contents of the requested WARC archive
+          content:
+            application/warc:
+              schema:
+                type: string
+                format: binary
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+  /checksumalgorithms:
+    get:
+      tags:
+        - repo
+      summary: Get the supported checksum algorithms
+      description: Get a list of the names of the supported checksum algorithms
+      operationId: getSupportedChecksumAlgorithms
+      # new roles: ROLE_CAUTIOUS
+      responses:
+        '200':
+          description: The names of the supported checksum algorithms
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+  /repoinfo:
+    get:
+      tags:
+        - repo
+      summary: Get repository information
+      description: Get properties of the repository
+      operationId: getRepositoryInformation
+      # new roles: ROLE_AU_ADMIN
+      responses:
+        '200':
+          description: The repository information
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/repositoryInfo'
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+  /repoinfo/storage:
+    get:
+      tags:
+        - repo
+      summary: Get repository storage information
+      description: Get properties of the repository storage
+      operationId: getStorageInfo
+      # new roles: ROLE_AU_ADMIN
+      responses:
+        '200':
+          description: The repository storage information
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/storageInfo'
+        default:
+          description: The resulting error payload.
+          content:
+            application/json:
+              schema:
+                type: object
+components:
+  schemas:
+    apiStatus:
+      title: Repository API Status
+      description: The status information of the service
+      required:
+        - apiVersion
+        - ready
+      type: object
+      properties:
+        apiVersion:
+          title: API Version
+          description: The version of the API
+          type: string
+        componentName:
+          title: Component Name
+          description: The name of the component
+          type: string
+        componentVersion:
+          title: Component Version
+          description: The version of the component software
+          type: string
+        lockssVersion:
+          title: LOCKSS Version
+          description: The version of the LOCKSS system
+          type: string
+        ready:
+          title: Ready
+          description: The indication of whether the service is available
+          type: boolean
+        serviceName:
+          title: Service Name
+          description: The name of the service
+          type: string
+        readyTime:
+          title: Ready Time
+          description: The time the service last became ready.
+          type: integer
+          format: int64
+        reason:
+          title: Reason
+          description: The reason the service isn't ready.
+          type: string
+        startupStatus:
+          title: Startup Status
+          description: Enum indicating progress of plugin/AU processing at startup.
+          type: string
+          enum:
+            - NONE
+            - PLUGINS_CRAWLING
+            - PLUGINS_COLLECTED
+            - PLUGINS_LOADING
+            - PLUGINS_LOADED
+            - AUS_STARTING
+            - AUS_STARTED
+    artifact:
+      type: object
+      required:
+        - uuid
+        - namespace
+        - auid
+        - uri
+        - version
+        - committed
+        - storageUrl
+        - contentLength
+        - contentDigest
+        - collectionDate
+      properties:
+        uuid:
+          title: UUID
+          description: The artifact's UUID
+          type: string
+          nullable: false
+        namespace:
+          title: Namespace
+          description: The artifact's namespace
+          type: string
+          nullable: false
+          default: lockss
+        auid:
+          title: AUID
+          description: The artifact's AUID
+          type: string
+          nullable: false
+        uri:
+          title: URI
+          description: The artifact's URI
+          type: string
+          nullable: false
+        version:
+          title: Version
+          description: The artifact's version number
+          type: integer
+          nullable: false
+        committed:
+          title: Committed
+          description: The artifact's committed flag
+          type: boolean
+          nullable: false
+        storageUrl:
+          title: Storage URL
+          description: The artifact's storage URL
+          type: string
+          nullable: false
+        contentLength:
+          title: Content Length
+          description: The length of the artifact's content
+          type: integer
+          format: int64
+          nullable: false
+        contentDigest:
+          title: Content Digest
+          description: The digest of the artifact's content
+          type: string
+          nullable: false
+        collectionDate:
+          title: Collection Date
+          description: The artifact's collection date
+          type: integer
+          format: int64
+          nullable: false
+    artifactPageInfo:
+      required:
+        - artifacts
+        - pageInfo
+      type: object
+      properties:
+        artifacts:
+          title: Artifacts
+          description: The artifacts included in the page
+          type: array
+          items:
+            $ref: '#/components/schemas/artifact'
+          nullable: false
+        pageInfo:
+          title: Page Information
+          description: Information about the page
+          $ref: '#/components/schemas/pageInfo'
+          nullable: false
+    artifactProperties:
+      type: object
+      properties:
+        namespace:
+          type: string
+          default: lockss
+        uuid:
+          type: string
+        auid:
+          type: string
+        uri:
+          type: string
+        version:
+          type: integer
+        contentLength:
+          type: integer
+          format: int64
+        contentDigest:
+          type: string
+        collectionDate:
+          type: integer
+          format: int64
+        storeDate:
+          type: integer
+          format: int64
+        state:
+          type: string
+    auSize:
+      type: object
+      required:
+        - totalLatestVersions
+        - totalAllVersions
+        - totalWarcSize
+      properties:
+        totalLatestVersions:
+          title: Latest Versions
+          description: Total content size of all latest versions
+          type: integer
+          format: int64
+          nullable: true
+        totalAllVersions:
+          title: All Versions
+          description: Total content size of all versions
+          type: integer
+          format: int64
+          nullable: true
+        totalWarcSize:
+          title: WARC Size
+          description: Total WARC file size
+          type: integer
+          format: int64
+          nullable: true
+    auidPageInfo:
+      type: object
+      required:
+        - auids
+        - pageInfo
+      properties:
+        auids:
+          title: AUIDs
+          description: The AUIDs included in the page
+          type: array
+          items:
+            type: string
+          nullable: false
+        pageInfo:
+          title: Page Information
+          description: Information about the page
+          $ref: '#/components/schemas/pageInfo'
+          nullable: false
+    bulkAuOpEnum:
+      title: Bulk AU Operation
+      description: Versions of the artifacts to return
+      type: string
+      enum:
+        - start
+        - finish
+    errorResult:
+      type: object
+      required:
+        - message
+        - code
+      properties:
+        message:
+          type: string
+        code:
+          type: integer
+        rootCause:
+          type: string
+    importStatus:
+      type: object
+      properties:
+        warcId:
+          type: string
+        offset:
+          type: integer
+          format: int64
+        url:
+          type: string
+        artifactUuid:
+          type: string
+        digest:
+          type: string
+        version:
+          type: integer
+        status:
+          type: string
+          enum:
+            - OK
+            - ERROR
+            - DUPLICATE
+            - EXCLUDED
+        statusMessage:
+          type: string
+    includeContentEnum:
+      title: Include Content
+      description: Whether to include the artifact content part in a multipart response
+      type: string
+      default: ALWAYS
+      enum:
+        - NEVER
+        - IF_SMALL
+        - ALWAYS
+    pageInfo:
+      title: Page Information
+      description: The information related to pagination of content
+      type: object
+      required:
+        - totalCount
+        - itemsInPage
+        - continuationToken
+        - curLink
+        - nextLink
+      properties:
+        totalCount:
+          title: Total Count 
+          description: The total number of items
+          type: integer
+          format: int32
+          nullable: true
+        itemsInPage:
+          title: Items in Page
+          description: The number of items in the page
+          type: integer
+          format: int32
+          nullable: false
+        continuationToken:
+          title: Continuation Token
+          description: The continuation token
+          type: string
+          nullable: true
+        curLink:
+          title: Current Request
+          description: The link of the current request
+          type: string
+          nullable: false
+        nextLink:
+          title: Next Request
+          description: The link of the next request
+          type: string
+          nullable: true
+    pywbMatchEnum:
+      title: Match Type
+      description: Match type in Pywb CDX queries
+      type: string
+      enum:
+        - exact
+        - prefix
+        - host
+        - domain
+        - range
+    pywbOutputEnum:
+      title: Output Format
+      description: Output format in Pywb CDX queries
+      type: string
+      default: cdx
+      enum:
+        - cdx
+        - json
+    pywbSortEnum:
+      title: Sort
+      description: Sorting behavior in Pywb CDX queries
+      type: string
+      enum:
+        - default
+        - closest
+        - reverse
+    streamingResponseBody:
+      type: object
+    repositoryInfo:
+      title: Repository Information
+      description: Information about the repository
+      type: object
+      required:
+        - storeInfo
+        - indexInfo
+      properties:
+        storeInfo:
+          title: Storage Area Information
+          description: Information about the repository's storage areas
+          $ref: '#/components/schemas/storageInfo'
+          nullable: false
+        indexInfo:
+          title: Artifact Index Information
+          description: Information about the repository's artifact index
+          $ref: '#/components/schemas/storageInfo'
+          nullable: false
+        repositoryStatistics:
+          title: Repository Statistics
+          description: Miscellaneous statistics about the repository
+          $ref: '#/components/schemas/repositoryStatistics'
+          nullable: true
+    repositoryStatistics:
+      description: "Various statistics about the repository's internal operation."
+      type: object
+      properties:
+        timeSpentReiteratingIterators:
+          description: "Time spent reiterating a new artifact iterator during continuation."
+          type: integer
+          format: int64
+          nullable: true
+    storageInfo:
+      required:
+        - type
+        - name
+        - path
+        - components
+        - sizeKB
+        - usedKB
+        - availKB
+        - percentUsed
+        - percentUsedString
+      description: Information about a repository storage area
+      type: object
+      properties:
+        type:
+          title: Type
+          description: Type of the storage area
+          type: string
+          nullable: false
+        name:
+          title: Name
+          description: Name of the storage area
+          type: string
+          nullable: false
+        path:
+          title: Path
+          description: Path, if applicable
+          type: string
+          nullable: true
+        components:
+          title: Components
+          description: Storage areas that comprise this one
+          type: array
+          items:
+            $ref: '#/components/schemas/storageInfo'
+          nullable: true
+        sizeKB:
+          title: Size (KB)
+          description: Size of the storage area (in KB)
+          type: integer
+          format: int64
+          nullable: true
+        usedKB:
+          title: Used (KB)
+          description: Size of the used storage area (in KB)
+          type: integer
+          format: int64
+          nullable: true
+        availKB:
+          title: Available (KB)
+          description: Size of the available storage area (in KB)
+          type: integer
+          format: int64
+          nullable: true
+        percentUsed:
+          title: Percentage Used
+          description: Percentage of the storage area used
+          type: number
+          format: double
+          nullable: true
+        percentUsedString:
+          title: Used (%)
+          description: Percentage of the storage area used, formatted as a string
+          type: string
+          nullable: true
+    versionsEnum:
+      title: Versions
+      description: Versions of the artifacts to return
+      type: string
+      default: latest
+      enum:
+        - all
+        - latest
+  securitySchemes:
+    basicAuth:
+      type: http
+      description: HTTP Basic Authentication. Works over HTTP and HTTPS.
+      scheme: basic